class Fastly::SettingsApi
Attributes
Public Class Methods
# File lib/fastly/api/settings_api.rb, line 17 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Get service settings Get the settings 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 [SettingsResponse]
# File lib/fastly/api/settings_api.rb, line 25 def get_service_settings(opts = {}) data, _status_code, _headers = get_service_settings_with_http_info(opts) data end
Get service settings Get the settings 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<(SettingsResponse
, Integer, Hash)>] SettingsResponse
data, response status code and response headers
# File lib/fastly/api/settings_api.rb, line 35 def get_service_settings_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SettingsApi.get_service_settings ...' 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 SettingsApi.get_service_settings" 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 SettingsApi.get_service_settings" end # resource path local_var_path = '/service/{service_id}/version/{version_id}/settings'.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] || 'SettingsResponse' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"SettingsApi.get_service_settings", :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: SettingsApi#get_service_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update service settings Update the settings for a particular service and version. NOTE: If you override TTLs with custom VCL, any general.default_ttl value will not be honored and the expected behavior may change. @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] :general_default_host The default host name for the version. @option opts [Integer] :general_default_ttl The default time-to-live (TTL) for the version. @option opts [Boolean] :general_stale_if_error Enables serving a stale object if there is an error. (default to false) @option opts [Integer] :general_stale_if_error_ttl The default time-to-live (TTL) for serving the stale object for the version. (default to 43200) @return [SettingsResponse]
# File lib/fastly/api/settings_api.rb, line 99 def update_service_settings(opts = {}) data, _status_code, _headers = update_service_settings_with_http_info(opts) data end
Update service settings Update the settings for a particular service and version. NOTE: If you override TTLs with custom VCL, any general.default_ttl value will not be honored and the expected behavior may change. @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] :general_default_host The default host name for the version. @option opts [Integer] :general_default_ttl The default time-to-live (TTL) for the version. @option opts [Boolean] :general_stale_if_error Enables serving a stale object if there is an error. (default to false) @option opts [Integer] :general_stale_if_error_ttl The default time-to-live (TTL) for serving the stale object for the version. (default to 43200) @return [Array<(SettingsResponse
, Integer, Hash)>] SettingsResponse
data, response status code and response headers
# File lib/fastly/api/settings_api.rb, line 113 def update_service_settings_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SettingsApi.update_service_settings ...' 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 SettingsApi.update_service_settings" 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 SettingsApi.update_service_settings" end # resource path local_var_path = '/service/{service_id}/version/{version_id}/settings'.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['general.default_host'] = opts[:'general_default_host'] if !opts[:'general_default_host'].nil? form_params['general.default_ttl'] = opts[:'general_default_ttl'] if !opts[:'general_default_ttl'].nil? form_params['general.stale_if_error'] = opts[:'general_stale_if_error'] if !opts[:'general_stale_if_error'].nil? form_params['general.stale_if_error_ttl'] = opts[:'general_stale_if_error_ttl'] if !opts[:'general_stale_if_error_ttl'].nil? # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'SettingsResponse' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"SettingsApi.update_service_settings", :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: SettingsApi#update_service_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end