class Amazonite::DynamoDB::BatchGetItemOutput

Overview

Represents the output of a BatchGetItem operation.

Included Modules

Defined in:

dynamodb/batch_get_item_output.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(responses : Hash(String, Array(Hash(String, AttributeValue))) | Nil = nil, unprocessed_keys : Hash(String, KeysAndAttributes) | Nil = nil, consumed_capacity : Array(ConsumedCapacity) | Nil = nil) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def consumed_capacity : Array(ConsumedCapacity) | Nil #

The read capacity units consumed by the entire BatchGetItem operation.

Each element consists of:

  • TableName - The table that consumed the provisioned throughput.

  • CapacityUnits - The total number of capacity units consumed.


[View source]
def consumed_capacity=(consumed_capacity : Array(ConsumedCapacity) | Nil) #

The read capacity units consumed by the entire BatchGetItem operation.

Each element consists of:

  • TableName - The table that consumed the provisioned throughput.

  • CapacityUnits - The total number of capacity units consumed.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def responses : Hash(String, Array(Hash(String, AttributeValue))) | Nil #

A map of table name or table ARN to a list of items. Each object in Responses consists of a table name or ARN, along with a map of attribute data consisting of the data type and attribute value.


[View source]
def responses=(responses : Hash(String, Array(Hash(String, AttributeValue))) | Nil) #

A map of table name or table ARN to a list of items. Each object in Responses consists of a table name or ARN, along with a map of attribute data consisting of the data type and attribute value.


[View source]
def unprocessed_keys : Hash(String, KeysAndAttributes) | Nil #

A map of tables and their respective keys that were not processed with the current response. The UnprocessedKeys value is in the same form as RequestItems, so the value can be provided directly to a subsequent BatchGetItem operation. For more information, see RequestItems in the Request Parameters section.

Each element consists of:

  • Keys - An array of primary key attribute values that define specific items in the table.

  • ProjectionExpression - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a requested attribute is not found, it does not appear in the result.

  • ConsistentRead - The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

If there are no unprocessed keys remaining, the response contains an empty UnprocessedKeys map.


[View source]
def unprocessed_keys=(unprocessed_keys : Hash(String, KeysAndAttributes) | Nil) #

A map of tables and their respective keys that were not processed with the current response. The UnprocessedKeys value is in the same form as RequestItems, so the value can be provided directly to a subsequent BatchGetItem operation. For more information, see RequestItems in the Request Parameters section.

Each element consists of:

  • Keys - An array of primary key attribute values that define specific items in the table.

  • ProjectionExpression - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a requested attribute is not found, it does not appear in the result.

  • ConsistentRead - The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

If there are no unprocessed keys remaining, the response contains an empty UnprocessedKeys map.


[View source]
def validate! : Nil #

[View source]