Container for the parameters to the GetItem operation.
The GetItem operation returns a set of attributes for the item with the given primary key. If there is no matching item, GetItem does not return any data.
GetItem provides an eventually consistent read by default. If your application requires a strongly consistent read, set ConsistentRead to true . Although a strongly consistent read might take more time than an eventually consistent read, it always returns the last updated value.
Declaration Syntax
C# |
public class GetItemRequest : AmazonWebServiceRequest
Members
All Members | Constructors | Methods | Properties | ||
Icon | Member | Description |
---|---|---|
GetItemRequest()()()() | Initializes a new instance of the GetItemRequest class | |
AttributesToGet |
The names of one or more attributes to retrieve. If no attribute names are specified, then all attributes will be returned. If any of the
requested attributes are not found, they will not appear in the result. Note that AttributesToGet has no effect on provisioned
throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an
application.
Constraints: | |
ConsistentRead |
If set to true, then the operation uses strongly consistent reads; otherwise, eventually consistent reads are used.
| |
Equals(Object) | (Inherited from Object.) | |
GetHashCode()()()() | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetType()()()() | Gets the type of the current instance. (Inherited from Object.) | |
Key |
A map of attribute names to AttributeValue objects, representing the primary key of the item to retrieve.
| |
ReturnConsumedCapacity |
If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response
includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.
Constraints: | |
TableName |
The name of the table containing the requested item.
Constraints: | |
ToString()()()() | Returns a string that represents the current object. (Inherited from Object.) | |
WithAttributesToGet(array<String>[]()[][]) | Obsolete.
Adds elements to the AttributesToGet collection
| |
WithAttributesToGet(IEnumerable<(Of <<'(String>)>>)) | Obsolete.
Adds elements to the AttributesToGet collection
| |
WithConsistentRead(Boolean) | Obsolete.
Sets the ConsistentRead property
| |
WithKey(array<KeyValuePair<(Of <<'(String, AttributeValue>)>>)>[]()[][]) | Obsolete.
Adds the KeyValuePairs to the Key dictionary.
| |
WithReturnConsumedCapacity(String) | Obsolete.
Sets the ReturnConsumedCapacity property
| |
WithTableName(String) | Obsolete.
Sets the TableName property
|
Examples
This example shows how to get an item in a table.
CopyGetItem sample
// Create a client AmazonDynamoDBClient client = new AmazonDynamoDBClient(); // Define item key // Hash-key of the target item is string value "Mark Twain" // Range-key of the target item is string value "The Adventures of Tom Sawyer" Dictionary<string, AttributeValue> key = new Dictionary<string, AttributeValue> { { "Author", new AttributeValue { S = "Mark Twain" } }, { "Title", new AttributeValue { S = "The Adventures of Tom Sawyer" } } }; // Create GetItem request GetItemRequest request = new GetItemRequest { TableName = "SampleTable", Key = key, }; // Issue request GetItemResult result = client.GetItem(request).GetItemResult; // View response Console.WriteLine("Item:"); Dictionary<string, AttributeValue> item = result.Item; foreach (var keyValuePair in item) { Console.WriteLine("{0} : S={1}, N={2}, SS=[{3}], NS=[{4}]", keyValuePair.Key, keyValuePair.Value.S, keyValuePair.Value.N, string.Join(", ", keyValuePair.Value.SS ?? new List<string>()), string.Join(", ", keyValuePair.Value.NS ?? new List<string>())); }
Inheritance Hierarchy
Object | ||
AmazonWebServiceRequest | ||
GetItemRequest |
See Also