/ 
WebService-Fastly-4.02
River stage zero No dependents
⭐ Starred 18 GitHub stars
/ docs/KvStoreItemApi.md

WebService::Fastly::KvStoreItemApi

Load the API package

use WebService::Fastly::Object::KvStoreItemApi;

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 => $store_id, key_name => $key_name)

Delete kv store item.

Delete an item from an kv store

Example

use Data::Dumper;
use WebService::Fastly::KvStoreItemApi;
my $api_instance = WebService::Fastly::KvStoreItemApi->new(

    # Configure API key authorization: token
    api_key => {'Fastly-Key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Fastly-Key' => 'Bearer'},
);

my $store_id = "store_id_example"; # string | 
my $key_name = "key_name_example"; # string | 

eval {
    $api_instance->delete_key_from_store(store_id => $store_id, key_name => $key_name);
};
if ($@) {
    warn "Exception when calling KvStoreItemApi->delete_key_from_store: $@\n";
}

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- store_id | string| | key_name | string| |

Return type

void (empty response body)

Authorization

token

HTTP request headers

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

get_keys

InlineResponse2004 get_keys(store_id => $store_id, cursor => $cursor, limit => $limit, prefix => $prefix)

List kv store keys.

List the keys of all items within an kv store.

Example

use Data::Dumper;
use WebService::Fastly::KvStoreItemApi;
my $api_instance = WebService::Fastly::KvStoreItemApi->new(

    # Configure API key authorization: token
    api_key => {'Fastly-Key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Fastly-Key' => 'Bearer'},
);

my $store_id = "store_id_example"; # string | 
my $cursor = "cursor_example"; # string | 
my $limit = 100; # int | 
my $prefix = "prefix_example"; # string | 

eval {
    my $result = $api_instance->get_keys(store_id => $store_id, cursor => $cursor, limit => $limit, prefix => $prefix);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KvStoreItemApi->get_keys: $@\n";
}

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- store_id | string| | cursor | string| | [optional] limit | int| | [optional] [default to 100] prefix | string| | [optional]

Return type

InlineResponse2004

Authorization

token

HTTP request headers

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

get_value_for_key

string get_value_for_key(store_id => $store_id, key_name => $key_name)

Get the value of an kv store item

Get the value associated with a key.

Example

use Data::Dumper;
use WebService::Fastly::KvStoreItemApi;
my $api_instance = WebService::Fastly::KvStoreItemApi->new(

    # Configure API key authorization: token
    api_key => {'Fastly-Key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Fastly-Key' => 'Bearer'},
);

my $store_id = "store_id_example"; # string | 
my $key_name = "key_name_example"; # string | 

eval {
    my $result = $api_instance->get_value_for_key(store_id => $store_id, key_name => $key_name);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KvStoreItemApi->get_value_for_key: $@\n";
}

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- store_id | string| | key_name | string| |

Return type

string

Authorization

token

HTTP request headers

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

set_value_for_key

string set_value_for_key(store_id => $store_id, key_name => $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)

Insert an item into an kv store

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

Example

use Data::Dumper;
use WebService::Fastly::KvStoreItemApi;
my $api_instance = WebService::Fastly::KvStoreItemApi->new(

    # Configure API key authorization: token
    api_key => {'Fastly-Key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Fastly-Key' => 'Bearer'},
);

my $store_id = "store_id_example"; # string | 
my $key_name = "key_name_example"; # string | 
my $if_generation_match = 56; # int | 
my $time_to_live_sec = 56; # int | 
my $metadata = "metadata_example"; # string | 
my $add = null; # boolean | 
my $append = null; # boolean | 
my $prepend = null; # boolean | 
my $background_fetch = null; # boolean | 
my $body = WebService::Fastly::Object::string->new(); # string | 

eval {
    my $result = $api_instance->set_value_for_key(store_id => $store_id, key_name => $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);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KvStoreItemApi->set_value_for_key: $@\n";
}

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- store_id | string| | key_name | string| | if_generation_match | int| | [optional] time_to_live_sec | int| | [optional] metadata | string| | [optional] add | boolean| | [optional] append | boolean| | [optional] prepend | boolean| | [optional] background_fetch | boolean| | [optional] body | string| | [optional]

Return type

string

Authorization

token

HTTP request headers

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