class Fastly::ResponseObjectApi
Attributes
Public Class Methods
Source
# File lib/fastly/api/response_object_api.rb, line 17 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Source
# File lib/fastly/api/response_object_api.rb, line 26 def create_response_object(opts = {}) data, _status_code, _headers = create_response_object_with_http_info(opts) data end
Create a Response object Creates a new Response Object
. @option opts [String] :service_id Alphanumeric string identifying the service. (required) @option opts [Integer] :version_id Integer identifying a service version. (required) @option opts [CreateResponseObjectRequest] :create_response_object_request @return [ResponseObjectResponse]
Source
# File lib/fastly/api/response_object_api.rb, line 37 def create_response_object_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ResponseObjectApi.create_response_object ...' 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 ResponseObjectApi.create_response_object" 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 ResponseObjectApi.create_response_object" end # resource path local_var_path = '/service/{service_id}/version/{version_id}/response_object'.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/json']) 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] || @api_client.object_to_http_body(opts[:'create_response_object_request']) # return_type return_type = opts[:debug_return_type] || 'ResponseObjectResponse' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"ResponseObjectApi.create_response_object", :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: ResponseObjectApi#create_response_object\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Create a Response object Creates a new Response Object
. @option opts [String] :service_id Alphanumeric string identifying the service. (required) @option opts [Integer] :version_id Integer identifying a service version. (required) @option opts [CreateResponseObjectRequest] :create_response_object_request @return [Array<(ResponseObjectResponse
, Integer, Hash)>] ResponseObjectResponse
data, response status code and response headers
Source
# File lib/fastly/api/response_object_api.rb, line 103 def delete_response_object(opts = {}) data, _status_code, _headers = delete_response_object_with_http_info(opts) data end
Delete a Response Object
Deletes the specified Response Object
. @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] :response_object_name Name for the request settings. (required) @return [InlineResponse200]
Source
# File lib/fastly/api/response_object_api.rb, line 114 def delete_response_object_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ResponseObjectApi.delete_response_object ...' end # unbox the parameters from the hash service_id = opts[:'service_id'] version_id = opts[:'version_id'] response_object_name = opts[:'response_object_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 ResponseObjectApi.delete_response_object" 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 ResponseObjectApi.delete_response_object" end # verify the required parameter 'response_object_name' is set if @api_client.config.client_side_validation && response_object_name.nil? fail ArgumentError, "Missing the required parameter 'response_object_name' when calling ResponseObjectApi.delete_response_object" end # resource path local_var_path = '/service/{service_id}/version/{version_id}/response_object/{response_object_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'response_object_name' + '}', CGI.escape(response_object_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 => :"ResponseObjectApi.delete_response_object", :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: ResponseObjectApi#delete_response_object\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a Response Object
Deletes the specified Response Object
. @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] :response_object_name Name for the request settings. (required) @return [Array<(InlineResponse200
, Integer, Hash)>] InlineResponse200
data, response status code and response headers
Source
# File lib/fastly/api/response_object_api.rb, line 180 def get_response_object(opts = {}) data, _status_code, _headers = get_response_object_with_http_info(opts) data end
Get a Response object Gets the specified Response Object
. @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] :response_object_name Name for the request settings. (required) @return [ResponseObjectResponse]
Source
# File lib/fastly/api/response_object_api.rb, line 191 def get_response_object_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ResponseObjectApi.get_response_object ...' end # unbox the parameters from the hash service_id = opts[:'service_id'] version_id = opts[:'version_id'] response_object_name = opts[:'response_object_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 ResponseObjectApi.get_response_object" 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 ResponseObjectApi.get_response_object" end # verify the required parameter 'response_object_name' is set if @api_client.config.client_side_validation && response_object_name.nil? fail ArgumentError, "Missing the required parameter 'response_object_name' when calling ResponseObjectApi.get_response_object" end # resource path local_var_path = '/service/{service_id}/version/{version_id}/response_object/{response_object_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'response_object_name' + '}', CGI.escape(response_object_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] || 'ResponseObjectResponse' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"ResponseObjectApi.get_response_object", :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: ResponseObjectApi#get_response_object\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get a Response object Gets the specified Response Object
. @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] :response_object_name Name for the request settings. (required) @return [Array<(ResponseObjectResponse
, Integer, Hash)>] ResponseObjectResponse
data, response status code and response headers
Source
# File lib/fastly/api/response_object_api.rb, line 256 def list_response_objects(opts = {}) data, _status_code, _headers = list_response_objects_with_http_info(opts) data end
List Response objects Returns all Response Objects for the specified 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<ResponseObjectResponse>]
Source
# File lib/fastly/api/response_object_api.rb, line 266 def list_response_objects_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ResponseObjectApi.list_response_objects ...' 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 ResponseObjectApi.list_response_objects" 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 ResponseObjectApi.list_response_objects" end # resource path local_var_path = '/service/{service_id}/version/{version_id}/response_object'.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<ResponseObjectResponse>' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"ResponseObjectApi.list_response_objects", :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: ResponseObjectApi#list_response_objects\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List Response objects Returns all Response Objects for the specified 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<ResponseObjectResponse>, Integer, Hash)>] Array<ResponseObjectResponse> data, response status code and response headers
Source
# File lib/fastly/api/response_object_api.rb, line 328 def update_response_object(opts = {}) data, _status_code, _headers = update_response_object_with_http_info(opts) data end
Update a Response object Updates the specified Response Object
. @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] :response_object_name Name for the request settings. (required) @option opts [CreateResponseObjectRequest] :create_response_object_request @return [ResponseObjectResponse]
Source
# File lib/fastly/api/response_object_api.rb, line 340 def update_response_object_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ResponseObjectApi.update_response_object ...' end # unbox the parameters from the hash service_id = opts[:'service_id'] version_id = opts[:'version_id'] response_object_name = opts[:'response_object_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 ResponseObjectApi.update_response_object" 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 ResponseObjectApi.update_response_object" end # verify the required parameter 'response_object_name' is set if @api_client.config.client_side_validation && response_object_name.nil? fail ArgumentError, "Missing the required parameter 'response_object_name' when calling ResponseObjectApi.update_response_object" end # resource path local_var_path = '/service/{service_id}/version/{version_id}/response_object/{response_object_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'response_object_name' + '}', CGI.escape(response_object_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/json']) 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] || @api_client.object_to_http_body(opts[:'create_response_object_request']) # return_type return_type = opts[:debug_return_type] || 'ResponseObjectResponse' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"ResponseObjectApi.update_response_object", :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: ResponseObjectApi#update_response_object\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update a Response object Updates the specified Response Object
. @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] :response_object_name Name for the request settings. (required) @option opts [CreateResponseObjectRequest] :create_response_object_request @return [Array<(ResponseObjectResponse
, Integer, Hash)>] ResponseObjectResponse
data, response status code and response headers