Class: Fastly::ContentApi

Inherits:
Object
  • Object
show all
Defined in:
lib/fastly/api/content_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ContentApi

Returns a new instance of ContentApi.



17
18
19
 
# File 'lib/fastly/api/content_api.rb', line 17

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



15
16
17
 
# File 'lib/fastly/api/content_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#content_check(opts = {}) ⇒ Array<Content>

Check status of content in each POP’s cache Retrieve headers and MD5 hash of the content for a particular URL from each Fastly edge server. This API is limited to 200 requests per hour. If the content takes too long to download, the hash will be set to ‘error-timeout-$pop`. If the response is too large, it will be set to `warning-too-large-$pop`.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :url (String) —

    Full URL (host and path) to check on all nodes. if protocol is omitted, http will be assumed.

Returns:



24
25
26
27
 
# File 'lib/fastly/api/content_api.rb', line 24

def content_check(opts = {})
  data, _status_code, _headers = content_check_with_http_info(opts)
  data
end

#content_check_with_http_info(opts = {}) ⇒ Array<(Array<Content>, Integer, Hash)>

Check status of content in each POP&#39;s cache Retrieve headers and MD5 hash of the content for a particular URL from each Fastly edge server. This API is limited to 200 requests per hour. If the content takes too long to download, the hash will be set to &#x60;error-timeout-$pop&#x60;. If the response is too large, it will be set to &#x60;warning-too-large-$pop&#x60;.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :url (String) —

    Full URL (host and path) to check on all nodes. if protocol is omitted, http will be assumed.

Returns:

  • (Array<(Array<Content>, Integer, Hash)>) —

    Array<Content> data, response status code and response headers



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/fastly/api/content_api.rb', line 33

def content_check_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentApi.content_check ...'
  end
  # unbox the parameters from the hash
  # resource path
  local_var_path = '/content/edge_check'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'url'] = opts[:'url'] if !opts[:'url'].nil?

  # 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<Content>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"ContentApi.content_check",
    :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: ContentApi#content_check\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end