Class StreamDescription

Namespace

DynaSharp.Streams

Assembly

DynaSharp.dll

The settings of a stream and one page of its shards.

public sealed record StreamDescription : IEquatable<StreamDescription>

Inheritance

object

StreamDescription

Implements

IEquatable<StreamDescription>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

StreamDescription()

public StreamDescription()

Properties

CreationRequestDateTime

Gets when the stream was requested. DynamoDB sends it with every description: null only if the response omits it.

public DateTimeOffset? CreationRequestDateTime { get; init; }

Property Value

DateTimeOffset?

KeySchema

Gets the primary key of the table: the partition key, followed by the sort key if there is one.

public IReadOnlyList<KeySchemaElement> KeySchema { get; init; }

Property Value

IReadOnlyList<KeySchemaElement>

LastEvaluatedShardId

Gets the identifier of the last shard of this page, to pass as ExclusiveStartShardId to get the next page. null on the last page, and only then: a page with fewer shards than the limit can still have a successor.

public string? LastEvaluatedShardId { get; init; }

Property Value

string

Shards

Gets one page of the shards, up to 100. Empty when the stream has none. Shards that have been read completely are not removed from the list at once; check EndingSequenceNumber to tell open from closed shards.

public IReadOnlyList<Shard> Shards { get; init; }

Property Value

IReadOnlyList<Shard>

StreamArn

Gets the ARN of the stream. DynamoDB sends it with every description: null only if the response omits it.

public string? StreamArn { get; init; }

Property Value

string

StreamLabel

Gets the label of the stream: a timestamp of its creation. DynamoDB sends it with every description: null only if the response omits it.

public string? StreamLabel { get; init; }

Property Value

string

StreamStatus

Gets the state of the stream. Records can be read only from an Enabled stream or a recently disabled one.

public StreamStatus StreamStatus { get; init; }

Property Value

StreamStatus

StreamViewType

Gets what the records of the stream contain.

public StreamViewType StreamViewType { get; init; }

Property Value

StreamViewType

TableName

Gets the name of the table the stream belongs to. DynamoDB sends it with every description: null only if the response omits it.

public string? TableName { get; init; }

Property Value

string

Methods

Equals(StreamDescription?)

public bool Equals(StreamDescription? other)

Parameters

other StreamDescription

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

ToString()

public override string ToString()

Returns

string

Operators

operator ==(StreamDescription?, StreamDescription?)

public static bool operator ==(StreamDescription? left, StreamDescription? right)

Parameters

left StreamDescription

right StreamDescription

Returns

bool

operator !=(StreamDescription?, StreamDescription?)

public static bool operator !=(StreamDescription? left, StreamDescription? right)

Parameters

left StreamDescription

right StreamDescription

Returns

bool