Module types

Types for interacting with S2 services.

Structs

AppendInput

Input for append requests.

AppendOutput

Output from append response.

AppendRecord

Record to be appended to a stream.

AppendRecordBatch

A collection of append records that can be sent together in a batch.

AppendRecordParts

Record to be appended to a stream.

BasinConfig

Basin configuration.

BasinInfo

Basin information.

BasinName

Name of a basin.

CommandRecord

A command record is a special kind of AppendRecord that can be used to send command messages.

ConvertError

Error related to conversion from one type to another.

CreateBasinRequest

Create basin request.

CreateStreamRequest

Create stream request.

DeleteBasinRequest

Delete basin request.

DeleteStreamRequest

Delete stream request.

FencingToken

A fencing token can be enforced on append requests.

Header

Headers add structured information to a record as name-value pairs.

ListBasinsRequest

List basins request.

ListBasinsResponse

List basins response.

ListStreamsRequest

List streams request.

ListStreamsResponse

List streams response.

ReadLimit

If both count and bytes are specified, either limit may be hit.

ReadRequest

Read request.

ReadSessionRequest

Read session request.

ReconfigureBasinRequest

Reconfigure basin request.

ReconfigureStreamRequest

Reconfigure stream request.

SequencedRecord

Record retrieved from a stream.

SequencedRecordBatch

A batch of sequenced records.

StreamConfig

Stream configuration.

StreamInfo

Stream information.

Enums

BasinScope

Basin scope.

BasinState

Current state of the basin.

Command

Command to send through a CommandRecord.

ReadOutput

Reply which can be a batch of records, or a sequence number if the request could not be satisfied.

RetentionPolicy

Retention policy for the stream. If unspecified, the default is to retain records for 7 days.

StorageClass

Storage class for recent writes.

Traits

MeteredBytes

Metered size of the object in bytes.