com.amazonaws.services.dynamodb.model
Class GetItemRequest

java.lang.Object
  com.amazonaws.AmazonWebServiceRequest
      com.amazonaws.services.dynamodb.model.GetItemRequest

public class GetItemRequest
extends AmazonWebServiceRequest

Container for the parameters to the GetItem operation.

The GetItem operation returns a set of Attributes for an item that matches the primary key. The GetItem operation provides an eventually consistent read by default. If eventually consistent reads are not acceptable for your application, use ConsistentRead. Although this operation might take longer than a standard read, it always returns the last updated value.

See Also:

AmazonDynamoDB.getItem(GetItemRequest)

Constructor Summary

GetItemRequest()
Default constructor for a new GetItemRequest object.

GetItemRequest(String tableName, Key key)
Constructs a new GetItemRequest object.

Method Summary

boolean	equals(Object obj)
List<String>	getAttributesToGet() Array of Attribute names.
Boolean	getConsistentRead() If set to true, then a consistent read is issued, otherwise eventually consistent is used.
Key	getKey() The primary key that uniquely identifies each item in a table.
String	getTableName() Returns the value of the TableName property for this object.
int	hashCode()
Boolean	isConsistentRead() If set to true, then a consistent read is issued, otherwise eventually consistent is used.
void	setAttributesToGet(Collection<String> attributesToGet) Array of Attribute names.
void	setConsistentRead(Boolean consistentRead) If set to true, then a consistent read is issued, otherwise eventually consistent is used.
void	setKey(Key key) The primary key that uniquely identifies each item in a table.
void	setTableName(String tableName) Sets the value of the TableName property for this object.
String	toString() Returns a string representation of this object; useful for testing and debugging.
GetItemRequest	withAttributesToGet(Collection<String> attributesToGet) Array of Attribute names.
GetItemRequest	withAttributesToGet(String... attributesToGet) Array of Attribute names.
GetItemRequest	withConsistentRead(Boolean consistentRead) If set to true, then a consistent read is issued, otherwise eventually consistent is used.
GetItemRequest	withKey(Key key) The primary key that uniquely identifies each item in a table.
GetItemRequest	withTableName(String tableName) Sets the value of the TableName property for this object.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetItemRequest

public GetItemRequest()

Default constructor for a new GetItemRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

GetItemRequest

public GetItemRequest(String tableName,
                      Key key)

Constructs a new GetItemRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

tableName -

key - The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash) primary key or a two attribute (hash-and-range) primary key.

Method Detail

getTableName

public String getTableName()

Returns the value of the TableName property for this object.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Returns:

The value of the TableName property for this object.

setTableName

public void setTableName(String tableName)

Sets the value of the TableName property for this object.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Parameters:

tableName - The new value for the TableName property for this object.

withTableName

public GetItemRequest withTableName(String tableName)

Sets the value of the TableName property for this object.

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

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Parameters:

tableName - The new value for the TableName property for this object.

Returns:

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

getKey

public Key getKey()

The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash) primary key or a two attribute (hash-and-range) primary key.

Returns:

The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash) primary key or a two attribute (hash-and-range) primary key.

setKey

public void setKey(Key key)

The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash) primary key or a two attribute (hash-and-range) primary key.

Parameters:

key - The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash) primary key or a two attribute (hash-and-range) primary key.

withKey

public GetItemRequest withKey(Key key)

The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash) primary key or a two attribute (hash-and-range) primary key.

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

Parameters:

key - The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash) primary key or a two attribute (hash-and-range) primary key.

Returns:

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

getAttributesToGet

public List<String> getAttributesToGet()

Array of Attribute names. If attribute names are not specified then all attributes will be returned. If some attributes are not found, they will not appear in the result.

Constraints:
Length: 1 -

Returns:

Array of Attribute names. If attribute names are not specified then all attributes will be returned. If some attributes are not found, they will not appear in the result.

setAttributesToGet

public void setAttributesToGet(Collection<String> attributesToGet)

Array of Attribute names. If attribute names are not specified then all attributes will be returned. If some attributes are not found, they will not appear in the result.

Constraints:
Length: 1 -

Parameters:

attributesToGet - Array of Attribute names. If attribute names are not specified then all attributes will be returned. If some attributes are not found, they will not appear in the result.

withAttributesToGet

public GetItemRequest withAttributesToGet(String... attributesToGet)

Array of Attribute names. If attribute names are not specified then all attributes will be returned. If some attributes are not found, they will not appear in the result.

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

Constraints:
Length: 1 -

Parameters:

attributesToGet - Array of Attribute names. If attribute names are not specified then all attributes will be returned. If some attributes are not found, they will not appear in the result.

Returns:

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

withAttributesToGet

public GetItemRequest withAttributesToGet(Collection<String> attributesToGet)

Array of Attribute names. If attribute names are not specified then all attributes will be returned. If some attributes are not found, they will not appear in the result.

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

Constraints:
Length: 1 -

Parameters:

attributesToGet - Array of Attribute names. If attribute names are not specified then all attributes will be returned. If some attributes are not found, they will not appear in the result.

Returns:

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

isConsistentRead

public Boolean isConsistentRead()

If set to true, then a consistent read is issued, otherwise eventually consistent is used.

Returns:

If set to true, then a consistent read is issued, otherwise eventually consistent is used.

setConsistentRead

public void setConsistentRead(Boolean consistentRead)

If set to true, then a consistent read is issued, otherwise eventually consistent is used.

Parameters:

consistentRead - If set to true, then a consistent read is issued, otherwise eventually consistent is used.

withConsistentRead

public GetItemRequest withConsistentRead(Boolean consistentRead)

If set to true, then a consistent read is issued, otherwise eventually consistent is used.

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

Parameters:

consistentRead - If set to true, then a consistent read is issued, otherwise eventually consistent is used.

Returns:

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

getConsistentRead

public Boolean getConsistentRead()

If set to true, then a consistent read is issued, otherwise eventually consistent is used.

Returns:

If set to true, then a consistent read is issued, otherwise eventually consistent 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