S2 ListStreams

S2 ListStreams

Certified

List S2 streams

Lists streams in an S2 basin with optional prefix filtering and pagination.

yaml
type: io.kestra.plugin.s2.ListStreams

List streams

yaml
id: list_streams
namespace: company.team

tasks:
  - id: list
    type: io.kestra.plugin.s2.ListStreams
    accessToken: "{{ secret('S2_ACCESS_TOKEN') }}"
    basin: my-basin
    limit: 100
Properties

S2 access token

Access token used to authenticate with S2

S2 basin

S2 basin containing the streams

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
Defaulthttps://{basin}.b.s2.dev/v1

Basin endpoint

S2 basin API endpoint. The {basin} placeholder is replaced by the basin name. When the endpoint has no placeholder, the basin is sent in the S2-Basin header, which is how a custom endpoint such as s2-lite is addressed.

Default1000

Limit

Maximum number of streams to return.

Prefix

Filters streams whose names begin with this prefix.

Start after

Returns streams whose names are lexicographically after this value.

Has more

Whether more streams are available after this page.

Streams

The streams returned by S2, ordered by name.

Definitions
cipherstring

Encryption cipher

Cipher used to encrypt the stream, if any.

createdAtstring

Creation time

Time the stream was created.

deletedAtstring

Deletion time

Time the stream was marked for deletion, if any.

namestring

Stream name

Name of the stream.