lib/fastly/api/logging_honeycomb_api.rb in fastly-6.0.2 vs lib/fastly/api/logging_honeycomb_api.rb in fastly-7.0.0

- old
+ new

@@ -21,16 +21,16 @@ # Create a Honeycomb logging object 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 &#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;. - # @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 &#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) # @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). Must produce valid JSON that Honeycomb can ingest. + # @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 &#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) # @option opts [String] :dataset The Honeycomb Dataset you want to log to. # @option opts [String] :token The Write Key from the Account page of your Honeycomb account. - # @return [LoggingHoneycomb] + # @return [LoggingHoneycombResponse] def create_log_honeycomb(opts = {}) data, _status_code, _headers = create_log_honeycomb_with_http_info(opts) data end @@ -38,16 +38,16 @@ # Create a Honeycomb logging object 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 &#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;. - # @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 &#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) # @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). Must produce valid JSON that Honeycomb can ingest. + # @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 &#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) # @option opts [String] :dataset The Honeycomb Dataset you want to log to. # @option opts [String] :token The Write Key from the Account page of your Honeycomb account. - # @return [Array<(LoggingHoneycomb, Integer, Hash)>] LoggingHoneycomb data, response status code and response headers + # @return [Array<(LoggingHoneycombResponse, Integer, Hash)>] LoggingHoneycombResponse data, response status code and response headers def create_log_honeycomb_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: LoggingHoneycombApi.create_log_honeycomb ...' end # unbox the parameters from the hash @@ -87,21 +87,21 @@ # 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['dataset'] = opts[:'dataset'] if !opts[:'dataset'].nil? form_params['token'] = opts[:'token'] if !opts[:'token'].nil? # http body (model) post_body = opts[:debug_body] # return_type - return_type = opts[:debug_return_type] || 'LoggingHoneycomb' + return_type = opts[:debug_return_type] || 'LoggingHoneycombResponse' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( @@ -201,22 +201,22 @@ # Get a Honeycomb log endpoint # Get the details of a Honeycomb logging object 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_honeycomb_name The name for the real-time logging configuration. (required) - # @return [LoggingHoneycomb] + # @return [LoggingHoneycombResponse] def get_log_honeycomb(opts = {}) data, _status_code, _headers = get_log_honeycomb_with_http_info(opts) data end # Get a Honeycomb log endpoint # Get the details of a Honeycomb logging object 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_honeycomb_name The name for the real-time logging configuration. (required) - # @return [Array<(LoggingHoneycomb, Integer, Hash)>] LoggingHoneycomb data, response status code and response headers + # @return [Array<(LoggingHoneycombResponse, Integer, Hash)>] LoggingHoneycombResponse data, response status code and response headers def get_log_honeycomb_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: LoggingHoneycombApi.get_log_honeycomb ...' end # unbox the parameters from the hash @@ -251,11 +251,11 @@ # http body (model) post_body = opts[:debug_body] # return_type - return_type = opts[:debug_return_type] || 'LoggingHoneycomb' + return_type = opts[:debug_return_type] || 'LoggingHoneycombResponse' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( @@ -350,13 +350,13 @@ # @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_honeycomb_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 &#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;. - # @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 &#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) # @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). Must produce valid JSON that Honeycomb can ingest. + # @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 &#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) # @option opts [String] :dataset The Honeycomb Dataset you want to log to. # @option opts [String] :token The Write Key from the Account page of your Honeycomb account. # @return [LoggingHoneycombResponse] def update_log_honeycomb(opts = {}) data, _status_code, _headers = update_log_honeycomb_with_http_info(opts) @@ -368,13 +368,13 @@ # @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_honeycomb_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 &#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;. - # @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 &#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) # @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). Must produce valid JSON that Honeycomb can ingest. + # @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 &#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) # @option opts [String] :dataset The Honeycomb Dataset you want to log to. # @option opts [String] :token The Write Key from the Account page of your Honeycomb account. # @return [Array<(LoggingHoneycombResponse, Integer, Hash)>] LoggingHoneycombResponse data, response status code and response headers def update_log_honeycomb_with_http_info(opts = {}) if @api_client.config.debugging @@ -422,12 +422,12 @@ # 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['dataset'] = opts[:'dataset'] if !opts[:'dataset'].nil? form_params['token'] = opts[:'token'] if !opts[:'token'].nil? # http body (model) post_body = opts[:debug_body]