Core Plugins and tasks Get

Core Plugins and tasks Get

Certified

Read a key-value entry.

Renders key/namespace (defaults to flow namespace) and fetches the value. In the same namespace it walks dot-delimited parents to support hierarchical lookup. Set errorOnMissing to true to fail when absent.

Respects namespace ACLs when reading other namespaces.

yaml
type: io.kestra.plugin.core.kv.Get

Get value for my_variable key in dev namespace and fail if it's not present. Note that you can accomplish the same using the kv() Pebble function, e.g. {{kv('my_variable')}}.

yaml
id: kv_store_get
namespace: company.team

tasks:
  - id: kv_get
    type: io.kestra.plugin.core.kv.Get
    key: my_variable
    namespace: company # the current namespace is used by default
    errorOnMissing: true
Properties

The key for which to get the value

Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset failure behavior

Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
Defaultfalse

Flag specifying whether to fail if there is no value for the given key

Default{{ flow.namespace }}

The namespace from which to retrieve the KV pair

Value retrieved for the key

This can be of any type and will stay the same as when it was set.