class Fastly::DictionaryInfoApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/fastly/api/dictionary_info_api.rb, line 17
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

get_dictionary_info(opts = {}) click to toggle source

Get edge dictionary metadata Retrieve metadata for a single dictionary by ID for a version and service. @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] :dictionary_id Alphanumeric string identifying a Dictionary. (required) @return [DictionaryInfoResponse]

# 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 = {}) click to toggle source

Get edge dictionary metadata Retrieve metadata for a single dictionary by ID for a version and service. @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] :dictionary_id Alphanumeric string identifying a Dictionary. (required) @return [Array<(DictionaryInfoResponse, Integer, Hash)>] DictionaryInfoResponse data, response status code and response headers

# 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