Class: Fastly::LoggingSftpApi

Inherits:
Object
  • Object
show all
Defined in:
lib/fastly/api/logging_sftp_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LoggingSftpApi

Returns a new instance of LoggingSftpApi.



17
18
19
 
# File 'lib/fastly/api/logging_sftp_api.rb', line 17

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



15
16
17
 
# File 'lib/fastly/api/logging_sftp_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#create_log_sftp(opts = {}) ⇒ LoggingSftpResponse

Create an SFTP log endpoint Create a SFTP for a particular service and version.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :name (String) —

    The name for the real-time logging configuration.

  • :placement (String) —

    Where in the generated VCL the logging call should be placed. If not set, endpoints with `format_version` of 2 are placed in `vcl_log` and those with `format_version` of 1 are placed in `vcl_deliver`.

  • :response_condition (String) —

    The name of an existing condition in the configured endpoint, or leave blank to always execute.

  • :format (String) —

    A Fastly [log format string](docs.fastly.com/en/guides/custom-log-formats). (default to ‘%h %l %u %t "%r" %>s %b’)

  • :format_version (Integer) —

    The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. (default to FORMAT_VERSION::v2)

  • :message_type (String) —

    How the message should be formatted. (default to ‘classic’)

  • :timestamp_format (String) —

    A timestamp format

  • :compression_codec (String) —

    The codec used for compressing your logs. Valid values are `zstd`, `snappy`, and `gzip`. Specifying both `compression_codec` and `gzip_level` in the same API request will result in an error.

  • :period (Integer) —

    How frequently log files are finalized so they can be available for reading (in seconds). (default to 3600)

  • :gzip_level (Integer) —

    The level of gzip encoding when sending logs (default `0`, no compression). Specifying both `compression_codec` and `gzip_level` in the same API request will result in an error. (default to 0)

  • :address (String) —

    A hostname or IPv4 address.

  • :port (Integer) —

    The port number. (default to 22)

  • :password (String) —

    The password for the server. If both `password` and `secret_key` are passed, `secret_key` will be used in preference.

  • :path (String) —

    The path to upload logs to. (default to ‘null’)

  • :public_key (String) —

    A PGP public key that Fastly will use to encrypt your log files before writing them to disk. (default to ‘null’)

  • :secret_key (String) —

    The SSH private key for the server. If both `password` and `secret_key` are passed, `secret_key` will be used in preference. (default to ‘null’)

  • :ssh_known_hosts (String) —

    A list of host keys for all hosts we can connect to over SFTP.

  • :user (String) —

    The username for the server.

Returns:



43
44
45
46
 
# File 'lib/fastly/api/logging_sftp_api.rb', line 43

def create_log_sftp(opts = {})
  data, _status_code, _headers = create_log_sftp_with_http_info(opts)
  data
end

#create_log_sftp_with_http_info(opts = {}) ⇒ Array<(LoggingSftpResponse, Integer, Hash)>

