CreateBucket

type: "io.kestra.plugin.nats.kv.CreateBucket"

Creates Key/Value bucket in NATS.

Examples

Creates a new Key/Value bucket, with all required properties

id: "create_bucket"
type: "io.kestra.plugin.nats.kv.CreateBucket"
url: nats://localhost:4222
username: nats_user
password: nats_passwd
name: my_bucket

Creates a new Key/Value bucket

id: "create_bucket"
type: "io.kestra.plugin.nats.kv.CreateBucket"
url: nats://localhost:4222
username: nats_user
password: nats_passwd
name: my_bucket
description: my bucket for special purposes
historyPerKey: 2
bucketSize: 1024
valueSize: 1024
metadata: {"key1":"value1","key2":"value2"}

Properties

name

• Type: string
• Dynamic: ✔️
• Required: ✔️
• Min length: 1

The name of the key value bucket.

url

• Type: string
• Dynamic: ✔️
• Required: ✔️
• Min length: 1

URL to connect to NATS server

The format is (nats://)server_url:port. You can also provide a connection token like so: nats://token@server_url:port

bucketSize

• Type: integer
• Dynamic: ❓
• Required: ❌

The maximum size in bytes for this bucket.

description

• Type: string
• Dynamic: ✔️
• Required: ❌

the description of the key value bucket

historyPerKey

• Type: integer
• Dynamic: ❌
• Required: ❌
• Default: 1

The maximum number of history for a key.

metadata

• Type: object
• SubType: string
• Dynamic: ✔️
• Required: ❌

the metadata of the key value bucket

password

• Type: string
• Dynamic: ✔️
• Required: ❌

Plaintext authentication password

username

• Type: string
• Dynamic: ✔️
• Required: ❌

Plaintext authentication username

valueSize

• Type: integer
• Dynamic: ❓
• Required: ❌

The maximum size in bytes for an individual value in the bucket.

Outputs

bucket

• Type: string
• Required: ❌

The name of the key value bucket.

bucketSize

• Type: integer
• Required: ❌
• Default: 0

The maximum size in bytes for this bucket.

description

• Type: string
• Required: ❌

The description of the bucket.

entryCount

• Type: integer
• Required: ❌
• Default: 0

The number of total entries in the bucket, including historical entries.

history

• Type: integer
• Required: ❌
• Default: 0

The maximum number of history for a key.

metadata

• Type: object
• SubType: string
• Required: ❌

The metadata for the store

valueSize

• Type: integer
• Required: ❌
• Default: 0

The maximum size in bytes for an individual value in the bucket.

Definitions