Class: Fastly::DictionaryInfoApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DictionaryInfoApi 



17
18
19
 
# File 'lib/fastly/api/dictionary_info_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/dictionary_info_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#get_dictionary_info(opts = {}) ⇒ DictionaryInfoResponse

Get edge dictionary metadata Retrieve metadata for a single dictionary by ID for a version and service.

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :dictionary_id (String) —

    Alphanumeric string identifying a Dictionary. (required)



26
27
28
29
 
# File 'lib/fastly/api/dictionary_info_api.rb', line 26

def get_dictionary_info(opts = {})
  data, _status_code, _headers = get_dictionary_info_with_http_info(opts)
  data
end

#get_dictionary_info_with_http_info(opts = {}) ⇒ Array<(DictionaryInfoResponse, Integer, Hash)>

Get edge dictionary metadata Retrieve metadata for a single dictionary by ID for a version and service.

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :dictionary_id (String) —

    Alphanumeric string identifying a Dictionary. (required)



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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/fastly/api/dictionary_info_api.rb', line 37

def get_dictionary_info_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DictionaryInfoApi.get_dictionary_info ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  dictionary_id = opts[:'dictionary_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 DictionaryInfoApi.get_dictionary_info"
  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 DictionaryInfoApi.get_dictionary_info"
  end
  # verify the required parameter 'dictionary_id' is set
  if @api_client.config.client_side_validation && dictionary_id.nil?
    fail ArgumentError, "Missing the required parameter 'dictionary_id' when calling DictionaryInfoApi.get_dictionary_info"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/dictionary/{dictionary_id}/info'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'dictionary_id' + '}', CGI.escape(dictionary_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] || 'DictionaryInfoResponse'

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

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