lib/fastly/api/logging_ftp_api.rb in fastly-6.0.2 vs lib/fastly/api/logging_ftp_api.rb in fastly-7.0.0
- old
+ new
@@ -21,26 +21,26 @@
# Create a FTP 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 [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] :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](https://docs.fastly.com/en/guides/custom-log-formats). (default to '%h %l %u %t \"%r\" %>s %b')
+ # @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] :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 [String] :address An hostname or IPv4 address.
# @option opts [String] :hostname Hostname used.
# @option opts [String] :ipv4 IPv4 address of the host.
# @option opts [String] :password The password for the server. For anonymous use an email address.
# @option opts [String] :path The path to upload log files to. If the path ends in `/` then it is treated as a directory.
- # @option opts [Integer] :port The port number. (default to 21)
# @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] :user The username for the server. Can be anonymous.
+ # @option opts [Integer] :port The port number. (default to 21)
# @return [LoggingFtpResponse]
def create_log_ftp(opts = {})
data, _status_code, _headers = create_log_ftp_with_http_info(opts)
data
end
@@ -49,26 +49,26 @@
# Create a FTP 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 [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] :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](https://docs.fastly.com/en/guides/custom-log-formats). (default to '%h %l %u %t \"%r\" %>s %b')
+ # @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] :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 [String] :address An hostname or IPv4 address.
# @option opts [String] :hostname Hostname used.
# @option opts [String] :ipv4 IPv4 address of the host.
# @option opts [String] :password The password for the server. For anonymous use an email address.
# @option opts [String] :path The path to upload log files to. If the path ends in `/` then it is treated as a directory.
- # @option opts [Integer] :port The port number. (default to 21)
# @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] :user The username for the server. Can be anonymous.
+ # @option opts [Integer] :port The port number. (default to 21)
# @return [Array<(LoggingFtpResponse, Integer, Hash)>] LoggingFtpResponse data, response status code and response headers
def create_log_ftp_with_http_info(opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: LoggingFtpApi.create_log_ftp ...'
end
@@ -117,26 +117,26 @@
# 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['format_version'] = opts[:'format_version'] if !opts[:'format_version'].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['compression_codec'] = opts[:'compression_codec'] if !opts[:'compression_codec'].nil?
form_params['address'] = opts[:'address'] if !opts[:'address'].nil?
form_params['hostname'] = opts[:'hostname'] if !opts[:'hostname'].nil?
form_params['ipv4'] = opts[:'ipv4'] if !opts[:'ipv4'].nil?
form_params['password'] = opts[:'password'] if !opts[:'password'].nil?
form_params['path'] = opts[:'path'] if !opts[:'path'].nil?
- form_params['port'] = opts[:'port'] if !opts[:'port'].nil?
form_params['public_key'] = opts[:'public_key'] if !opts[:'public_key'].nil?
form_params['user'] = opts[:'user'] if !opts[:'user'].nil?
+ form_params['port'] = opts[:'port'] if !opts[:'port'].nil?
# http body (model)
post_body = opts[:debug_body]
# return_type
@@ -391,26 +391,26 @@
# @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_ftp_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 [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] :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](https://docs.fastly.com/en/guides/custom-log-formats). (default to '%h %l %u %t \"%r\" %>s %b')
+ # @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] :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 [String] :address An hostname or IPv4 address.
# @option opts [String] :hostname Hostname used.
# @option opts [String] :ipv4 IPv4 address of the host.
# @option opts [String] :password The password for the server. For anonymous use an email address.
# @option opts [String] :path The path to upload log files to. If the path ends in `/` then it is treated as a directory.
- # @option opts [Integer] :port The port number. (default to 21)
# @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] :user The username for the server. Can be anonymous.
+ # @option opts [Integer] :port The port number. (default to 21)
# @return [LoggingFtpResponse]
def update_log_ftp(opts = {})
data, _status_code, _headers = update_log_ftp_with_http_info(opts)
data
end
@@ -420,26 +420,26 @@
# @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_ftp_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 [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] :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](https://docs.fastly.com/en/guides/custom-log-formats). (default to '%h %l %u %t \"%r\" %>s %b')
+ # @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] :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 [String] :address An hostname or IPv4 address.
# @option opts [String] :hostname Hostname used.
# @option opts [String] :ipv4 IPv4 address of the host.
# @option opts [String] :password The password for the server. For anonymous use an email address.
# @option opts [String] :path The path to upload log files to. If the path ends in `/` then it is treated as a directory.
- # @option opts [Integer] :port The port number. (default to 21)
# @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] :user The username for the server. Can be anonymous.
+ # @option opts [Integer] :port The port number. (default to 21)
# @return [Array<(LoggingFtpResponse, Integer, Hash)>] LoggingFtpResponse data, response status code and response headers
def update_log_ftp_with_http_info(opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: LoggingFtpApi.update_log_ftp ...'
end
@@ -493,25 +493,25 @@
# 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['format_version'] = opts[:'format_version'] if !opts[:'format_version'].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['compression_codec'] = opts[:'compression_codec'] if !opts[:'compression_codec'].nil?
form_params['address'] = opts[:'address'] if !opts[:'address'].nil?
form_params['hostname'] = opts[:'hostname'] if !opts[:'hostname'].nil?
form_params['ipv4'] = opts[:'ipv4'] if !opts[:'ipv4'].nil?
form_params['password'] = opts[:'password'] if !opts[:'password'].nil?
form_params['path'] = opts[:'path'] if !opts[:'path'].nil?
- form_params['port'] = opts[:'port'] if !opts[:'port'].nil?
form_params['public_key'] = opts[:'public_key'] if !opts[:'public_key'].nil?
form_params['user'] = opts[:'user'] if !opts[:'user'].nil?
+ form_params['port'] = opts[:'port'] if !opts[:'port'].nil?
# http body (model)
post_body = opts[:debug_body]
# return_type