class Fastly::LoggingSftpApi
Attributes
Public Class Methods
Source
# File lib/fastly/api/logging_sftp_api.rb, line 17 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Source
# File lib/fastly/api/logging_sftp_api.rb, line 44 def create_log_sftp(opts = {}) data, _status_code, _headers = create_log_sftp_with_http_info(opts) data end
Create an SFTP log endpoint Create a SFTP for a particular service and version. @option opts [String] :service_id Alphanumeric string identifying the service. (required) @option opts [Integer] :version_id Integer identifying a service version. (required) @option opts [String] :name The name for the real-time logging configuration. @option opts [String] :placement 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`. @option opts [String] :response_condition The name of an existing condition in the configured endpoint, or leave blank to always execute. @option opts [String] :format A Fastly
[log format string](www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/). (default to ‘%h %l %u %t "%r" %>s %b’) @option opts [String] :log_processing_region The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global. (default to ‘none’) @option opts [Integer] :format_version 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) @option opts [String] :message_type How the message should be formatted. (default to ‘classic’) @option opts [String] :timestamp_format A timestamp format @option opts [String] :compression_codec 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. @option opts [Integer] :period How frequently log files are finalized so they can be available for reading (in seconds). (default to 3600) @option opts [Integer] :gzip_level 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) @option opts [String] :address A hostname or IPv4 address. @option opts [Integer] :port The port number. (default to 22) @option opts [String] :password The password for the server. If both `password` and `secret_key` are passed, `secret_key` will be used in preference. @option opts [String] :path The path to upload logs to. (default to ‘null’) @option opts [String] :public_key A PGP public key that Fastly
will use to encrypt your log files before writing them to disk. (default to ‘null’) @option opts [String] :secret_key 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’) @option opts [String] :ssh_known_hosts A list of host keys for all hosts we can connect to over SFTP. @option opts [String] :user The username for the server. @return [LoggingSftpResponse]
Source
# File lib/fastly/api/logging_sftp_api.rb, line 73 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", "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 = ["none", "eu", "us"] if @api_client.config.client_side_validation && opts[:'log_processing_region'] && !allowable_values.include?(opts[:'log_processing_region']) fail ArgumentError, "invalid value for \"log_processing_region\", 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['log_processing_region'] = opts[:'log_processing_region'] if !opts[:'log_processing_region'].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
Create an SFTP log endpoint Create a SFTP for a particular service and version. @option opts [String] :service_id Alphanumeric string identifying the service. (required) @option opts [Integer] :version_id Integer identifying a service version. (required) @option opts [String] :name The name for the real-time logging configuration. @option opts [String] :placement 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`. @option opts [String] :response_condition The name of an existing condition in the configured endpoint, or leave blank to always execute. @option opts [String] :format A Fastly
[log format string](www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/). (default to ‘%h %l %u %t "%r" %>s %b’) @option opts [String] :log_processing_region The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global. (default to ‘none’) @option opts [Integer] :format_version 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) @option opts [String] :message_type How the message should be formatted. (default to ‘classic’) @option opts [String] :timestamp_format A timestamp format @option opts [String] :compression_codec 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. @option opts [Integer] :period How frequently log files are finalized so they can be available for reading (in seconds). (default to 3600) @option opts [Integer] :gzip_level 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) @option opts [String] :address A hostname or IPv4 address. @option opts [Integer] :port The port number. (default to 22) @option opts [String] :password The password for the server. If both `password` and `secret_key` are passed, `secret_key` will be used in preference. @option opts [String] :path The path to upload logs to. (default to ‘null’) @option opts [String] :public_key A PGP public key that Fastly
will use to encrypt your log files before writing them to disk. (default to ‘null’) @option opts [String] :secret_key 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’) @option opts [String] :ssh_known_hosts A list of host keys for all hosts we can connect to over SFTP. @option opts [String] :user The username for the server. @return [Array<(LoggingSftpResponse
, Integer, Hash)>] LoggingSftpResponse
data, response status code and response headers
Source
# File lib/fastly/api/logging_sftp_api.rb, line 178 def delete_log_sftp(opts = {}) data, _status_code, _headers = delete_log_sftp_with_http_info(opts) data end
Delete an SFTP log endpoint Delete the SFTP for a particular service and version. @option opts [String] :service_id Alphanumeric string identifying the service. (required) @option opts [Integer] :version_id Integer identifying a service version. (required) @option opts [String] :logging_sftp_name The name for the real-time logging configuration. (required) @return [InlineResponse200]
Source
# File lib/fastly/api/logging_sftp_api.rb, line 189 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
Delete an SFTP log endpoint Delete the SFTP for a particular service and version. @option opts [String] :service_id Alphanumeric string identifying the service. (required) @option opts [Integer] :version_id Integer identifying a service version. (required) @option opts [String] :logging_sftp_name The name for the real-time logging configuration. (required) @return [Array<(InlineResponse200
, Integer, Hash)>] InlineResponse200
data, response status code and response headers
Source
# File lib/fastly/api/logging_sftp_api.rb, line 255 def get_log_sftp(opts = {}) data, _status_code, _headers = get_log_sftp_with_http_info(opts) data end
Get an SFTP log endpoint Get the SFTP for a particular service and version. @option opts [String] :service_id Alphanumeric string identifying the service. (required) @option opts [Integer] :version_id Integer identifying a service version. (required) @option opts [String] :logging_sftp_name The name for the real-time logging configuration. (required) @return [LoggingSftpResponse]
Source
# File lib/fastly/api/logging_sftp_api.rb, line 266 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
Get an SFTP log endpoint Get the SFTP for a particular service and version. @option opts [String] :service_id Alphanumeric string identifying the service. (required) @option opts [Integer] :version_id Integer identifying a service version. (required) @option opts [String] :logging_sftp_name The name for the real-time logging configuration. (required) @return [Array<(LoggingSftpResponse
, Integer, Hash)>] LoggingSftpResponse
data, response status code and response headers
Source
# File lib/fastly/api/logging_sftp_api.rb, line 331 def list_log_sftp(opts = {}) data, _status_code, _headers = list_log_sftp_with_http_info(opts) data end
List SFTP log endpoints List all of the SFTPs for a particular service and version. @option opts [String] :service_id Alphanumeric string identifying the service. (required) @option opts [Integer] :version_id Integer identifying a service version. (required) @return [Array<LoggingSftpResponse>]
Source
# File lib/fastly/api/logging_sftp_api.rb, line 341 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
List SFTP log endpoints List all of the SFTPs for a particular service and version. @option opts [String] :service_id Alphanumeric string identifying the service. (required) @option opts [Integer] :version_id Integer identifying a service version. (required) @return [Array<(Array<LoggingSftpResponse>, Integer, Hash)>] Array<LoggingSftpResponse> data, response status code and response headers
Source
# File lib/fastly/api/logging_sftp_api.rb, line 421 def update_log_sftp(opts = {}) data, _status_code, _headers = update_log_sftp_with_http_info(opts) data end
Update an SFTP log endpoint Update the SFTP for a particular service and version. @option opts [String] :service_id Alphanumeric string identifying the service. (required) @option opts [Integer] :version_id Integer identifying a service version. (required) @option opts [String] :logging_sftp_name The name for the real-time logging configuration. (required) @option opts [String] :name The name for the real-time logging configuration. @option opts [String] :placement 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`. @option opts [String] :response_condition The name of an existing condition in the configured endpoint, or leave blank to always execute. @option opts [String] :format A Fastly
[log format string](www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/). (default to ‘%h %l %u %t "%r" %>s %b’) @option opts [String] :log_processing_region The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global. (default to ‘none’) @option opts [Integer] :format_version 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) @option opts [String] :message_type How the message should be formatted. (default to ‘classic’) @option opts [String] :timestamp_format A timestamp format @option opts [String] :compression_codec 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. @option opts [Integer] :period How frequently log files are finalized so they can be available for reading (in seconds). (default to 3600) @option opts [Integer] :gzip_level 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) @option opts [String] :address A hostname or IPv4 address. @option opts [Integer] :port The port number. (default to 22) @option opts [String] :password The password for the server. If both `password` and `secret_key` are passed, `secret_key` will be used in preference. @option opts [String] :path The path to upload logs to. (default to ‘null’) @option opts [String] :public_key A PGP public key that Fastly
will use to encrypt your log files before writing them to disk. (default to ‘null’) @option opts [String] :secret_key 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’) @option opts [String] :ssh_known_hosts A list of host keys for all hosts we can connect to over SFTP. @option opts [String] :user The username for the server. @return [LoggingSftpResponse]
Source
# File lib/fastly/api/logging_sftp_api.rb, line 451 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", "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 = ["none", "eu", "us"] if @api_client.config.client_side_validation && opts[:'log_processing_region'] && !allowable_values.include?(opts[:'log_processing_region']) fail ArgumentError, "invalid value for \"log_processing_region\", 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['log_processing_region'] = opts[:'log_processing_region'] if !opts[:'log_processing_region'].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
Update an SFTP log endpoint Update the SFTP for a particular service and version. @option opts [String] :service_id Alphanumeric string identifying the service. (required) @option opts [Integer] :version_id Integer identifying a service version. (required) @option opts [String] :logging_sftp_name The name for the real-time logging configuration. (required) @option opts [String] :name The name for the real-time logging configuration. @option opts [String] :placement 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`. @option opts [String] :response_condition The name of an existing condition in the configured endpoint, or leave blank to always execute. @option opts [String] :format A Fastly
[log format string](www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/). (default to ‘%h %l %u %t "%r" %>s %b’) @option opts [String] :log_processing_region The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global. (default to ‘none’) @option opts [Integer] :format_version 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) @option opts [String] :message_type How the message should be formatted. (default to ‘classic’) @option opts [String] :timestamp_format A timestamp format @option opts [String] :compression_codec 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. @option opts [Integer] :period How frequently log files are finalized so they can be available for reading (in seconds). (default to 3600) @option opts [Integer] :gzip_level 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) @option opts [String] :address A hostname or IPv4 address. @option opts [Integer] :port The port number. (default to 22) @option opts [String] :password The password for the server. If both `password` and `secret_key` are passed, `secret_key` will be used in preference. @option opts [String] :path The path to upload logs to. (default to ‘null’) @option opts [String] :public_key A PGP public key that Fastly
will use to encrypt your log files before writing them to disk. (default to ‘null’) @option opts [String] :secret_key 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’) @option opts [String] :ssh_known_hosts A list of host keys for all hosts we can connect to over SFTP. @option opts [String] :user The username for the server. @return [Array<(LoggingSftpResponse
, Integer, Hash)>] LoggingSftpResponse
data, response status code and response headers