AWS SDK Version 2 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

.NET Framework 3.5
 
Search response object

Inheritance Hierarchy

System.Object
  Amazon.DynamoDBv2.DocumentModel.Search

Namespace: Amazon.DynamoDBv2.DocumentModel
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public class Search : Object

The Search type exposes the following members

Properties

NameTypeDescription
Public Property AttributesToGet System.Collections.Generic.List<System.String> List of attribute names to retrieve
Public Property CollectResults System.Boolean Whether to collect GetNextSet and GetRemaining results in Matches property. Default is true. If set to false, Matches will always be empty.
Public Property ConditionalOperator Amazon.DynamoDBv2.DocumentModel.ConditionalOperatorValues Conditional operator for the search operation
Public Property Count System.Int32 Gets the total number of items that match the search parameters. If IsDone is true and CollectResults is true, returns Matches.Count. Otherwise, makes a call to DynamoDB to find out the number of matching items, without retrieving the items. Count is then cached.
Public Property Filter Amazon.DynamoDBv2.DocumentModel.Filter Filter for the search operation This applies to Query and Scan operations.
Public Property FilterExpression Amazon.DynamoDBv2.DocumentModel.Expression The filter expression that is evaluated for each item. This applies to Query and Scan operations.
Public Property IndexName System.String Name of the index to query or scan against.
Public Property IsBackwardSearch System.Boolean Flag that, if true, indicates that the search is traversing backwards
Public Property IsConsistentRead System.Boolean Flag that, if true, indicates that the search is operating in consistent-read mode
Public Property IsDone System.Boolean Flag that, if true, indicates that the search is done
Public Property KeyExpression Amazon.DynamoDBv2.DocumentModel.Expression The key expression that is evaluated for each item of a query. This applies only to Query operations.
Public Property Limit System.Int32 Upper limit on the number of items returned. For Queries: upper limit on the number of items returned. For Scan: limit on the number of items scanned. Maps directly to Limit property on Query and Scan operations.
Public Property Matches System.Collections.Generic.List<Amazon.DynamoDBv2.DocumentModel.Document> List of currently found items
Public Property NextKey System.Collections.Generic.Dictionary<System.String, Amazon.DynamoDBv2.Model.AttributeValue> Key denoting the starting point of the next set of results
Public Property Segment System.Int32 For parallel Scan requests, Segment identifies an individual segment to be scanned by an application "worker" (such as a thread or a process). Each worker issues a Scan request with a distinct value for the segment it will scan. Segment IDs are zero-based, so the first segment is always 0. For example, if you want to scan a table using four application threads, the first thread would specify a Segment value of 0, the second thread would specify 1, and so on. LastEvaluatedKey returned from a parallel scan request must be used with same Segment id in a subsequent operation. The value for Segment must be less than or equal to 0, and less than the value provided for TotalSegments. If you specify Segment, you must also specify TotalSegments.

Constraints:Range0 - 4095

Public Property Select Amazon.DynamoDBv2.DocumentModel.SelectValues Enum specifying what data to return from query.
Public Property TableName System.String Name of the table being searched
Public Property TotalSegments System.Int32 For parallel Scan requests, TotalSegmentsrepresents the total number of segments for a table that is being scanned. Segments are a way to logically divide a table into equally sized portions, for the duration of the Scan request. The value of TotalSegments corresponds to the number of application "workers" (such as threads or processes) that will perform the parallel Scan. For example, if you want to scan a table using four application threads, you would specify a TotalSegments value of 4. The value for TotalSegments must be greater than or equal to 1, and less than or equal to 4096. If you specify a TotalSegments value of 1, the Scan will be sequential rather than parallel. If you specify TotalSegments, you must also specify Segment.

Constraints:Range1 - 4096

Methods

NameDescription
Public Method BeginGetNextSet(AsyncCallback, object) Initiates the asynchronous execution of the GetNextSet operation. Amazon.DynamoDBv2.DocumentModel.Search.GetNextSet
Public Method BeginGetRemaining(AsyncCallback, object) Initiates the asynchronous execution of the GetRemaining operation. Amazon.DynamoDBv2.DocumentModel.Search.GetRemaining
Public Method EndGetNextSet(IAsyncResult) Finishes the asynchronous execution of the Execute operation. Amazon.DynamoDBv2.DocumentModel.Search.GetNextSet
Public Method EndGetRemaining(IAsyncResult) Finishes the asynchronous execution of the GetRemaining operation. Amazon.DynamoDBv2.DocumentModel.Search.GetRemaining
Public Method GetNextSet() Retrieves the next set (page) of results
Public Method GetRemaining() Retrieves all the remaining results

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8

.NET for Windows Phone:
Supported in: Windows Phone 8.1, Windows Phone 8