stream

A stream is the central resource in Stream Machine. Clients can connect to a stream to send and to receive events. A stream can be either a "source stream" or a "derived stream".

Events are always sent to a source stream. Sending events to a derived stream is not possible. After validation and encryption of all PII fields, Stream Machine sends all events to the source stream. Clients consuming from the source stream will see all events, but with all PII fields encrypted.

Derived streams can be made on top of a source stream. A derived stream is configured with one or more consent levels and it only receives events with matching consent levels (see details about this matching process here). The PII fields with matching consent levels are decrypted and sent to the derived stream. Clients connecting to the derived stream will only receive the events on this stream.

Every stream has its own set of access tokens. Connecting to a source stream requires different credentials than when connecting to a derived stream.

create

Create a new Stream.

Usage

Create a Source Stream: strm create stream [stream-name] [flags]

Create a Derived Stream: strm create stream --derived-from=[source-stream-name] [flags]

Options

Option Description

stream-name

The name of this stream.

Flags

Flag Alias Description

--consent-type string

Optional for Derived Streams: CUMULATIVE or GRANULAR (default "CUMULATIVE")

--derived-from string

-D

Required for Derived Streams: name of stream that this stream is derived from

--description string

The description, for human purposes only

--levels int32Slice

-L

Required for Derived Streams: Comma separated list of integers for derived streams (default [])

--tags strings

Optional: Tags, for human purposes only

See Global flags for all global flags.

delete

Delete a Stream by name.

Usage

strm delete stream [name] [flags].

Options

Option Description

name

The name of the Stream.

Flags

--recursive is supported to also delete the dependent Kafka Exporters, Batch Exporters and Derived Streams.

No specific flags. See Global flags.

get

Get a Stream by name.

Usage

strm get stream [name] [flags].

Options

Option Description

name

The name of the Stream.

Flags

--recursive is supported to also list the dependent Kafka Exporters, Batch Exporters and Derived Streams.

No specific flags. See Global flags.

list

List Streams.

Usage

strm list streams [flags].

Options

No options

Flags

--recursive is supported to also list the dependent Kafka Exporters, Batch Exporters and Derived Streams.

No specific flags. See Global flags.