Create an SFTP log endpoint Create a SFTP for a particular service and version.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :name (String) —

    The name for the real-time logging configuration.

  • :placement (String) —

    Where in the generated VCL the logging call should be placed. If not set, endpoints with &#x60;format_version&#x60; of 2 are placed in &#x60;vcl_log&#x60; and those with &#x60;format_version&#x60; of 1 are placed in &#x60;vcl_deliver&#x60;.

  • :response_condition (String) —

    The name of an existing condition in the configured endpoint, or leave blank to always execute.

  • :format (String) —

    A Fastly [log format string](docs.fastly.com/en/guides/custom-log-formats). (default to ‘%h %l %u %t "%r" %&gt;s %b’)

  • :format_version (Integer) —

    The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in &#x60;vcl_log&#x60; if &#x60;format_version&#x60; is set to &#x60;2&#x60; and in &#x60;vcl_deliver&#x60; if &#x60;format_version&#x60; is set to &#x60;1&#x60;. (default to FORMAT_VERSION::v2)

  • :message_type (String) —

    How the message should be formatted. (default to ‘classic’)

  • :timestamp_format (String) —

    A timestamp format

  • :compression_codec (String) —

    The codec used for compressing your logs. Valid values are &#x60;zstd&#x60;, &#x60;snappy&#x60;, and &#x60;gzip&#x60;. Specifying both &#x60;compression_codec&#x60; and &#x60;gzip_level&#x60; in the same API request will result in an error.

  • :period (Integer) —

    How frequently log files are finalized so they can be available for reading (in seconds). (default to 3600)

  • :gzip_level (Integer) —

    The level of gzip encoding when sending logs (default &#x60;0&#x60;, no compression). Specifying both &#x60;compression_codec&#x60; and &#x60;gzip_level&#x60; in the same API request will result in an error. (default to 0)

  • :address (String) —

    A hostname or IPv4 address.

  • :port (Integer) —

    The port number. (default to 22)

  • :password (String) —

    The password for the server. If both &#x60;password&#x60; and &#x60;secret_key&#x60; are passed, &#x60;secret_key&#x60; will be used in preference.

  • :path (String) —

    The path to upload logs to. (default to ‘null’)

  • :public_key (String) —

    A PGP public key that Fastly will use to encrypt your log files before writing them to disk. (default to ‘null’)

  • :secret_key (String) —

    The SSH private key for the server. If both &#x60;password&#x60; and &#x60;secret_key&#x60; are passed, &#x60;secret_key&#x60; will be used in preference. (default to ‘null’)

  • :ssh_known_hosts (String) —

    A list of host keys for all hosts we can connect to over SFTP.

  • :user (String) —

    The username for the server.

Returns:

  • (Array<(LoggingSftpResponse, Integer, Hash)>) —

    LoggingSftpResponse data, response status code and response headers



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/fastly/api/logging_sftp_api.rb', line 71

def create_log_sftp_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoggingSftpApi.create_log_sftp ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling LoggingSftpApi.create_log_sftp"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling LoggingSftpApi.create_log_sftp"
  end
  allowable_values = ["none", "waf_debug", "null"]
  if @api_client.config.client_side_validation && opts[:'placement'] && !allowable_values.include?(opts[:'placement'])
    fail ArgumentError, "invalid value for \"placement\", must be one of #{allowable_values}"
  end
  allowable_values = [1, 2]
  if @api_client.config.client_side_validation && opts[:'format_version'] && !allowable_values.include?(opts[:'format_version'])
    fail ArgumentError, "invalid value for \"format_version\", must be one of #{allowable_values}"
  end
  allowable_values = ["classic", "loggly", "logplex", "blank"]
  if @api_client.config.client_side_validation && opts[:'message_type'] && !allowable_values.include?(opts[:'message_type'])
    fail ArgumentError, "invalid value for \"message_type\", must be one of #{allowable_values}"
  end
  allowable_values = ["zstd", "snappy", "gzip"]
  if @api_client.config.client_side_validation && opts[:'compression_codec'] && !allowable_values.include?(opts[:'compression_codec'])
    fail ArgumentError, "invalid value for \"compression_codec\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/logging/sftp'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?
  form_params['placement'] = opts[:'placement'] if !opts[:'placement'].nil?
  form_params['response_condition'] = opts[:'response_condition'] if !opts[:'response_condition'].nil?
  form_params['format'] = opts[:'format'] if !opts[:'format'].nil?
  form_params['format_version'] = opts[:'format_version'] if !opts[:'format_version'].nil?
  form_params['message_type'] = opts[:'message_type'] if !opts[:'message_type'].nil?
  form_params['timestamp_format'] = opts[:'timestamp_format'] if !opts[:'timestamp_format'].nil?
  form_params['compression_codec'] = opts[:'compression_codec'] if !opts[:'compression_codec'].nil?
  form_params['period'] = opts[:'period'] if !opts[:'period'].nil?
  form_params['gzip_level'] = opts[:'gzip_level'] if !opts[:'gzip_level'].nil?
  form_params['address'] = opts[:'address'] if !opts[:'address'].nil?
  form_params['port'] = opts[:'port'] if !opts[:'port'].nil?
  form_params['password'] = opts[:'password'] if !opts[:'password'].nil?
  form_params['path'] = opts[:'path'] if !opts[:'path'].nil?
  form_params['public_key'] = opts[:'public_key'] if !opts[:'public_key'].nil?
  form_params['secret_key'] = opts[:'secret_key'] if !opts[:'secret_key'].nil?
  form_params['ssh_known_hosts'] = opts[:'ssh_known_hosts'] if !opts[:'ssh_known_hosts'].nil?
  form_params['user'] = opts[:'user'] if !opts[:'user'].nil?

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LoggingSftpResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"LoggingSftpApi.create_log_sftp",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LoggingSftpApi#create_log_sftp\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_log_sftp(opts = {}) ⇒ InlineResponse200

Delete an SFTP log endpoint Delete the SFTP for a particular service and version.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :logging_sftp_name (String) —

    The name for the real-time logging configuration. (required)

Returns:



171
172
173
174
 
# File 'lib/fastly/api/logging_sftp_api.rb', line 171

def delete_log_sftp(opts = {})
  data, _status_code, _headers = delete_log_sftp_with_http_info(opts)
  data
end

#delete_log_sftp_with_http_info(opts = {}) ⇒ Array<(InlineResponse200, Integer, Hash)>

Delete an SFTP log endpoint Delete the SFTP for a particular service and version.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :logging_sftp_name (String) —

    The name for the real-time logging configuration. (required)

Returns:

  • (Array<(InlineResponse200, Integer, Hash)>) —

    InlineResponse200 data, response status code and response headers



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/fastly/api/logging_sftp_api.rb', line 182

def delete_log_sftp_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoggingSftpApi.delete_log_sftp ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  logging_sftp_name = opts[:'logging_sftp_name']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling LoggingSftpApi.delete_log_sftp"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling LoggingSftpApi.delete_log_sftp"
  end
  # verify the required parameter 'logging_sftp_name' is set
  if @api_client.config.client_side_validation && logging_sftp_name.nil?
    fail ArgumentError, "Missing the required parameter 'logging_sftp_name' when calling LoggingSftpApi.delete_log_sftp"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/logging/sftp/{logging_sftp_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'logging_sftp_name' + '}', CGI.escape(logging_sftp_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'InlineResponse200'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"LoggingSftpApi.delete_log_sftp",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LoggingSftpApi#delete_log_sftp\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_log_sftp(opts = {}) ⇒ LoggingSftpResponse

Get an SFTP log endpoint Get the SFTP for a particular service and version.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :logging_sftp_name (String) —

    The name for the real-time logging configuration. (required)

Returns:



248
249
250
251
 
# File 'lib/fastly/api/logging_sftp_api.rb', line 248

def get_log_sftp(opts = {})
  data, _status_code, _headers = get_log_sftp_with_http_info(opts)
  data
end

#get_log_sftp_with_http_info(opts = {}) ⇒ Array<(LoggingSftpResponse, Integer, Hash)>

Get an SFTP log endpoint Get the SFTP for a particular service and version.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :logging_sftp_name (String) —

    The name for the real-time logging configuration. (required)

Returns:

  • (Array<(LoggingSftpResponse, Integer, Hash)>) —

    LoggingSftpResponse data, response status code and response headers



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/fastly/api/logging_sftp_api.rb', line 259

def get_log_sftp_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoggingSftpApi.get_log_sftp ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  logging_sftp_name = opts[:'logging_sftp_name']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling LoggingSftpApi.get_log_sftp"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling LoggingSftpApi.get_log_sftp"
  end
  # verify the required parameter 'logging_sftp_name' is set
  if @api_client.config.client_side_validation && logging_sftp_name.nil?
    fail ArgumentError, "Missing the required parameter 'logging_sftp_name' when calling LoggingSftpApi.get_log_sftp"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/logging/sftp/{logging_sftp_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'logging_sftp_name' + '}', CGI.escape(logging_sftp_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LoggingSftpResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"LoggingSftpApi.get_log_sftp",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LoggingSftpApi#get_log_sftp\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_log_sftp(opts = {}) ⇒ Array<LoggingSftpResponse>

List SFTP log endpoints List all of the SFTPs for a particular service and version.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

Returns:



324
325
326
327
 
# File 'lib/fastly/api/logging_sftp_api.rb', line 324

def list_log_sftp(opts = {})
  data, _status_code, _headers = list_log_sftp_with_http_info(opts)
  data
end

#list_log_sftp_with_http_info(opts = {}) ⇒ Array<(Array<LoggingSftpResponse>, Integer, Hash)>

List SFTP log endpoints List all of the SFTPs for a particular service and version.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

Returns:

  • (Array<(Array<LoggingSftpResponse>, Integer, Hash)>) —

    Array<LoggingSftpResponse> data, response status code and response headers



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/fastly/api/logging_sftp_api.rb', line 334

def list_log_sftp_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoggingSftpApi.list_log_sftp ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling LoggingSftpApi.list_log_sftp"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling LoggingSftpApi.list_log_sftp"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/logging/sftp'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<LoggingSftpResponse>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"LoggingSftpApi.list_log_sftp",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LoggingSftpApi#list_log_sftp\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_log_sftp(opts = {}) ⇒ LoggingSftpResponse

Update an SFTP log endpoint Update the SFTP for a particular service and version.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :logging_sftp_name (String) —

    The name for the real-time logging configuration. (required)

  • :name (String) —

    The name for the real-time logging configuration.

  • :placement (String) —

    Where in the generated VCL the logging call should be placed. If not set, endpoints with &#x60;format_version&#x60; of 2 are placed in &#x60;vcl_log&#x60; and those with &#x60;format_version&#x60; of 1 are placed in &#x60;vcl_deliver&#x60;.

  • :response_condition (String) —

    The name of an existing condition in the configured endpoint, or leave blank to always execute.

  • :format (String) —

    A Fastly [log format string](docs.fastly.com/en/guides/custom-log-formats). (default to ‘%h %l %u %t "%r" %&gt;s %b’)

  • :format_version (Integer) —

    The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in &#x60;vcl_log&#x60; if &#x60;format_version&#x60; is set to &#x60;2&#x60; and in &#x60;vcl_deliver&#x60; if &#x60;format_version&#x60; is set to &#x60;1&#x60;. (default to FORMAT_VERSION::v2)

  • :message_type (String) —

    How the message should be formatted. (default to ‘classic’)

  • :timestamp_format (String) —

    A timestamp format

  • :compression_codec (String) —

    The codec used for compressing your logs. Valid values are &#x60;zstd&#x60;, &#x60;snappy&#x60;, and &#x60;gzip&#x60;. Specifying both &#x60;compression_codec&#x60; and &#x60;gzip_level&#x60; in the same API request will result in an error.

  • :period (Integer) —

    How frequently log files are finalized so they can be available for reading (in seconds). (default to 3600)

  • :gzip_level (Integer) —

    The level of gzip encoding when sending logs (default &#x60;0&#x60;, no compression). Specifying both &#x60;compression_codec&#x60; and &#x60;gzip_level&#x60; in the same API request will result in an error. (default to 0)

  • :address (String) —

    A hostname or IPv4 address.

  • :port (Integer) —

    The port number. (default to 22)

  • :password (String) —

    The password for the server. If both &#x60;password&#x60; and &#x60;secret_key&#x60; are passed, &#x60;secret_key&#x60; will be used in preference.

  • :path (String) —

    The path to upload logs to. (default to ‘null’)

  • :public_key (String) —

    A PGP public key that Fastly will use to encrypt your log files before writing them to disk. (default to ‘null’)

  • :secret_key (String) —

    The SSH private key for the server. If both &#x60;password&#x60; and &#x60;secret_key&#x60; are passed, &#x60;secret_key&#x60; will be used in preference. (default to ‘null’)

  • :ssh_known_hosts (String) —

    A list of host keys for all hosts we can connect to over SFTP.

  • :user (String) —

    The username for the server.

Returns:



413
414
415
416
 
# File 'lib/fastly/api/logging_sftp_api.rb', line 413

def update_log_sftp(opts = {})
  data, _status_code, _headers = update_log_sftp_with_http_info(opts)
  data
end

#update_log_sftp_with_http_info(opts = {}) ⇒ Array<(LoggingSftpResponse, Integer, Hash)>

Update an SFTP log endpoint Update the SFTP for a particular service and version.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :logging_sftp_name (String) —

    The name for the real-time logging configuration. (required)

  • :name (String) —

    The name for the real-time logging configuration.

  • :placement (String) —

    Where in the generated VCL the logging call should be placed. If not set, endpoints with &#x60;format_version&#x60; of 2 are placed in &#x60;vcl_log&#x60; and those with &#x60;format_version&#x60; of 1 are placed in &#x60;vcl_deliver&#x60;.

  • :response_condition (String) —

    The name of an existing condition in the configured endpoint, or leave blank to always execute.

  • :format (String) —

    A Fastly [log format string](docs.fastly.com/en/guides/custom-log-formats). (default to ‘%h %l %u %t "%r" %&gt;s %b’)

  • :format_version (Integer) —

    The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in &#x60;vcl_log&#x60; if &#x60;format_version&#x60; is set to &#x60;2&#x60; and in &#x60;vcl_deliver&#x60; if &#x60;format_version&#x60; is set to &#x60;1&#x60;. (default to FORMAT_VERSION::v2)

  • :message_type (String) —

    How the message should be formatted. (default to ‘classic’)

  • :timestamp_format (String) —

    A timestamp format

  • :compression_codec (String) —

    The codec used for compressing your logs. Valid values are &#x60;zstd&#x60;, &#x60;snappy&#x60;, and &#x60;gzip&#x60;. Specifying both &#x60;compression_codec&#x60; and &#x60;gzip_level&#x60; in the same API request will result in an error.

  • :period (Integer) —

    How frequently log files are finalized so they can be available for reading (in seconds). (default to 3600)

  • :gzip_level (Integer) —

    The level of gzip encoding when sending logs (default &#x60;0&#x60;, no compression). Specifying both &#x60;compression_codec&#x60; and &#x60;gzip_level&#x60; in the same API request will result in an error. (default to 0)

  • :address (String) —

    A hostname or IPv4 address.

  • :port (Integer) —

    The port number. (default to 22)

  • :password (String) —

    The password for the server. If both &#x60;password&#x60; and &#x60;secret_key&#x60; are passed, &#x60;secret_key&#x60; will be used in preference.

  • :path (String) —

    The path to upload logs to. (default to ‘null’)

  • :public_key (String) —

    A PGP public key that Fastly will use to encrypt your log files before writing them to disk. (default to ‘null’)

  • :secret_key (String) —

    The SSH private key for the server. If both &#x60;password&#x60; and &#x60;secret_key&#x60; are passed, &#x60;secret_key&#x60; will be used in preference. (default to ‘null’)

  • :ssh_known_hosts (String) —

    A list of host keys for all hosts we can connect to over SFTP.

  • :user (String) —

    The username for the server.

Returns:

  • (Array<(LoggingSftpResponse, Integer, Hash)>) —

    LoggingSftpResponse data, response status code and response headers



442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
 
# File 'lib/fastly/api/logging_sftp_api.rb', line 442

def update_log_sftp_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoggingSftpApi.update_log_sftp ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  logging_sftp_name = opts[:'logging_sftp_name']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling LoggingSftpApi.update_log_sftp"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling LoggingSftpApi.update_log_sftp"
  end
  # verify the required parameter 'logging_sftp_name' is set
  if @api_client.config.client_side_validation && logging_sftp_name.nil?
    fail ArgumentError, "Missing the required parameter 'logging_sftp_name' when calling LoggingSftpApi.update_log_sftp"
  end
  allowable_values = ["none", "waf_debug", "null"]
  if @api_client.config.client_side_validation && opts[:'placement'] && !allowable_values.include?(opts[:'placement'])
    fail ArgumentError, "invalid value for \"placement\", must be one of #{allowable_values}"
  end
  allowable_values = [1, 2]
  if @api_client.config.client_side_validation && opts[:'format_version'] && !allowable_values.include?(opts[:'format_version'])
    fail ArgumentError, "invalid value for \"format_version\", must be one of #{allowable_values}"
  end
  allowable_values = ["classic", "loggly", "logplex", "blank"]
  if @api_client.config.client_side_validation && opts[:'message_type'] && !allowable_values.include?(opts[:'message_type'])
    fail ArgumentError, "invalid value for \"message_type\", must be one of #{allowable_values}"
  end
  allowable_values = ["zstd", "snappy", "gzip"]
  if @api_client.config.client_side_validation && opts[:'compression_codec'] && !allowable_values.include?(opts[:'compression_codec'])
    fail ArgumentError, "invalid value for \"compression_codec\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/logging/sftp/{logging_sftp_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'logging_sftp_name' + '}', CGI.escape(logging_sftp_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?
  form_params['placement'] = opts[:'placement'] if !opts[:'placement'].nil?
  form_params['response_condition'] = opts[:'response_condition'] if !opts[:'response_condition'].nil?
  form_params['format'] = opts[:'format'] if !opts[:'format'].nil?
  form_params['format_version'] = opts[:'format_version'] if !opts[:'format_version'].nil?
  form_params['message_type'] = opts[:'message_type'] if !opts[:'message_type'].nil?
  form_params['timestamp_format'] = opts[:'timestamp_format'] if !opts[:'timestamp_format'].nil?
  form_params['compression_codec'] = opts[:'compression_codec'] if !opts[:'compression_codec'].nil?
  form_params['period'] = opts[:'period'] if !opts[:'period'].nil?
  form_params['gzip_level'] = opts[:'gzip_level'] if !opts[:'gzip_level'].nil?
  form_params['address'] = opts[:'address'] if !opts[:'address'].nil?
  form_params['port'] = opts[:'port'] if !opts[:'port'].nil?
  form_params['password'] = opts[:'password'] if !opts[:'password'].nil?
  form_params['path'] = opts[:'path'] if !opts[:'path'].nil?
  form_params['public_key'] = opts[:'public_key'] if !opts[:'public_key'].nil?
  form_params['secret_key'] = opts[:'secret_key'] if !opts[:'secret_key'].nil?
  form_params['ssh_known_hosts'] = opts[:'ssh_known_hosts'] if !opts[:'ssh_known_hosts'].nil?
  form_params['user'] = opts[:'user'] if !opts[:'user'].nil?

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LoggingSftpResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"LoggingSftpApi.update_log_sftp",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LoggingSftpApi#update_log_sftp\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end