Class DescribeStreamRequest

Namespace

DynaSharp.Streams

Assembly

DynaSharp.dll

Reads the settings of a stream and its shards (DynamoDB Streams DescribeStream).

public sealed record DescribeStreamRequest : IEquatable<DescribeStreamRequest>

Inheritance

object

DescribeStreamRequest

Implements

IEquatable<DescribeStreamRequest>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Remarks

The shards come in pages of at most 100. Call again with LastEvaluatedShardId as ExclusiveStartShardId until it is null. A stream has a strict limit of 10 calls per second.

Constructors

DescribeStreamRequest()

public DescribeStreamRequest()

Properties

ExclusiveStartShardId

Gets the identifier of the last shard of the previous page: LastEvaluatedShardId of the previous response, unchanged.

public string? ExclusiveStartShardId { get; init; }

Property Value

string

Limit

Gets the maximum number of shards to return, at least 1; DynamoDB returns at most 100. null sends nothing.

public int? Limit { get; init; }

Property Value

int?

ShardFilter

Gets a filter on the shards, or null to list them all.

public ShardFilter? ShardFilter { get; init; }

Property Value

ShardFilter

StreamArn

Gets the ARN of the stream.

public required string StreamArn { get; init; }

Property Value

string

Methods

Equals(DescribeStreamRequest?)

public bool Equals(DescribeStreamRequest? other)

Parameters

other DescribeStreamRequest

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 ==(DescribeStreamRequest?, DescribeStreamRequest?)

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

Parameters

left DescribeStreamRequest

right DescribeStreamRequest

Returns

bool

operator !=(DescribeStreamRequest?, DescribeStreamRequest?)

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

Parameters

left DescribeStreamRequest

right DescribeStreamRequest

Returns

bool