class Fastly::KvStoreApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

create_store(opts = {}) click to toggle source

Create a KV store. Create a new KV store. @option opts [String] :location @option opts [Store] :store @return [StoreResponse]

# File lib/fastly/api/kv_store_api.rb, line 25
def create_store(opts = {})
  data, _status_code, _headers = create_store_with_http_info(opts)
  data
end
create_store_with_http_info(opts = {}) click to toggle source

Create a KV store. Create a new KV store. @option opts [String] :location @option opts [Store] :store @return [Array<(StoreResponse, Integer, Hash)>] StoreResponse data, response status code and response headers

# File lib/fastly/api/kv_store_api.rb, line 35
def create_store_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KvStoreApi.create_store ...'
  end
  # unbox the parameters from the hash
  # resource path
  local_var_path = '/resources/stores/kv'

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

  # 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

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

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

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

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

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

Delete a KV store. A KV store must be empty before it can be deleted. Deleting a KV store that still contains keys will result in a ‘409` (Conflict). @option opts [String] :store_id (required) @return [nil]

# File lib/fastly/api/kv_store_api.rb, line 90
def delete_store(opts = {})
  delete_store_with_http_info(opts)
  nil
end
delete_store_with_http_info(opts = {}) click to toggle source

Delete a KV store. A KV store must be empty before it can be deleted. Deleting a KV store that still contains keys will result in a &#x60;409&#x60; (Conflict). @option opts [String] :store_id (required) @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# File lib/fastly/api/kv_store_api.rb, line 99
def delete_store_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KvStoreApi.delete_store ...'
  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 KvStoreApi.delete_store"
  end
  # resource path
  local_var_path = '/resources/stores/kv/{store_id}'.sub('{' + 'store_id' + '}', CGI.escape(store_id.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 => :"KvStoreApi.delete_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: KvStoreApi#delete_store\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_store(opts = {}) click to toggle source

Describe a KV store. Get a KV store by ID. @option opts [String] :store_id (required) @return [StoreResponse]

# File lib/fastly/api/kv_store_api.rb, line 151
def get_store(opts = {})
  data, _status_code, _headers = get_store_with_http_info(opts)
  data
end
get_store_with_http_info(opts = {}) click to toggle source

Describe a KV store. Get a KV store by ID. @option opts [String] :store_id (required) @return [Array<(StoreResponse, Integer, Hash)>] StoreResponse data, response status code and response headers

# File lib/fastly/api/kv_store_api.rb, line 160
def get_store_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KvStoreApi.get_store ...'
  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 KvStoreApi.get_store"
  end
  # resource path
  local_var_path = '/resources/stores/kv/{store_id}'.sub('{' + 'store_id' + '}', CGI.escape(store_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] || 'StoreResponse'

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

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

List KV stores. Get all stores for a given customer. @option opts [String] :cursor @option opts [Integer] :limit (default to 1000) @return [InlineResponse2003]

# File lib/fastly/api/kv_store_api.rb, line 215
def get_stores(opts = {})
  data, _status_code, _headers = get_stores_with_http_info(opts)
  data
end
get_stores_with_http_info(opts = {}) click to toggle source

List KV stores. Get all stores for a given customer. @option opts [String] :cursor @option opts [Integer] :limit (default to 1000) @return [Array<(InlineResponse2003, Integer, Hash)>] InlineResponse2003 data, response status code and response headers

# File lib/fastly/api/kv_store_api.rb, line 225
def get_stores_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KvStoreApi.get_stores ...'
  end
  # unbox the parameters from the hash
  # resource path
  local_var_path = '/resources/stores/kv'

  # 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?

  # 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] || 'InlineResponse2003'

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

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