=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://www.fastly.com/documentation/reference/api/) The version of the OpenAPI document: 1.0.0 Contact: oss@fastly.com =end require 'cgi' module Fastly class LoggingLogshuttleApi attr_accessor :api_client def initialize(api_client = ApiClient.default) @api_client = api_client end # Create a Log Shuttle log endpoint # Create a Log Shuttle 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](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] :token The data authentication token associated with this endpoint. # @option opts [String] :url The URL to stream logs to. # @return [LoggingLogshuttleResponse] def create_log_logshuttle(opts = {}) data, _status_code, _headers = create_log_logshuttle_with_http_info(opts) data end # Create a Log Shuttle log endpoint # Create a Log Shuttle 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](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] :token The data authentication token associated with this endpoint. # @option opts [String] :url The URL to stream logs to. # @return [Array<(LoggingLogshuttleResponse, Integer, Hash)>] LoggingLogshuttleResponse data, response status code and response headers def create_log_logshuttle_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: LoggingLogshuttleApi.create_log_logshuttle ...' 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 LoggingLogshuttleApi.create_log_logshuttle" 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 LoggingLogshuttleApi.create_log_logshuttle" 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 # resource path local_var_path = '/service/{service_id}/version/{version_id}/logging/logshuttle'.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['format_version'] = opts[:'format_version'] if !opts[:'format_version'].nil? form_params['token'] = opts[:'token'] if !opts[:'token'].nil? form_params['url'] = opts[:'url'] if !opts[:'url'].nil? # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'LoggingLogshuttleResponse' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"LoggingLogshuttleApi.create_log_logshuttle", :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: LoggingLogshuttleApi#create_log_logshuttle\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Delete a Log Shuttle log endpoint # Delete the Log Shuttle 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_logshuttle_name The name for the real-time logging configuration. (required) # @return [InlineResponse200] def delete_log_logshuttle(opts = {}) data, _status_code, _headers = delete_log_logshuttle_with_http_info(opts) data end # Delete a Log Shuttle log endpoint # Delete the Log Shuttle 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_logshuttle_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_logshuttle_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: LoggingLogshuttleApi.delete_log_logshuttle ...' end # unbox the parameters from the hash service_id = opts[:'service_id'] version_id = opts[:'version_id'] logging_logshuttle_name = opts[:'logging_logshuttle_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 LoggingLogshuttleApi.delete_log_logshuttle" 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 LoggingLogshuttleApi.delete_log_logshuttle" end # verify the required parameter 'logging_logshuttle_name' is set if @api_client.config.client_side_validation && logging_logshuttle_name.nil? fail ArgumentError, "Missing the required parameter 'logging_logshuttle_name' when calling LoggingLogshuttleApi.delete_log_logshuttle" end # resource path local_var_path = '/service/{service_id}/version/{version_id}/logging/logshuttle/{logging_logshuttle_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'logging_logshuttle_name' + '}', CGI.escape(logging_logshuttle_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 => :"LoggingLogshuttleApi.delete_log_logshuttle", :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: LoggingLogshuttleApi#delete_log_logshuttle\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Get a Log Shuttle log endpoint # Get the Log Shuttle 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_logshuttle_name The name for the real-time logging configuration. (required) # @return [LoggingLogshuttleResponse] def get_log_logshuttle(opts = {}) data, _status_code, _headers = get_log_logshuttle_with_http_info(opts) data end # Get a Log Shuttle log endpoint # Get the Log Shuttle 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_logshuttle_name The name for the real-time logging configuration. (required) # @return [Array<(LoggingLogshuttleResponse, Integer, Hash)>] LoggingLogshuttleResponse data, response status code and response headers def get_log_logshuttle_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: LoggingLogshuttleApi.get_log_logshuttle ...' end # unbox the parameters from the hash service_id = opts[:'service_id'] version_id = opts[:'version_id'] logging_logshuttle_name = opts[:'logging_logshuttle_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 LoggingLogshuttleApi.get_log_logshuttle" 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 LoggingLogshuttleApi.get_log_logshuttle" end # verify the required parameter 'logging_logshuttle_name' is set if @api_client.config.client_side_validation && logging_logshuttle_name.nil? fail ArgumentError, "Missing the required parameter 'logging_logshuttle_name' when calling LoggingLogshuttleApi.get_log_logshuttle" end # resource path local_var_path = '/service/{service_id}/version/{version_id}/logging/logshuttle/{logging_logshuttle_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'logging_logshuttle_name' + '}', CGI.escape(logging_logshuttle_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] || 'LoggingLogshuttleResponse' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"LoggingLogshuttleApi.get_log_logshuttle", :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: LoggingLogshuttleApi#get_log_logshuttle\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # List Log Shuttle log endpoints # List all of the Log Shuttle 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_logshuttle(opts = {}) data, _status_code, _headers = list_log_logshuttle_with_http_info(opts) data end # List Log Shuttle log endpoints # List all of the Log Shuttle 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_logshuttle_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: LoggingLogshuttleApi.list_log_logshuttle ...' 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 LoggingLogshuttleApi.list_log_logshuttle" 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 LoggingLogshuttleApi.list_log_logshuttle" end # resource path local_var_path = '/service/{service_id}/version/{version_id}/logging/logshuttle'.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 => :"LoggingLogshuttleApi.list_log_logshuttle", :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: LoggingLogshuttleApi#list_log_logshuttle\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Update a Log Shuttle log endpoint # Update the Log Shuttle 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_logshuttle_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](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] :token The data authentication token associated with this endpoint. # @option opts [String] :url The URL to stream logs to. # @return [LoggingLogshuttleResponse] def update_log_logshuttle(opts = {}) data, _status_code, _headers = update_log_logshuttle_with_http_info(opts) data end # Update a Log Shuttle log endpoint # Update the Log Shuttle 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_logshuttle_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](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] :token The data authentication token associated with this endpoint. # @option opts [String] :url The URL to stream logs to. # @return [Array<(LoggingLogshuttleResponse, Integer, Hash)>] LoggingLogshuttleResponse data, response status code and response headers def update_log_logshuttle_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: LoggingLogshuttleApi.update_log_logshuttle ...' end # unbox the parameters from the hash service_id = opts[:'service_id'] version_id = opts[:'version_id'] logging_logshuttle_name = opts[:'logging_logshuttle_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 LoggingLogshuttleApi.update_log_logshuttle" 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 LoggingLogshuttleApi.update_log_logshuttle" end # verify the required parameter 'logging_logshuttle_name' is set if @api_client.config.client_side_validation && logging_logshuttle_name.nil? fail ArgumentError, "Missing the required parameter 'logging_logshuttle_name' when calling LoggingLogshuttleApi.update_log_logshuttle" 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 # resource path local_var_path = '/service/{service_id}/version/{version_id}/logging/logshuttle/{logging_logshuttle_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'logging_logshuttle_name' + '}', CGI.escape(logging_logshuttle_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['format_version'] = opts[:'format_version'] if !opts[:'format_version'].nil? form_params['token'] = opts[:'token'] if !opts[:'token'].nil? form_params['url'] = opts[:'url'] if !opts[:'url'].nil? # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'LoggingLogshuttleResponse' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"LoggingLogshuttleApi.update_log_logshuttle", :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: LoggingLogshuttleApi#update_log_logshuttle\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end end end