Class BatchGetItemResponse

Namespace

DynaSharp.Requests

Assembly

DynaSharp.dll

The result of BatchGetItemRequest: the items that were read and the keys that were not.

public sealed record BatchGetItemResponse : IEquatable<BatchGetItemResponse>

Inheritance

object

BatchGetItemResponse

Implements

IEquatable<BatchGetItemResponse>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Remarks

A successful call can be a partial result. DynamoDB stops at 16 MB, at 1 MB per partition, when a table is throttled or when it fails internally for some of the keys, and returns the keys it did not read in UnprocessedKeys. The caller must send those keys again (RequestItems accepts the map as it is), preferably after a growing wait. A call fails as a whole only when none of the keys could be processed.

Constructors

BatchGetItemResponse()

public BatchGetItemResponse()

Properties

ConsumedCapacity

Gets the read capacity consumed, one entry per table, when the request asked for it. Empty otherwise; never null.

public IReadOnlyList<ConsumedCapacity> ConsumedCapacity { get; init; }

Property Value

IReadOnlyList<ConsumedCapacity>

Responses

Gets the items that were read, by table name (or table ARN) as in the request. Items come in no particular order. A requested key without an item contributes nothing, and a table without any item found can be missing; the map is empty when nothing was found. Never null. The collections are read-only; do not cast them to change them.

public IReadOnlyDictionary<string, IReadOnlyList<IReadOnlyDictionary<string, AttributeValue>>> Responses { get; init; }

Property Value

IReadOnlyDictionary<string, IReadOnlyList<IReadOnlyDictionary<string, AttributeValue>>>

UnprocessedKeys

Gets the keys that were not read, in the form of the request, so that they can be sent as RequestItems. Empty when everything was read; never null.

public IReadOnlyDictionary<string, KeysAndAttributes> UnprocessedKeys { get; init; }

Property Value

IReadOnlyDictionary<string, KeysAndAttributes>

Methods

Equals(BatchGetItemResponse?)

public bool Equals(BatchGetItemResponse? other)

Parameters

other BatchGetItemResponse

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

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

Parameters

left BatchGetItemResponse

right BatchGetItemResponse

Returns

bool

operator !=(BatchGetItemResponse?, BatchGetItemResponse?)

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

Parameters

left BatchGetItemResponse

right BatchGetItemResponse

Returns

bool