Skip to content

Latest commit

 

History

History
367 lines (265 loc) · 12 KB

KvStoreItemApi.md

File metadata and controls

367 lines (265 loc) · 12 KB
Raw

fastly.KvStoreItemApi

Note

All URIs are relative to https://api.fastly.com

Method HTTP request Description
delete_key_from_store DELETE /resources/stores/kv/{store_id}/keys/{key_name} Delete kv store item.
get_keys GET /resources/stores/kv/{store_id}/keys List kv store keys.
get_value_for_key GET /resources/stores/kv/{store_id}/keys/{key_name} Get the value of an kv store item
set_value_for_key PUT /resources/stores/kv/{store_id}/keys/{key_name} Insert an item into an kv store

delete_key_from_store

delete_key_from_store(store_id, key_name)

Delete kv store item.

Delete an item from an kv store

Example

  • Api Key Authentication (token):
import time
import fastly
from fastly.api import kv_store_item_api
from pprint import pprint
# Defining the host is optional and defaults to https://api.fastly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = fastly.Configuration(
    host = "https://api.fastly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: token
configuration.api_key['token'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['token'] = 'Bearer'

# Enter a context with an instance of the API client
with fastly.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kv_store_item_api.KvStoreItemApi(api_client)
    store_id = "store_id_example" # str | 
    key_name = "key_name_example" # str | 

    # example passing only required values which don't have defaults set
    try:
        # Delete kv store item.
        api_instance.delete_key_from_store(store_id, key_name)
    except fastly.ApiException as e:
        print("Exception when calling KvStoreItemApi->delete_key_from_store: %s\n" % e)

Parameters

Name Type Description Notes
store_id str
key_name str

Return type

void (empty response body)

Authorization

token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
204 No Content -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_keys

InlineResponse2004 get_keys(store_id)

List kv store keys.

List the keys of all items within an kv store.

Example

  • Api Key Authentication (token):
import time
import fastly
from fastly.api import kv_store_item_api
from fastly.model.inline_response2004 import InlineResponse2004
from pprint import pprint
# Defining the host is optional and defaults to https://api.fastly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = fastly.Configuration(
    host = "https://api.fastly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: token
configuration.api_key['token'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['token'] = 'Bearer'

# Enter a context with an instance of the API client
with fastly.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kv_store_item_api.KvStoreItemApi(api_client)
    store_id = "store_id_example" # str | 
    cursor = "cursor_example" # str |  (optional)
    limit = 100 # int |  (optional) if omitted the server will use the default value of 100
    prefix = "prefix_example" # str |  (optional)

    # example passing only required values which don't have defaults set
    try:
        # List kv store keys.
        api_response = api_instance.get_keys(store_id)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling KvStoreItemApi->get_keys: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # List kv store keys.
        api_response = api_instance.get_keys(store_id, cursor=cursor, limit=limit, prefix=prefix)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling KvStoreItemApi->get_keys: %s\n" % e)

Parameters

Name Type Description Notes
store_id str
cursor str [optional]
limit int [optional] if omitted the server will use the default value of 100
prefix str [optional]

Return type

InlineResponse2004

Authorization

token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_value_for_key

str get_value_for_key(store_id, key_name)

Get the value of an kv store item

Get the value associated with a key.

Example

  • Api Key Authentication (token):
import time
import fastly
from fastly.api import kv_store_item_api
from pprint import pprint
# Defining the host is optional and defaults to https://api.fastly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = fastly.Configuration(
    host = "https://api.fastly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: token
configuration.api_key['token'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['token'] = 'Bearer'

# Enter a context with an instance of the API client
with fastly.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kv_store_item_api.KvStoreItemApi(api_client)
    store_id = "store_id_example" # str | 
    key_name = "key_name_example" # str | 

    # example passing only required values which don't have defaults set
    try:
        # Get the value of an kv store item
        api_response = api_instance.get_value_for_key(store_id, key_name)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling KvStoreItemApi->get_value_for_key: %s\n" % e)

Parameters

Name Type Description Notes
store_id str
key_name str

Return type

str

Authorization

token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/octet-stream

HTTP response details

Status code Description Response headers
200 OK * generation - A unique, non-serial 32-bit integer that can be used for testing against a specific kv store value.
* metadata - An arbitrary data field which can contain up to 2000B of data

[Back to top] [Back to API list] [Back to Model list] [Back to README]

set_value_for_key

str set_value_for_key(store_id, key_name)

Insert an item into an kv store

Set a new value for a new or existing key in an kv store.

Example

  • Api Key Authentication (token):
import time
import fastly
from fastly.api import kv_store_item_api
from pprint import pprint
# Defining the host is optional and defaults to https://api.fastly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = fastly.Configuration(
    host = "https://api.fastly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: token
configuration.api_key['token'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['token'] = 'Bearer'

# Enter a context with an instance of the API client
with fastly.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kv_store_item_api.KvStoreItemApi(api_client)
    store_id = "store_id_example" # str | 
    key_name = "key_name_example" # str | 
    if_generation_match = 1 # int |  (optional)
    time_to_live_sec = 1 # int |  (optional)
    metadata = "metadata_example" # str |  (optional)
    add = True # bool |  (optional)
    append = True # bool |  (optional)
    prepend = True # bool |  (optional)
    background_fetch = True # bool |  (optional)
    body = 'YQ==' # str |  (optional)

    # example passing only required values which don't have defaults set
    try:
        # Insert an item into an kv store
        api_response = api_instance.set_value_for_key(store_id, key_name)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling KvStoreItemApi->set_value_for_key: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Insert an item into an kv store
        api_response = api_instance.set_value_for_key(store_id, key_name, if_generation_match=if_generation_match, time_to_live_sec=time_to_live_sec, metadata=metadata, add=add, append=append, prepend=prepend, background_fetch=background_fetch, body=body)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling KvStoreItemApi->set_value_for_key: %s\n" % e)

Parameters

Name Type Description Notes
store_id str
key_name str
if_generation_match int [optional]
time_to_live_sec int [optional]
metadata str [optional]
add bool [optional]
append bool [optional]
prepend bool [optional]
background_fetch bool [optional]
body str [optional]

Return type

str

Authorization

token

HTTP request headers

  • Content-Type: application/octet-stream
  • Accept: application/octet-stream

HTTP response details

Status code Description Response headers
200 OK * generation - A unique, non-serial 32-bit integer that can be used for testing against a specific kv store value.
* metadata - An arbitrary data field which can contain up to 2000B of data

[Back to top] [Back to API list] [Back to Model list] [Back to README]