com.amazonaws.services.dynamodbv2.model

Class KeysAndAttributes

java.lang.Object

com.amazonaws.services.dynamodbv2.model.KeysAndAttributes

All Implemented Interfaces:

Serializable

public class KeysAndAttributes
extends Object
implements Serializable

Represents a set of primary keys and, for each key, the attributes to retrieve from the table.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
KeysAndAttributes()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<String>	getAttributesToGet() Represents one or more attributes to retrieve from the table or index.
Boolean	getConsistentRead() Represents the consistency of a read operation.
List<Map<String,AttributeValue>>	getKeys() Represents the primary key attribute values that define the items and the attributes associated with the items.
int	hashCode()
Boolean	isConsistentRead() Represents the consistency of a read operation.
void	setAttributesToGet(Collection<String> attributesToGet) Represents one or more attributes to retrieve from the table or index.
void	setConsistentRead(Boolean consistentRead) Represents the consistency of a read operation.
void	setKeys(Collection<Map<String,AttributeValue>> keys) Represents the primary key attribute values that define the items and the attributes associated with the items.
String	toString() Returns a string representation of this object; useful for testing and debugging.
KeysAndAttributes	withAttributesToGet(Collection<String> attributesToGet) Represents one or more attributes to retrieve from the table or index.
KeysAndAttributes	withAttributesToGet(String... attributesToGet) Represents one or more attributes to retrieve from the table or index.
KeysAndAttributes	withConsistentRead(Boolean consistentRead) Represents the consistency of a read operation.
KeysAndAttributes	withKeys(Collection<Map<String,AttributeValue>> keys) Represents the primary key attribute values that define the items and the attributes associated with the items.
KeysAndAttributes	withKeys(Map<String,AttributeValue>... keys) Represents the primary key attribute values that define the items and the attributes associated with the items.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

KeysAndAttributes

public KeysAndAttributes()

Method Detail

getKeys

public List<Map<String,AttributeValue>> getKeys()

Represents the primary key attribute values that define the items and the attributes associated with the items.

Constraints:
Length: 1 - 100

Returns:

Represents the primary key attribute values that define the items and the attributes associated with the items.

setKeys

public void setKeys(Collection<Map<String,AttributeValue>> keys)

Represents the primary key attribute values that define the items and the attributes associated with the items.

Constraints:
Length: 1 - 100

Parameters:

keys - Represents the primary key attribute values that define the items and the attributes associated with the items.

withKeys

public KeysAndAttributes withKeys(Map<String,AttributeValue>... keys)

Represents the primary key attribute values that define the items and the attributes associated with the items.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 100

Parameters:

keys - Represents the primary key attribute values that define the items and the attributes associated with the items.

Returns:

A reference to this updated object so that method calls can be chained together.

withKeys

public KeysAndAttributes withKeys(Collection<Map<String,AttributeValue>> keys)

Represents the primary key attribute values that define the items and the attributes associated with the items.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 100

Parameters:

keys - Represents the primary key attribute values that define the items and the attributes associated with the items.

Returns:

A reference to this updated object so that method calls can be chained together.

getAttributesToGet

public List<String> getAttributesToGet()

Represents one or more attributes to retrieve from the table or index. If no attribute names are specified then all attributes will be returned. If any of the specified attributes are not found, they will not appear in the result.

If you are querying an index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.

Constraints:
Length: 1 -

Returns:

Represents one or more attributes to retrieve from the table or index. If no attribute names are specified then all attributes will be returned. If any of the specified attributes are not found, they will not appear in the result.

If you are querying an index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.

setAttributesToGet

public void setAttributesToGet(Collection<String> attributesToGet)

Represents one or more attributes to retrieve from the table or index. If no attribute names are specified then all attributes will be returned. If any of the specified attributes are not found, they will not appear in the result.

If you are querying an index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.

Constraints:
Length: 1 -

Parameters:

attributesToGet - Represents one or more attributes to retrieve from the table or index. If no attribute names are specified then all attributes will be returned. If any of the specified attributes are not found, they will not appear in the result.

If you are querying an index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.

withAttributesToGet

public KeysAndAttributes withAttributesToGet(String... attributesToGet)

Represents one or more attributes to retrieve from the table or index. If no attribute names are specified then all attributes will be returned. If any of the specified attributes are not found, they will not appear in the result.

If you are querying an index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 -

Parameters:

attributesToGet - Represents one or more attributes to retrieve from the table or index. If no attribute names are specified then all attributes will be returned. If any of the specified attributes are not found, they will not appear in the result.

If you are querying an index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.

Returns:

A reference to this updated object so that method calls can be chained together.

withAttributesToGet

public KeysAndAttributes withAttributesToGet(Collection<String> attributesToGet)

Represents one or more attributes to retrieve from the table or index. If no attribute names are specified then all attributes will be returned. If any of the specified attributes are not found, they will not appear in the result.

If you are querying an index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 -

Parameters:

attributesToGet - Represents one or more attributes to retrieve from the table or index. If no attribute names are specified then all attributes will be returned. If any of the specified attributes are not found, they will not appear in the result.

If you are querying an index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.

Returns:

A reference to this updated object so that method calls can be chained together.

isConsistentRead

public Boolean isConsistentRead()

Represents the consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

Returns:

Represents the consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

setConsistentRead

public void setConsistentRead(Boolean consistentRead)

Represents the consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

Parameters:

consistentRead - Represents the consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

withConsistentRead

public KeysAndAttributes withConsistentRead(Boolean consistentRead)

Represents the consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

Returns a reference to this object so that method calls can be chained together.

Parameters:

consistentRead - Represents the consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

Returns:

A reference to this updated object so that method calls can be chained together.

getConsistentRead

public Boolean getConsistentRead()

Represents the consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

Returns:

Represents the consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object