Container for the parameters to the GetItem operation.
Retrieves 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.
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 |
List 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: |
| ConsistentRead |
If set to true, then a consistent read is issued. Otherwise eventually-consistent is 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 |
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.
|
| TableName |
The name of the table in which you want to get an item. Allowed characters are a-z, A-Z, 0-9, _ (underscore),
- (hyphen) and . (period).
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(Key) | Obsolete.
Sets the Key property
|
| WithTableName(String) | Obsolete.
Sets the TableName property
|
ExamplesThis 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" Key key = new Key { HashKeyElement = new AttributeValue { S = "Mark Twain" }, RangeKeyElement = 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.ToArray()), string.Join(", ", keyValuePair.Value.SS.ToArray())); }
Inheritance Hierarchy| Object | ||
 | AmazonWebServiceRequest | |
| GetItemRequest | |
See Also