class Fastly::LoggingElasticsearchApi
Attributes
Public Class Methods
Source
# File lib/fastly/api/logging_elasticsearch_api.rb, line 17 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Source
# File lib/fastly/api/logging_elasticsearch_api.rb, line 42 def create_log_elasticsearch(opts = {}) data, _status_code, _headers = create_log_elasticsearch_with_http_info(opts) data end
Create an Elasticsearch log endpoint Create a Elasticsearch logging endpoint 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/). Must produce valid JSON that Elasticsearch can ingest. @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] :tls_ca_cert A secure certificate to authenticate a server with. Must be in PEM format. (default to ‘null’) @option opts [String] :tls_client_cert The client certificate used to make authenticated requests. Must be in PEM format. (default to ‘null’) @option opts [String] :tls_client_key The client private key used to make authenticated requests. Must be in PEM format. (default to ‘null’) @option opts [String] :tls_hostname The hostname to verify the server's certificate. This should be one of the Subject Alternative Name (SAN) fields for the certificate. Common Names (CN) are not supported. (default to ‘null’) @option opts [Integer] :request_max_entries The maximum number of logs sent in one request. Defaults `0` for unbounded. (default to 0) @option opts [Integer] :request_max_bytes The maximum number of bytes sent in one request. Defaults `0` for unbounded. (default to 0) @option opts [String] :index The name of the Elasticsearch index to send documents (logs) to. The index must follow the Elasticsearch [index format rules](www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html). We support [strftime](www.man7.org/linux/man-pages/man3/strftime.3.html) interpolated variables inside braces prefixed with a pound symbol. For example, `\#{%F}` will interpolate as `YYYY-MM-DD` with today's date. @option opts [String] :url The URL to stream logs to. Must use HTTPS. @option opts [String] :pipeline The ID of the Elasticsearch ingest pipeline to apply pre-process transformations to before indexing. Learn more about creating a pipeline in the [Elasticsearch docs](www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html). @option opts [String] :user Basic Auth username. @option opts [String] :password Basic Auth password. @return [LoggingElasticsearchResponse]
Source
# File lib/fastly/api/logging_elasticsearch_api.rb, line 69 def create_log_elasticsearch_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: LoggingElasticsearchApi.create_log_elasticsearch ...' 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 LoggingElasticsearchApi.create_log_elasticsearch" 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 LoggingElasticsearchApi.create_log_elasticsearch" 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 # resource path local_var_path = '/service/{service_id}/version/{version_id}/logging/elasticsearch'.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['tls_ca_cert'] = opts[:'tls_ca_cert'] if !opts[:'tls_ca_cert'].nil? form_params['tls_client_cert'] = opts[:'tls_client_cert'] if !opts[:'tls_client_cert'].nil? form_params['tls_client_key'] = opts[:'tls_client_key'] if !opts[:'tls_client_key'].nil? form_params['tls_hostname'] = opts[:'tls_hostname'] if !opts[:'tls_hostname'].nil? form_params['request_max_entries'] = opts[:'request_max_entries'] if !opts[:'request_max_entries'].nil? form_params['request_max_bytes'] = opts[:'request_max_bytes'] if !opts[:'request_max_bytes'].nil? form_params['index'] = opts[:'index'] if !opts[:'index'].nil? form_params['url'] = opts[:'url'] if !opts[:'url'].nil? form_params['pipeline'] = opts[:'pipeline'] if !opts[:'pipeline'].nil? form_params['user'] = opts[:'user'] if !opts[:'user'].nil? form_params['password'] = opts[:'password'] if !opts[:'password'].nil? # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'LoggingElasticsearchResponse' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"LoggingElasticsearchApi.create_log_elasticsearch", :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: LoggingElasticsearchApi#create_log_elasticsearch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Create an Elasticsearch log endpoint Create a Elasticsearch logging endpoint 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/). Must produce valid JSON that Elasticsearch can ingest. @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] :tls_ca_cert A secure certificate to authenticate a server with. Must be in PEM format. (default to ‘null’) @option opts [String] :tls_client_cert The client certificate used to make authenticated requests. Must be in PEM format. (default to ‘null’) @option opts [String] :tls_client_key The client private key used to make authenticated requests. Must be in PEM format. (default to ‘null’) @option opts [String] :tls_hostname The hostname to verify the server's certificate. This should be one of the Subject Alternative Name (SAN) fields for the certificate. Common Names (CN) are not supported. (default to ‘null’) @option opts [Integer] :request_max_entries The maximum number of logs sent in one request. Defaults `0` for unbounded. (default to 0) @option opts [Integer] :request_max_bytes The maximum number of bytes sent in one request. Defaults `0` for unbounded. (default to 0) @option opts [String] :index The name of the Elasticsearch index to send documents (logs) to. The index must follow the Elasticsearch [index format rules](www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html). We support [strftime](www.man7.org/linux/man-pages/man3/strftime.3.html) interpolated variables inside braces prefixed with a pound symbol. For example, `\#{%F}` will interpolate as `YYYY-MM-DD` with today's date. @option opts [String] :url The URL to stream logs to. Must use HTTPS. @option opts [String] :pipeline The ID of the Elasticsearch ingest pipeline to apply pre-process transformations to before indexing. Learn more about creating a pipeline in the [Elasticsearch docs](www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html). @option opts [String] :user Basic Auth username. @option opts [String] :password Basic Auth password. @return [Array<(LoggingElasticsearchResponse
, Integer, Hash)>] LoggingElasticsearchResponse
data, response status code and response headers
Source
# File lib/fastly/api/logging_elasticsearch_api.rb, line 164 def delete_log_elasticsearch(opts = {}) data, _status_code, _headers = delete_log_elasticsearch_with_http_info(opts) data end
Delete an Elasticsearch log endpoint Delete the Elasticsearch logging endpoint 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_elasticsearch_name The name for the real-time logging configuration. (required) @return [InlineResponse200]
Source
# File lib/fastly/api/logging_elasticsearch_api.rb, line 175 def delete_log_elasticsearch_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: LoggingElasticsearchApi.delete_log_elasticsearch ...' end # unbox the parameters from the hash service_id = opts[:'service_id'] version_id = opts[:'version_id'] logging_elasticsearch_name = opts[:'logging_elasticsearch_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 LoggingElasticsearchApi.delete_log_elasticsearch" 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 LoggingElasticsearchApi.delete_log_elasticsearch" end # verify the required parameter 'logging_elasticsearch_name' is set if @api_client.config.client_side_validation && logging_elasticsearch_name.nil? fail ArgumentError, "Missing the required parameter 'logging_elasticsearch_name' when calling LoggingElasticsearchApi.delete_log_elasticsearch" end # resource path local_var_path = '/service/{service_id}/version/{version_id}/logging/elasticsearch/{logging_elasticsearch_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'logging_elasticsearch_name' + '}', CGI.escape(logging_elasticsearch_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 => :"LoggingElasticsearchApi.delete_log_elasticsearch", :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: LoggingElasticsearchApi#delete_log_elasticsearch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete an Elasticsearch log endpoint Delete the Elasticsearch logging endpoint 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_elasticsearch_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_elasticsearch_api.rb, line 241 def get_log_elasticsearch(opts = {}) data, _status_code, _headers = get_log_elasticsearch_with_http_info(opts) data end
Get an Elasticsearch log endpoint Get the Elasticsearch logging endpoint 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_elasticsearch_name The name for the real-time logging configuration. (required) @return [LoggingElasticsearchResponse]
Source
# File lib/fastly/api/logging_elasticsearch_api.rb, line 252 def get_log_elasticsearch_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: LoggingElasticsearchApi.get_log_elasticsearch ...' end # unbox the parameters from the hash service_id = opts[:'service_id'] version_id = opts[:'version_id'] logging_elasticsearch_name = opts[:'logging_elasticsearch_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 LoggingElasticsearchApi.get_log_elasticsearch" 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 LoggingElasticsearchApi.get_log_elasticsearch" end # verify the required parameter 'logging_elasticsearch_name' is set if @api_client.config.client_side_validation && logging_elasticsearch_name.nil? fail ArgumentError, "Missing the required parameter 'logging_elasticsearch_name' when calling LoggingElasticsearchApi.get_log_elasticsearch" end # resource path local_var_path = '/service/{service_id}/version/{version_id}/logging/elasticsearch/{logging_elasticsearch_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'logging_elasticsearch_name' + '}', CGI.escape(logging_elasticsearch_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] || 'LoggingElasticsearchResponse' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"LoggingElasticsearchApi.get_log_elasticsearch", :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: LoggingElasticsearchApi#get_log_elasticsearch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get an Elasticsearch log endpoint Get the Elasticsearch logging endpoint 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_elasticsearch_name The name for the real-time logging configuration. (required) @return [Array<(LoggingElasticsearchResponse
, Integer, Hash)>] LoggingElasticsearchResponse
data, response status code and response headers
Source
# File lib/fastly/api/logging_elasticsearch_api.rb, line 317 def list_log_elasticsearch(opts = {}) data, _status_code, _headers = list_log_elasticsearch_with_http_info(opts) data end
List Elasticsearch log endpoints List all of the Elasticsearch logging endpoints 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<LoggingElasticsearchResponse>]
Source
# File lib/fastly/api/logging_elasticsearch_api.rb, line 327 def list_log_elasticsearch_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: LoggingElasticsearchApi.list_log_elasticsearch ...' 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 LoggingElasticsearchApi.list_log_elasticsearch" 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 LoggingElasticsearchApi.list_log_elasticsearch" end # resource path local_var_path = '/service/{service_id}/version/{version_id}/logging/elasticsearch'.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<LoggingElasticsearchResponse>' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"LoggingElasticsearchApi.list_log_elasticsearch", :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: LoggingElasticsearchApi#list_log_elasticsearch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List Elasticsearch log endpoints List all of the Elasticsearch logging endpoints 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<LoggingElasticsearchResponse>, Integer, Hash)>] Array<LoggingElasticsearchResponse> data, response status code and response headers
Source
# File lib/fastly/api/logging_elasticsearch_api.rb, line 405 def update_log_elasticsearch(opts = {}) data, _status_code, _headers = update_log_elasticsearch_with_http_info(opts) data end
Update an Elasticsearch log endpoint Update the Elasticsearch logging endpoint 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_elasticsearch_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/). Must produce valid JSON that Elasticsearch can ingest. @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] :tls_ca_cert A secure certificate to authenticate a server with. Must be in PEM format. (default to ‘null’) @option opts [String] :tls_client_cert The client certificate used to make authenticated requests. Must be in PEM format. (default to ‘null’) @option opts [String] :tls_client_key The client private key used to make authenticated requests. Must be in PEM format. (default to ‘null’) @option opts [String] :tls_hostname The hostname to verify the server's certificate. This should be one of the Subject Alternative Name (SAN) fields for the certificate. Common Names (CN) are not supported. (default to ‘null’) @option opts [Integer] :request_max_entries The maximum number of logs sent in one request. Defaults `0` for unbounded. (default to 0) @option opts [Integer] :request_max_bytes The maximum number of bytes sent in one request. Defaults `0` for unbounded. (default to 0) @option opts [String] :index The name of the Elasticsearch index to send documents (logs) to. The index must follow the Elasticsearch [index format rules](www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html). We support [strftime](www.man7.org/linux/man-pages/man3/strftime.3.html) interpolated variables inside braces prefixed with a pound symbol. For example, `\#{%F}` will interpolate as `YYYY-MM-DD` with today's date. @option opts [String] :url The URL to stream logs to. Must use HTTPS. @option opts [String] :pipeline The ID of the Elasticsearch ingest pipeline to apply pre-process transformations to before indexing. Learn more about creating a pipeline in the [Elasticsearch docs](www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html). @option opts [String] :user Basic Auth username. @option opts [String] :password Basic Auth password. @return [LoggingElasticsearchResponse]
Source
# File lib/fastly/api/logging_elasticsearch_api.rb, line 433 def update_log_elasticsearch_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: LoggingElasticsearchApi.update_log_elasticsearch ...' end # unbox the parameters from the hash service_id = opts[:'service_id'] version_id = opts[:'version_id'] logging_elasticsearch_name = opts[:'logging_elasticsearch_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 LoggingElasticsearchApi.update_log_elasticsearch" 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 LoggingElasticsearchApi.update_log_elasticsearch" end # verify the required parameter 'logging_elasticsearch_name' is set if @api_client.config.client_side_validation && logging_elasticsearch_name.nil? fail ArgumentError, "Missing the required parameter 'logging_elasticsearch_name' when calling LoggingElasticsearchApi.update_log_elasticsearch" 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 # resource path local_var_path = '/service/{service_id}/version/{version_id}/logging/elasticsearch/{logging_elasticsearch_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'logging_elasticsearch_name' + '}', CGI.escape(logging_elasticsearch_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['tls_ca_cert'] = opts[:'tls_ca_cert'] if !opts[:'tls_ca_cert'].nil? form_params['tls_client_cert'] = opts[:'tls_client_cert'] if !opts[:'tls_client_cert'].nil? form_params['tls_client_key'] = opts[:'tls_client_key'] if !opts[:'tls_client_key'].nil? form_params['tls_hostname'] = opts[:'tls_hostname'] if !opts[:'tls_hostname'].nil? form_params['request_max_entries'] = opts[:'request_max_entries'] if !opts[:'request_max_entries'].nil? form_params['request_max_bytes'] = opts[:'request_max_bytes'] if !opts[:'request_max_bytes'].nil? form_params['index'] = opts[:'index'] if !opts[:'index'].nil? form_params['url'] = opts[:'url'] if !opts[:'url'].nil? form_params['pipeline'] = opts[:'pipeline'] if !opts[:'pipeline'].nil? form_params['user'] = opts[:'user'] if !opts[:'user'].nil? form_params['password'] = opts[:'password'] if !opts[:'password'].nil? # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'LoggingElasticsearchResponse' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"LoggingElasticsearchApi.update_log_elasticsearch", :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: LoggingElasticsearchApi#update_log_elasticsearch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update an Elasticsearch log endpoint Update the Elasticsearch logging endpoint 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_elasticsearch_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/). Must produce valid JSON that Elasticsearch can ingest. @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] :tls_ca_cert A secure certificate to authenticate a server with. Must be in PEM format. (default to ‘null’) @option opts [String] :tls_client_cert The client certificate used to make authenticated requests. Must be in PEM format. (default to ‘null’) @option opts [String] :tls_client_key The client private key used to make authenticated requests. Must be in PEM format. (default to ‘null’) @option opts [String] :tls_hostname The hostname to verify the server's certificate. This should be one of the Subject Alternative Name (SAN) fields for the certificate. Common Names (CN) are not supported. (default to ‘null’) @option opts [Integer] :request_max_entries The maximum number of logs sent in one request. Defaults `0` for unbounded. (default to 0) @option opts [Integer] :request_max_bytes The maximum number of bytes sent in one request. Defaults `0` for unbounded. (default to 0) @option opts [String] :index The name of the Elasticsearch index to send documents (logs) to. The index must follow the Elasticsearch [index format rules](www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html). We support [strftime](www.man7.org/linux/man-pages/man3/strftime.3.html) interpolated variables inside braces prefixed with a pound symbol. For example, `\#{%F}` will interpolate as `YYYY-MM-DD` with today's date. @option opts [String] :url The URL to stream logs to. Must use HTTPS. @option opts [String] :pipeline The ID of the Elasticsearch ingest pipeline to apply pre-process transformations to before indexing. Learn more about creating a pipeline in the [Elasticsearch docs](www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html). @option opts [String] :user Basic Auth username. @option opts [String] :password Basic Auth password. @return [Array<(LoggingElasticsearchResponse
, Integer, Hash)>] LoggingElasticsearchResponse
data, response status code and response headers