delete_key¶
Operation¶
delete_key
¶
delete_key(request: DeleteKeyInput | DeleteKeyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteKeyInputDict]) -> DeleteKeyOutput
Deletes the key value pair specified by the key.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DeleteKeyInput | DeleteKeyInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[DeleteKeyInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DeleteKeyOutput
|
An instance of |
delete_key
async
¶
delete_key(request: DeleteKeyInput | DeleteKeyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteKeyInputDict]) -> DeleteKeyOutput
Deletes the key value pair specified by the key.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DeleteKeyInput | DeleteKeyInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[DeleteKeyInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DeleteKeyOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
DeleteKeyInput
dataclass
¶
Output¶
DeleteKeyOutput
dataclass
¶
Bases: _SerdeShape
Metadata information about a Key Value Store.
Attributes¶
e_tag
instance-attribute
¶
e_tag: str
The current version identifier of the Key Value Store after the successful delete.
item_count
instance-attribute
¶
item_count: int
Number of key value pairs in the Key Value Store after the successful delete.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.