class Fastly::KvStoreItemApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

delete_key_from_store(opts = {}) click to toggle source

Delete kv store item. Delete an item from an kv store @option opts [String] :store_id (required) @option opts [String] :key_name (required) @return [nil]

# File lib/fastly/api/kv_store_item_api.rb, line 25
def delete_key_from_store(opts = {})
  delete_key_from_store_with_http_info(opts)
  nil
end
delete_key_from_store_with_http_info(opts = {}) click to toggle source

Delete kv store item. Delete an item from an kv store @option opts [String] :store_id (required) @option opts [String] :key_name (required) @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# File lib/fastly/api/kv_store_item_api.rb, line 35
def delete_key_from_store_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KvStoreItemApi.delete_key_from_store ...'
  end
  # unbox the parameters from the hash
  store_id = opts[:'store_id']
  key_name = opts[:'key_name']
  # verify the required parameter 'store_id' is set
  if @api_client.config.client_side_validation && store_id.nil?
    fail ArgumentError, "Missing the required parameter 'store_id' when calling KvStoreItemApi.delete_key_from_store"
  end
  # verify the required parameter 'key_name' is set
  if @api_client.config.client_side_validation && key_name.nil?
    fail ArgumentError, "Missing the required parameter 'key_name' when calling KvStoreItemApi.delete_key_from_store"
  end
  # resource path
  local_var_path = '/resources/stores/kv/{store_id}/keys/{key_name}'.sub('{' + 'store_id' + '}', CGI.escape(store_id.to_s)).sub('{' + 'key_name' + '}', CGI.escape(key_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"KvStoreItemApi.delete_key_from_store",
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: KvStoreItemApi#delete_key_from_store\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_keys(opts = {}) click to toggle source

List kv store keys. List the keys of all items within an kv store. @option opts [String] :store_id (required) @option opts [String] :cursor @option opts [Integer] :limit (default to 100) @option opts [String] :prefix @return [InlineResponse2004]

# File lib/fastly/api/kv_store_item_api.rb, line 95
def get_keys(opts = {})
  data, _status_code, _headers = get_keys_with_http_info(opts)
  data
end
get_keys_with_http_info(opts = {}) click to toggle source

List kv store keys. List the keys of all items within an kv store. @option opts [String] :store_id (required) @option opts [String] :cursor @option opts [Integer] :limit (default to 100) @option opts [String] :prefix @return [Array<(InlineResponse2004, Integer, Hash)>] InlineResponse2004 data, response status code and response headers

# File lib/fastly/api/kv_store_item_api.rb, line 107
def get_keys_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KvStoreItemApi.get_keys ...'
  end
  # unbox the parameters from the hash
  store_id = opts[:'store_id']
  # verify the required parameter 'store_id' is set
  if @api_client.config.client_side_validation && store_id.nil?
    fail ArgumentError, "Missing the required parameter 'store_id' when calling KvStoreItemApi.get_keys"
  end
  # resource path
  local_var_path = '/resources/stores/kv/{store_id}/keys'.sub('{' + 'store_id' + '}', CGI.escape(store_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'prefix'] = opts[:'prefix'] if !opts[:'prefix'].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] || 'InlineResponse2004'

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

  new_options = opts.merge(
    :operation => :"KvStoreItemApi.get_keys",
    :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: KvStoreItemApi#get_keys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_value_for_key(opts = {}) click to toggle source

Get the value of an kv store item Get the value associated with a key. @option opts [String] :store_id (required) @option opts [String] :key_name (required) @return [String]

# File lib/fastly/api/kv_store_item_api.rb, line 165
def get_value_for_key(opts = {})
  data, _status_code, _headers = get_value_for_key_with_http_info(opts)
  data
end
get_value_for_key_with_http_info(opts = {}) click to toggle source

Get the value of an kv store item Get the value associated with a key. @option opts [String] :store_id (required) @option opts [String] :key_name (required) @return [Array<(String, Integer, Hash)>] String data, response status code and response headers

# File lib/fastly/api/kv_store_item_api.rb, line 175
def get_value_for_key_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KvStoreItemApi.get_value_for_key ...'
  end
  # unbox the parameters from the hash
  store_id = opts[:'store_id']
  key_name = opts[:'key_name']
  # verify the required parameter 'store_id' is set
  if @api_client.config.client_side_validation && store_id.nil?
    fail ArgumentError, "Missing the required parameter 'store_id' when calling KvStoreItemApi.get_value_for_key"
  end
  # verify the required parameter 'key_name' is set
  if @api_client.config.client_side_validation && key_name.nil?
    fail ArgumentError, "Missing the required parameter 'key_name' when calling KvStoreItemApi.get_value_for_key"
  end
  # resource path
  local_var_path = '/resources/stores/kv/{store_id}/keys/{key_name}'.sub('{' + 'store_id' + '}', CGI.escape(store_id.to_s)).sub('{' + 'key_name' + '}', CGI.escape(key_name.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/octet-stream'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'String'

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

  new_options = opts.merge(
    :operation => :"KvStoreItemApi.get_value_for_key",
    :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: KvStoreItemApi#get_value_for_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
set_value_for_key(opts = {}) click to toggle source

Insert an item into an kv store Set a new value for a new or existing key in an kv store. @option opts [String] :store_id (required) @option opts [String] :key_name (required) @option opts [Integer] :if_generation_match @option opts [Integer] :time_to_live_sec @option opts [String] :metadata @option opts [Boolean] :add @option opts [Boolean] :append @option opts [Boolean] :prepend @option opts [Boolean] :background_fetch @option opts [String] :body @return [String]

# File lib/fastly/api/kv_store_item_api.rb, line 243
def set_value_for_key(opts = {})
  data, _status_code, _headers = set_value_for_key_with_http_info(opts)
  data
end
set_value_for_key_with_http_info(opts = {}) click to toggle source

Insert an item into an kv store Set a new value for a new or existing key in an kv store. @option opts [String] :store_id (required) @option opts [String] :key_name (required) @option opts [Integer] :if_generation_match @option opts [Integer] :time_to_live_sec @option opts [String] :metadata @option opts [Boolean] :add @option opts [Boolean] :append @option opts [Boolean] :prepend @option opts [Boolean] :background_fetch @option opts [String] :body @return [Array<(String, Integer, Hash)>] String data, response status code and response headers

# File lib/fastly/api/kv_store_item_api.rb, line 261
def set_value_for_key_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KvStoreItemApi.set_value_for_key ...'
  end
  # unbox the parameters from the hash
  store_id = opts[:'store_id']
  key_name = opts[:'key_name']
  # verify the required parameter 'store_id' is set
  if @api_client.config.client_side_validation && store_id.nil?
    fail ArgumentError, "Missing the required parameter 'store_id' when calling KvStoreItemApi.set_value_for_key"
  end
  # verify the required parameter 'key_name' is set
  if @api_client.config.client_side_validation && key_name.nil?
    fail ArgumentError, "Missing the required parameter 'key_name' when calling KvStoreItemApi.set_value_for_key"
  end
  # resource path
  local_var_path = '/resources/stores/kv/{store_id}/keys/{key_name}'.sub('{' + 'store_id' + '}', CGI.escape(store_id.to_s)).sub('{' + 'key_name' + '}', CGI.escape(key_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'add'] = opts[:'add'] if !opts[:'add'].nil?
  query_params[:'append'] = opts[:'append'] if !opts[:'append'].nil?
  query_params[:'prepend'] = opts[:'prepend'] if !opts[:'prepend'].nil?
  query_params[:'background_fetch'] = opts[:'background_fetch'] if !opts[:'background_fetch'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/octet-stream'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'if-generation-match'] = opts[:'if_generation_match'] if !opts[:'if_generation_match'].nil?
  header_params[:'time_to_live_sec'] = opts[:'time_to_live_sec'] if !opts[:'time_to_live_sec'].nil?
  header_params[:'metadata'] = opts[:'metadata'] if !opts[:'metadata'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'body'])

  # return_type
  return_type = opts[:debug_return_type] || 'String'

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

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