lib/fastly/api/logging_gcs_api.rb in fastly-4.0.0.alpha4 vs lib/fastly/api/logging_gcs_api.rb in fastly-4.0.0
- old
+ new
@@ -21,23 +21,25 @@
# Create GCS logging 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 [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 [String] :message_type How the message should be formatted. (default to 'classic')
# @option opts [String] :timestamp_format A timestamp format
# @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 What level of gzip encoding to have when sending logs (default `0`, no compression). If an explicit non-zero value is set, then `compression_codec` will default to \\\"gzip.\\\" 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 compression of your logs. Valid values are `zstd`, `snappy`, and `gzip`. If the specified codec is \\\"gzip\\\", `gzip_level` will default to 3. To specify a different level, leave `compression_codec` blank and explicitly set the level using `gzip_level`. Specifying both `compression_codec` and `gzip_level` in the same API request will result in an error.
- # @option opts [String] :user Your Google Cloud Platform service account email address. The `client_email` field in your service account authentication JSON. Required.
- # @option opts [String] :secret_key Your Google Cloud Platform account secret key. The `private_key` field in your service account authentication JSON. Required.
+ # @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] :user Your Google Cloud Platform service account email address. The `client_email` field in your service account authentication JSON. Not required if `account_name` is specified.
+ # @option opts [String] :secret_key Your Google Cloud Platform account secret key. The `private_key` field in your service account authentication JSON. Not required if `account_name` is specified.
+ # @option opts [String] :account_name The name of the Google Cloud Platform service account associated with the target log collection service. Not required if `user` and `secret_key` are provided.
# @option opts [String] :bucket_name The name of the GCS bucket.
# @option opts [String] :path The path to upload logs to.
# @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] :project_id Your Google Cloud Platform project ID. Required
# @return [LoggingGcsResponse]
def create_log_gcs(opts = {})
data, _status_code, _headers = create_log_gcs_with_http_info(opts)
data
end
@@ -46,23 +48,25 @@
# Create GCS logging 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 [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 [String] :message_type How the message should be formatted. (default to 'classic')
# @option opts [String] :timestamp_format A timestamp format
# @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 What level of gzip encoding to have when sending logs (default `0`, no compression). If an explicit non-zero value is set, then `compression_codec` will default to \\\"gzip.\\\" 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 compression of your logs. Valid values are `zstd`, `snappy`, and `gzip`. If the specified codec is \\\"gzip\\\", `gzip_level` will default to 3. To specify a different level, leave `compression_codec` blank and explicitly set the level using `gzip_level`. Specifying both `compression_codec` and `gzip_level` in the same API request will result in an error.
- # @option opts [String] :user Your Google Cloud Platform service account email address. The `client_email` field in your service account authentication JSON. Required.
- # @option opts [String] :secret_key Your Google Cloud Platform account secret key. The `private_key` field in your service account authentication JSON. Required.
+ # @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] :user Your Google Cloud Platform service account email address. The `client_email` field in your service account authentication JSON. Not required if `account_name` is specified.
+ # @option opts [String] :secret_key Your Google Cloud Platform account secret key. The `private_key` field in your service account authentication JSON. Not required if `account_name` is specified.
+ # @option opts [String] :account_name The name of the Google Cloud Platform service account associated with the target log collection service. Not required if `user` and `secret_key` are provided.
# @option opts [String] :bucket_name The name of the GCS bucket.
# @option opts [String] :path The path to upload logs to.
# @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] :project_id Your Google Cloud Platform project ID. Required
# @return [Array<(LoggingGcsResponse, Integer, Hash)>] LoggingGcsResponse data, response status code and response headers
def create_log_gcs_with_http_info(opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: LoggingGcsApi.create_log_gcs ...'
end
@@ -121,13 +125,15 @@
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['user'] = opts[:'user'] if !opts[:'user'].nil?
form_params['secret_key'] = opts[:'secret_key'] if !opts[:'secret_key'].nil?
+ form_params['account_name'] = opts[:'account_name'] if !opts[:'account_name'].nil?
form_params['bucket_name'] = opts[:'bucket_name'] if !opts[:'bucket_name'].nil?
form_params['path'] = opts[:'path'] if !opts[:'path'].nil?
form_params['public_key'] = opts[:'public_key'] if !opts[:'public_key'].nil?
+ form_params['project_id'] = opts[:'project_id'] if !opts[:'project_id'].nil?
# http body (model)
post_body = opts[:debug_body]
# return_type
@@ -382,23 +388,25 @@
# @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_gcs_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 [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 [String] :message_type How the message should be formatted. (default to 'classic')
# @option opts [String] :timestamp_format A timestamp format
# @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 What level of gzip encoding to have when sending logs (default `0`, no compression). If an explicit non-zero value is set, then `compression_codec` will default to \\\"gzip.\\\" 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 compression of your logs. Valid values are `zstd`, `snappy`, and `gzip`. If the specified codec is \\\"gzip\\\", `gzip_level` will default to 3. To specify a different level, leave `compression_codec` blank and explicitly set the level using `gzip_level`. Specifying both `compression_codec` and `gzip_level` in the same API request will result in an error.
- # @option opts [String] :user Your Google Cloud Platform service account email address. The `client_email` field in your service account authentication JSON. Required.
- # @option opts [String] :secret_key Your Google Cloud Platform account secret key. The `private_key` field in your service account authentication JSON. Required.
+ # @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] :user Your Google Cloud Platform service account email address. The `client_email` field in your service account authentication JSON. Not required if `account_name` is specified.
+ # @option opts [String] :secret_key Your Google Cloud Platform account secret key. The `private_key` field in your service account authentication JSON. Not required if `account_name` is specified.
+ # @option opts [String] :account_name The name of the Google Cloud Platform service account associated with the target log collection service. Not required if `user` and `secret_key` are provided.
# @option opts [String] :bucket_name The name of the GCS bucket.
# @option opts [String] :path The path to upload logs to.
# @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] :project_id Your Google Cloud Platform project ID. Required
# @return [LoggingGcsResponse]
def update_log_gcs(opts = {})
data, _status_code, _headers = update_log_gcs_with_http_info(opts)
data
end
@@ -408,23 +416,25 @@
# @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_gcs_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 [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 [String] :message_type How the message should be formatted. (default to 'classic')
# @option opts [String] :timestamp_format A timestamp format
# @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 What level of gzip encoding to have when sending logs (default `0`, no compression). If an explicit non-zero value is set, then `compression_codec` will default to \\\"gzip.\\\" 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 compression of your logs. Valid values are `zstd`, `snappy`, and `gzip`. If the specified codec is \\\"gzip\\\", `gzip_level` will default to 3. To specify a different level, leave `compression_codec` blank and explicitly set the level using `gzip_level`. Specifying both `compression_codec` and `gzip_level` in the same API request will result in an error.
- # @option opts [String] :user Your Google Cloud Platform service account email address. The `client_email` field in your service account authentication JSON. Required.
- # @option opts [String] :secret_key Your Google Cloud Platform account secret key. The `private_key` field in your service account authentication JSON. Required.
+ # @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] :user Your Google Cloud Platform service account email address. The `client_email` field in your service account authentication JSON. Not required if `account_name` is specified.
+ # @option opts [String] :secret_key Your Google Cloud Platform account secret key. The `private_key` field in your service account authentication JSON. Not required if `account_name` is specified.
+ # @option opts [String] :account_name The name of the Google Cloud Platform service account associated with the target log collection service. Not required if `user` and `secret_key` are provided.
# @option opts [String] :bucket_name The name of the GCS bucket.
# @option opts [String] :path The path to upload logs to.
# @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] :project_id Your Google Cloud Platform project ID. Required
# @return [Array<(LoggingGcsResponse, Integer, Hash)>] LoggingGcsResponse data, response status code and response headers
def update_log_gcs_with_http_info(opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: LoggingGcsApi.update_log_gcs ...'
end
@@ -488,12 +498,14 @@
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['user'] = opts[:'user'] if !opts[:'user'].nil?
form_params['secret_key'] = opts[:'secret_key'] if !opts[:'secret_key'].nil?
+ form_params['account_name'] = opts[:'account_name'] if !opts[:'account_name'].nil?
form_params['bucket_name'] = opts[:'bucket_name'] if !opts[:'bucket_name'].nil?
form_params['path'] = opts[:'path'] if !opts[:'path'].nil?
form_params['public_key'] = opts[:'public_key'] if !opts[:'public_key'].nil?
+ form_params['project_id'] = opts[:'project_id'] if !opts[:'project_id'].nil?
# http body (model)
post_body = opts[:debug_body]
# return_type