Get Get

yaml
type: "io.kestra.plugin.core.state.Get"

Get a state from the state store.

Examples

Get the default state file for the current flow.

yaml
id: get_state
type: io.kestra.plugin.core.state.Get

Get the myState state for the current flow.

yaml
id: get_state
type: io.kestra.plugin.core.state.Get
name: myState

Properties

name

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️
  • Default: default

The name of the state file.

errorOnMissing

  • Type: boolean
  • Dynamic: ✔️
  • Required:
  • Default: false

Raise an error if the state file is not found.

namespace

  • Type: boolean
  • Dynamic: ✔️
  • Required:
  • Default: false

Share state for the current namespace.

By default, the state is isolated by namespace and flow, setting to true will allow to share the state between the same namespace

taskrunValue

  • Type: boolean
  • Dynamic: ✔️
  • Required:
  • Default: true

Isolate the state with taskrun.value.

By default, the state will be isolated with taskrun.value (during iteration with each). Setting to false will allow using the same state for every run of the iteration.

Outputs

count

  • Type: integer
  • Required:
  • Default: 0

The count of properties found in the state.

data

  • Type: object
  • Required:

The data extracted from the state.

Definitions

Was this page helpful?