class Fastly::PurgeApi
Attributes
Public Class Methods
Source
# File lib/fastly/api/purge_api.rb, line 17 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Source
# File lib/fastly/api/purge_api.rb, line 27 def bulk_purge_tag(opts = {}) data, _status_code, _headers = bulk_purge_tag_with_http_info(opts) data end
Purge multiple surrogate key tags Instant Purge a particular service of items tagged with surrogate keys. Up to 256 surrogate keys can be purged in one batch request. As an alternative to sending the keys in a JSON object in the body of the request, this endpoint also supports listing keys in a Surrogate-Key
request header, e.g. Surrogate-Key: key_1 key_2 key_3
. @option opts [String] :service_id Alphanumeric string identifying the service. (required) @option opts [Integer] :fastly_soft_purge If present, this header triggers the purge to be 'soft', which marks the affected object as stale rather than making it inaccessible. Typically set to "1" when used, but the value is not important. @option opts [String] :surrogate_key Purge multiple surrogate key tags using a request header. Not required if a JSON POST body is specified. @option opts [PurgeResponse] :purge_response @return [Hash<String, String>]
Source
# File lib/fastly/api/purge_api.rb, line 39 def bulk_purge_tag_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PurgeApi.bulk_purge_tag ...' end # unbox the parameters from the hash service_id = opts[:'service_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 PurgeApi.bulk_purge_tag" end # resource path local_var_path = '/service/{service_id}/purge'.sub('{' + 'service_id' + '}', CGI.escape(service_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 header_params[:'fastly-soft-purge'] = opts[:'fastly_soft_purge'] if !opts[:'fastly_soft_purge'].nil? header_params[:'surrogate-key'] = opts[:'surrogate_key'] if !opts[:'surrogate_key'].nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'purge_response']) # return_type return_type = opts[:debug_return_type] || 'Hash<String, String>' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"PurgeApi.bulk_purge_tag", :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: PurgeApi#bulk_purge_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Purge multiple surrogate key tags Instant Purge a particular service of items tagged with surrogate keys. Up to 256 surrogate keys can be purged in one batch request. As an alternative to sending the keys in a JSON object in the body of the request, this endpoint also supports listing keys in a <code>Surrogate-Key</code> request header, e.g. <code>Surrogate-Key: key_1 key_2 key_3</code>. @option opts [String] :service_id Alphanumeric string identifying the service. (required) @option opts [Integer] :fastly_soft_purge If present, this header triggers the purge to be 'soft', which marks the affected object as stale rather than making it inaccessible. Typically set to "1" when used, but the value is not important. @option opts [String] :surrogate_key Purge multiple surrogate key tags using a request header. Not required if a JSON POST body is specified. @option opts [PurgeResponse] :purge_response @return [Array<(Hash<String, String>, Integer, Hash)>] Hash<String, String> data, response status code and response headers
Source
# File lib/fastly/api/purge_api.rb, line 100 def purge_all(opts = {}) data, _status_code, _headers = purge_all_with_http_info(opts) data end
Purge everything from a service Instant Purge everything from a service. Purge-all requests cannot be done in soft mode and will always immediately invalidate all cached content associated with the service. To do a soft-purge-all, consider applying a constant [surrogate key](www.fastly.com/documentation/guides/full-site-delivery/purging/working-with-surrogate-keys/) tag (e.g., ‘"all"`) to all objects. @option opts [String] :service_id Alphanumeric string identifying the service. (required) @return [InlineResponse200]
Source
# File lib/fastly/api/purge_api.rb, line 109 def purge_all_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PurgeApi.purge_all ...' end # unbox the parameters from the hash service_id = opts[:'service_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 PurgeApi.purge_all" end # resource path local_var_path = '/service/{service_id}/purge_all'.sub('{' + 'service_id' + '}', CGI.escape(service_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] || 'InlineResponse200' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"PurgeApi.purge_all", :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: PurgeApi#purge_all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Purge everything from a service Instant Purge everything from a service. Purge-all requests cannot be done in soft mode and will always immediately invalidate all cached content associated with the service. To do a soft-purge-all, consider applying a constant [surrogate key](www.fastly.com/documentation/guides/full-site-delivery/purging/working-with-surrogate-keys/) tag (e.g., `"all"`) to all objects. @option opts [String] :service_id Alphanumeric string identifying the service. (required) @return [Array<(InlineResponse200
, Integer, Hash)>] InlineResponse200
data, response status code and response headers
Source
# File lib/fastly/api/purge_api.rb, line 164 def purge_single_url(opts = {}) data, _status_code, _headers = purge_single_url_with_http_info(opts) data end
Purge a URL Instant Purge an individual URL. @option opts [String] :cached_url URL of object in cache to be purged. (required) @option opts [Integer] :fastly_soft_purge If present, this header triggers the purge to be 'soft', which marks the affected object as stale rather than making it inaccessible. Typically set to "1" when used, but the value is not important. @return [PurgeResponse]
Source
# File lib/fastly/api/purge_api.rb, line 174 def purge_single_url_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PurgeApi.purge_single_url ...' end # unbox the parameters from the hash cached_url = opts[:'cached_url'] # verify the required parameter 'cached_url' is set if @api_client.config.client_side_validation && cached_url.nil? fail ArgumentError, "Missing the required parameter 'cached_url' when calling PurgeApi.purge_single_url" end # resource path local_var_path = '/purge/{cached_url}'.sub('{' + 'cached_url' + '}', cached_url.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']) header_params[:'fastly-soft-purge'] = opts[:'fastly_soft_purge'] if !opts[:'fastly_soft_purge'].nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'PurgeResponse' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"PurgeApi.purge_single_url", :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: PurgeApi#purge_single_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Purge a URL Instant Purge an individual URL. @option opts [String] :cached_url URL of object in cache to be purged. (required) @option opts [Integer] :fastly_soft_purge If present, this header triggers the purge to be 'soft', which marks the affected object as stale rather than making it inaccessible. Typically set to "1" when used, but the value is not important. @return [Array<(PurgeResponse
, Integer, Hash)>] PurgeResponse
data, response status code and response headers
Source
# File lib/fastly/api/purge_api.rb, line 231 def purge_tag(opts = {}) data, _status_code, _headers = purge_tag_with_http_info(opts) data end
Purge by surrogate key tag Instant Purge a particular service of items tagged with a Surrogate Key. Only one surrogate key can be purged at a time. Multiple keys can be purged using a batch surrogate key purge request. @option opts [String] :service_id Alphanumeric string identifying the service. (required) @option opts [String] :surrogate_key Surrogate keys are used to efficiently purge content from cache. Instead of purging your entire site or individual URLs, you can tag related assets (like all images and descriptions associated with a single product) with surrogate keys, and these grouped URLs can be purged in a single request. (required) @option opts [Integer] :fastly_soft_purge If present, this header triggers the purge to be 'soft', which marks the affected object as stale rather than making it inaccessible. Typically set to "1" when used, but the value is not important. @return [PurgeResponse]
Source
# File lib/fastly/api/purge_api.rb, line 242 def purge_tag_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PurgeApi.purge_tag ...' end # unbox the parameters from the hash service_id = opts[:'service_id'] surrogate_key = opts[:'surrogate_key'] # 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 PurgeApi.purge_tag" end # verify the required parameter 'surrogate_key' is set if @api_client.config.client_side_validation && surrogate_key.nil? fail ArgumentError, "Missing the required parameter 'surrogate_key' when calling PurgeApi.purge_tag" end # resource path local_var_path = '/service/{service_id}/purge/{surrogate_key}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'surrogate_key' + '}', surrogate_key.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']) header_params[:'fastly-soft-purge'] = opts[:'fastly_soft_purge'] if !opts[:'fastly_soft_purge'].nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'PurgeResponse' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"PurgeApi.purge_tag", :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: PurgeApi#purge_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Purge by surrogate key tag Instant Purge a particular service of items tagged with a Surrogate Key. Only one surrogate key can be purged at a time. Multiple keys can be purged using a batch surrogate key purge request. @option opts [String] :service_id Alphanumeric string identifying the service. (required) @option opts [String] :surrogate_key Surrogate keys are used to efficiently purge content from cache. Instead of purging your entire site or individual URLs, you can tag related assets (like all images and descriptions associated with a single product) with surrogate keys, and these grouped URLs can be purged in a single request. (required) @option opts [Integer] :fastly_soft_purge If present, this header triggers the purge to be 'soft', which marks the affected object as stale rather than making it inaccessible. Typically set to "1" when used, but the value is not important. @return [Array<(PurgeResponse
, Integer, Hash)>] PurgeResponse
data, response status code and response headers