=begin #Fastly API #Via the Fastly API you can perform any of the operations that are possible within the management console, including creating services, domains, and backends, configuring rules or uploading your own application code, as well as account operations such as user administration and billing reports. The API is organized into collections of endpoints that allow manipulation of objects related to Fastly services and accounts. For the most accurate and up-to-date API reference content, visit our [Developer Hub](https://developer.fastly.com/reference/api/) The version of the OpenAPI document: 1.0.0 Contact: oss@fastly.com =end require 'cgi' module Fastly class LoggingKafkaApi attr_accessor :api_client def initialize(api_client = ApiClient.default) @api_client = api_client end # Create a Kafka log endpoint # Create a Kafka 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 [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] :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 [String] :topic The Kafka topic to send logs to. Required. # @option opts [String] :brokers A comma-separated list of IP addresses or hostnames of Kafka brokers. Required. # @option opts [String] :compression_codec The codec used for compression of your logs. # @option opts [Integer] :required_acks The number of acknowledgements a leader must receive before a write is considered successful. (default to 1) # @option opts [Integer] :request_max_bytes The maximum number of bytes sent in one request. Defaults `0` (no limit). (default to 0) # @option opts [Boolean] :parse_log_keyvals Enables parsing of key=value tuples from the beginning of a logline, turning them into [record headers](https://cwiki.apache.org/confluence/display/KAFKA/KIP-82+-+Add+Record+Headers). # @option opts [String] :auth_method SASL authentication method. # @option opts [String] :user SASL user. # @option opts [String] :password SASL password. # @option opts [LoggingUseTls] :use_tls (default to 0) # @return [LoggingKafkaResponse] def create_log_kafka(opts = {}) data, _status_code, _headers = create_log_kafka_with_http_info(opts) data end # Create a Kafka log endpoint # Create a Kafka 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 [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] :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 [String] :topic The Kafka topic to send logs to. Required. # @option opts [String] :brokers A comma-separated list of IP addresses or hostnames of Kafka brokers. Required. # @option opts [String] :compression_codec The codec used for compression of your logs. # @option opts [Integer] :required_acks The number of acknowledgements a leader must receive before a write is considered successful. (default to 1) # @option opts [Integer] :request_max_bytes The maximum number of bytes sent in one request. Defaults `0` (no limit). (default to 0) # @option opts [Boolean] :parse_log_keyvals Enables parsing of key=value tuples from the beginning of a logline, turning them into [record headers](https://cwiki.apache.org/confluence/display/KAFKA/KIP-82+-+Add+Record+Headers). # @option opts [String] :auth_method SASL authentication method. # @option opts [String] :user SASL user. # @option opts [String] :password SASL password. # @option opts [LoggingUseTls] :use_tls (default to 0) # @return [Array<(LoggingKafkaResponse, Integer, Hash)>] LoggingKafkaResponse data, response status code and response headers def create_log_kafka_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: LoggingKafkaApi.create_log_kafka ...' 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 LoggingKafkaApi.create_log_kafka" 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 LoggingKafkaApi.create_log_kafka" end allowable_values = ["none", "waf_debug", "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 = [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 = ["gzip", "snappy", "lz4", "null"] 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 allowable_values = [1, 0, -1] if @api_client.config.client_side_validation && opts[:'required_acks'] && !allowable_values.include?(opts[:'required_acks']) fail ArgumentError, "invalid value for \"required_acks\", must be one of #{allowable_values}" end allowable_values = ["plain", "scram-sha-256", "scram-sha-512"] if @api_client.config.client_side_validation && opts[:'auth_method'] && !allowable_values.include?(opts[:'auth_method']) fail ArgumentError, "invalid value for \"auth_method\", must be one of #{allowable_values}" end # resource path local_var_path = '/service/{service_id}/version/{version_id}/logging/kafka'.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['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['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['topic'] = opts[:'topic'] if !opts[:'topic'].nil? form_params['brokers'] = opts[:'brokers'] if !opts[:'brokers'].nil? form_params['compression_codec'] = opts[:'compression_codec'] if !opts[:'compression_codec'].nil? form_params['required_acks'] = opts[:'required_acks'] if !opts[:'required_acks'].nil? form_params['request_max_bytes'] = opts[:'request_max_bytes'] if !opts[:'request_max_bytes'].nil? form_params['parse_log_keyvals'] = opts[:'parse_log_keyvals'] if !opts[:'parse_log_keyvals'].nil? form_params['auth_method'] = opts[:'auth_method'] if !opts[:'auth_method'].nil? form_params['user'] = opts[:'user'] if !opts[:'user'].nil? form_params['password'] = opts[:'password'] if !opts[:'password'].nil? form_params['use_tls'] = opts[:'use_tls'] if !opts[:'use_tls'].nil? # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'LoggingKafkaResponse' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"LoggingKafkaApi.create_log_kafka", :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: LoggingKafkaApi#create_log_kafka\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Delete the Kafka log endpoint # Delete the Kafka 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_kafka_name The name for the real-time logging configuration. (required) # @return [InlineResponse200] def delete_log_kafka(opts = {}) data, _status_code, _headers = delete_log_kafka_with_http_info(opts) data end # Delete the Kafka log endpoint # Delete the Kafka 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_kafka_name The name for the real-time logging configuration. (required) # @return [Array<(InlineResponse200, Integer, Hash)>] InlineResponse200 data, response status code and response headers def delete_log_kafka_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: LoggingKafkaApi.delete_log_kafka ...' end # unbox the parameters from the hash service_id = opts[:'service_id'] version_id = opts[:'version_id'] logging_kafka_name = opts[:'logging_kafka_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 LoggingKafkaApi.delete_log_kafka" 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 LoggingKafkaApi.delete_log_kafka" end # verify the required parameter 'logging_kafka_name' is set if @api_client.config.client_side_validation && logging_kafka_name.nil? fail ArgumentError, "Missing the required parameter 'logging_kafka_name' when calling LoggingKafkaApi.delete_log_kafka" end # resource path local_var_path = '/service/{service_id}/version/{version_id}/logging/kafka/{logging_kafka_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'logging_kafka_name' + '}', CGI.escape(logging_kafka_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 => :"LoggingKafkaApi.delete_log_kafka", :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: LoggingKafkaApi#delete_log_kafka\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Get a Kafka log endpoint # Get the Kafka 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_kafka_name The name for the real-time logging configuration. (required) # @return [LoggingKafkaResponse] def get_log_kafka(opts = {}) data, _status_code, _headers = get_log_kafka_with_http_info(opts) data end # Get a Kafka log endpoint # Get the Kafka 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_kafka_name The name for the real-time logging configuration. (required) # @return [Array<(LoggingKafkaResponse, Integer, Hash)>] LoggingKafkaResponse data, response status code and response headers def get_log_kafka_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: LoggingKafkaApi.get_log_kafka ...' end # unbox the parameters from the hash service_id = opts[:'service_id'] version_id = opts[:'version_id'] logging_kafka_name = opts[:'logging_kafka_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 LoggingKafkaApi.get_log_kafka" 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 LoggingKafkaApi.get_log_kafka" end # verify the required parameter 'logging_kafka_name' is set if @api_client.config.client_side_validation && logging_kafka_name.nil? fail ArgumentError, "Missing the required parameter 'logging_kafka_name' when calling LoggingKafkaApi.get_log_kafka" end # resource path local_var_path = '/service/{service_id}/version/{version_id}/logging/kafka/{logging_kafka_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'logging_kafka_name' + '}', CGI.escape(logging_kafka_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] || 'LoggingKafkaResponse' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"LoggingKafkaApi.get_log_kafka", :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: LoggingKafkaApi#get_log_kafka\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # List Kafka log endpoints # List all of the Kafka 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] def list_log_kafka(opts = {}) data, _status_code, _headers = list_log_kafka_with_http_info(opts) data end # List Kafka log endpoints # List all of the Kafka 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, Integer, Hash)>] Array data, response status code and response headers def list_log_kafka_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: LoggingKafkaApi.list_log_kafka ...' 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 LoggingKafkaApi.list_log_kafka" 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 LoggingKafkaApi.list_log_kafka" end # resource path local_var_path = '/service/{service_id}/version/{version_id}/logging/kafka'.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' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"LoggingKafkaApi.list_log_kafka", :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: LoggingKafkaApi#list_log_kafka\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Update the Kafka log endpoint # Update the Kafka 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_kafka_name The name for the real-time logging configuration. (required) # @return [LoggingKafkaResponse] def update_log_kafka(opts = {}) data, _status_code, _headers = update_log_kafka_with_http_info(opts) data end # Update the Kafka log endpoint # Update the Kafka 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_kafka_name The name for the real-time logging configuration. (required) # @return [Array<(LoggingKafkaResponse, Integer, Hash)>] LoggingKafkaResponse data, response status code and response headers def update_log_kafka_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: LoggingKafkaApi.update_log_kafka ...' end # unbox the parameters from the hash service_id = opts[:'service_id'] version_id = opts[:'version_id'] logging_kafka_name = opts[:'logging_kafka_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 LoggingKafkaApi.update_log_kafka" 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 LoggingKafkaApi.update_log_kafka" end # verify the required parameter 'logging_kafka_name' is set if @api_client.config.client_side_validation && logging_kafka_name.nil? fail ArgumentError, "Missing the required parameter 'logging_kafka_name' when calling LoggingKafkaApi.update_log_kafka" end # resource path local_var_path = '/service/{service_id}/version/{version_id}/logging/kafka/{logging_kafka_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'logging_kafka_name' + '}', CGI.escape(logging_kafka_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] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'LoggingKafkaResponse' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"LoggingKafkaApi.update_log_kafka", :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: LoggingKafkaApi#update_log_kafka\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end end end