class Fastly::LoggingHerokuApi
Attributes
Public Class Methods
# File lib/fastly/api/logging_heroku_api.rb, line 17 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Create a Heroku log endpoint Create a Heroku 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](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 token to use for authentication ([devcenter.heroku.com/articles/add-on-partner-log-integration](https://devcenter.heroku.com/articles/add-on-partner-log-integration)). @option opts [String] :url The URL to stream logs to. @return [LoggingHerokuResponse]
# File lib/fastly/api/logging_heroku_api.rb, line 32 def create_log_heroku(opts = {}) data, _status_code, _headers = create_log_heroku_with_http_info(opts) data end
Create a Heroku log endpoint Create a Heroku 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](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 token to use for authentication ([devcenter.heroku.com/articles/add-on-partner-log-integration](https://devcenter.heroku.com/articles/add-on-partner-log-integration)). @option opts [String] :url The URL to stream logs to. @return [Array<(LoggingHerokuResponse
, Integer, Hash)>] LoggingHerokuResponse
data, response status code and response headers
# File lib/fastly/api/logging_heroku_api.rb, line 49 def create_log_heroku_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: LoggingHerokuApi.create_log_heroku ...' 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 LoggingHerokuApi.create_log_heroku" 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 LoggingHerokuApi.create_log_heroku" 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/heroku'.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] || 'LoggingHerokuResponse' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"LoggingHerokuApi.create_log_heroku", :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: LoggingHerokuApi#create_log_heroku\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete the Heroku log endpoint Delete the Heroku 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_heroku_name The name for the real-time logging configuration. (required) @return [InlineResponse200]
# File lib/fastly/api/logging_heroku_api.rb, line 130 def delete_log_heroku(opts = {}) data, _status_code, _headers = delete_log_heroku_with_http_info(opts) data end
Delete the Heroku log endpoint Delete the Heroku 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_heroku_name The name for the real-time logging configuration. (required) @return [Array<(InlineResponse200
, Integer, Hash)>] InlineResponse200
data, response status code and response headers
# File lib/fastly/api/logging_heroku_api.rb, line 141 def delete_log_heroku_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: LoggingHerokuApi.delete_log_heroku ...' end # unbox the parameters from the hash service_id = opts[:'service_id'] version_id = opts[:'version_id'] logging_heroku_name = opts[:'logging_heroku_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 LoggingHerokuApi.delete_log_heroku" 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 LoggingHerokuApi.delete_log_heroku" end # verify the required parameter 'logging_heroku_name' is set if @api_client.config.client_side_validation && logging_heroku_name.nil? fail ArgumentError, "Missing the required parameter 'logging_heroku_name' when calling LoggingHerokuApi.delete_log_heroku" end # resource path local_var_path = '/service/{service_id}/version/{version_id}/logging/heroku/{logging_heroku_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'logging_heroku_name' + '}', CGI.escape(logging_heroku_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 => :"LoggingHerokuApi.delete_log_heroku", :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: LoggingHerokuApi#delete_log_heroku\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get a Heroku log endpoint Get the Heroku 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_heroku_name The name for the real-time logging configuration. (required) @return [LoggingHerokuResponse]
# File lib/fastly/api/logging_heroku_api.rb, line 207 def get_log_heroku(opts = {}) data, _status_code, _headers = get_log_heroku_with_http_info(opts) data end
Get a Heroku log endpoint Get the Heroku 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_heroku_name The name for the real-time logging configuration. (required) @return [Array<(LoggingHerokuResponse
, Integer, Hash)>] LoggingHerokuResponse
data, response status code and response headers
# File lib/fastly/api/logging_heroku_api.rb, line 218 def get_log_heroku_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: LoggingHerokuApi.get_log_heroku ...' end # unbox the parameters from the hash service_id = opts[:'service_id'] version_id = opts[:'version_id'] logging_heroku_name = opts[:'logging_heroku_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 LoggingHerokuApi.get_log_heroku" 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 LoggingHerokuApi.get_log_heroku" end # verify the required parameter 'logging_heroku_name' is set if @api_client.config.client_side_validation && logging_heroku_name.nil? fail ArgumentError, "Missing the required parameter 'logging_heroku_name' when calling LoggingHerokuApi.get_log_heroku" end # resource path local_var_path = '/service/{service_id}/version/{version_id}/logging/heroku/{logging_heroku_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'logging_heroku_name' + '}', CGI.escape(logging_heroku_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] || 'LoggingHerokuResponse' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"LoggingHerokuApi.get_log_heroku", :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: LoggingHerokuApi#get_log_heroku\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List Heroku log endpoints List all of the Herokus 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<LoggingHerokuResponse>]
# File lib/fastly/api/logging_heroku_api.rb, line 283 def list_log_heroku(opts = {}) data, _status_code, _headers = list_log_heroku_with_http_info(opts) data end
List Heroku log endpoints List all of the Herokus 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<LoggingHerokuResponse>, Integer, Hash)>] Array<LoggingHerokuResponse> data, response status code and response headers
# File lib/fastly/api/logging_heroku_api.rb, line 293 def list_log_heroku_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: LoggingHerokuApi.list_log_heroku ...' 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 LoggingHerokuApi.list_log_heroku" 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 LoggingHerokuApi.list_log_heroku" end # resource path local_var_path = '/service/{service_id}/version/{version_id}/logging/heroku'.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<LoggingHerokuResponse>' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"LoggingHerokuApi.list_log_heroku", :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: LoggingHerokuApi#list_log_heroku\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update the Heroku log endpoint Update the Heroku 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_heroku_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](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 token to use for authentication ([devcenter.heroku.com/articles/add-on-partner-log-integration](https://devcenter.heroku.com/articles/add-on-partner-log-integration)). @option opts [String] :url The URL to stream logs to. @return [LoggingHerokuResponse]
# File lib/fastly/api/logging_heroku_api.rb, line 361 def update_log_heroku(opts = {}) data, _status_code, _headers = update_log_heroku_with_http_info(opts) data end
Update the Heroku log endpoint Update the Heroku 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_heroku_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](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 token to use for authentication ([devcenter.heroku.com/articles/add-on-partner-log-integration](https://devcenter.heroku.com/articles/add-on-partner-log-integration)). @option opts [String] :url The URL to stream logs to. @return [Array<(LoggingHerokuResponse
, Integer, Hash)>] LoggingHerokuResponse
data, response status code and response headers
# File lib/fastly/api/logging_heroku_api.rb, line 379 def update_log_heroku_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: LoggingHerokuApi.update_log_heroku ...' end # unbox the parameters from the hash service_id = opts[:'service_id'] version_id = opts[:'version_id'] logging_heroku_name = opts[:'logging_heroku_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 LoggingHerokuApi.update_log_heroku" 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 LoggingHerokuApi.update_log_heroku" end # verify the required parameter 'logging_heroku_name' is set if @api_client.config.client_side_validation && logging_heroku_name.nil? fail ArgumentError, "Missing the required parameter 'logging_heroku_name' when calling LoggingHerokuApi.update_log_heroku" 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/heroku/{logging_heroku_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'logging_heroku_name' + '}', CGI.escape(logging_heroku_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] || 'LoggingHerokuResponse' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"LoggingHerokuApi.update_log_heroku", :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: LoggingHerokuApi#update_log_heroku\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end