AWS SDK for .NET Documentation
Search Class
AmazonAmazon.DynamoDBv2.DocumentModelSearch Did this page help you?   Yes   No    Tell us about it...
Search response object
Declaration Syntax
C#
public class Search
Members
All MembersMethodsProperties



IconMemberDescription
AttributesToGet
List of attribute names to retrieve

BeginGetNextSet(AsyncCallback, Object)
Initiates the asynchronous execution of the GetNextSet operation.

BeginGetRemaining(AsyncCallback, Object)
Initiates the asynchronous execution of the GetRemaining operation.

CollectResults
Whether to collect GetNextSet and GetRemaining results in Matches property. Default is true. If set to false, Matches will always be empty.

ConditionalOperator
Conditional operator for the search operation

Count
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.

EndGetNextSet(IAsyncResult)
Finishes the asynchronous execution of the Execute operation.

EndGetRemaining(IAsyncResult)
Finishes the asynchronous execution of the GetRemaining operation.

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Filter
Filter for the search operation

GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetNextSet()()()()
Retrieves the next set (page) of results

GetRemaining()()()()
Retrieves all the remaining results

GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
IndexName
Name of the index to query against.

IsBackwardSearch
Flag that, if true, indicates that the search is traversing backwards

IsConsistentRead
Flag that, if true, indicates that the search is operating in consistent-read mode

IsDone
Flag that, if true, indicates that the search is done

Limit
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.

Matches
List of currently found items

NextKey
Key denoting the starting point of the next set of results

Segment
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:

Range
0 - 4095


Select
Enum specifying what data to return from query.

TableName
Name of the table being searched

ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
TotalSegments
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:

Range
1 - 4096


Inheritance Hierarchy
Object
Search

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)