IDocumentsOperations.ContinueSearchWithHttpMessagesAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| ContinueSearchWithHttpMessagesAsync(SearchContinuationToken, SearchRequestOptions, Dictionary<String,List<String>>, CancellationToken) |
Retrieves the next page of search results from the search index. https://docs.microsoft.com/rest/api/searchservice/Search-Documents |
| ContinueSearchWithHttpMessagesAsync<T>(SearchContinuationToken, SearchRequestOptions, Dictionary<String,List<String>>, CancellationToken) |
Retrieves the next page of search results from the search index. https://docs.microsoft.com/rest/api/searchservice/Search-Documents |
ContinueSearchWithHttpMessagesAsync(SearchContinuationToken, SearchRequestOptions, Dictionary<String,List<String>>, CancellationToken)
Retrieves the next page of search results from the search index. https://docs.microsoft.com/rest/api/searchservice/Search-Documents
public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Search.Models.DocumentSearchResult<Microsoft.Azure.Search.Models.Document>>> ContinueSearchWithHttpMessagesAsync (Microsoft.Azure.Search.Models.SearchContinuationToken continuationToken, Microsoft.Azure.Search.Models.SearchRequestOptions searchRequestOptions = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);abstract member ContinueSearchWithHttpMessagesAsync : Microsoft.Azure.Search.Models.SearchContinuationToken * Microsoft.Azure.Search.Models.SearchRequestOptions * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Search.Models.DocumentSearchResult<Microsoft.Azure.Search.Models.Document>>>Public Function ContinueSearchWithHttpMessagesAsync (continuationToken As SearchContinuationToken, Optional searchRequestOptions As SearchRequestOptions = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of DocumentSearchResult(Of Document)))Parameters
- continuationToken
- SearchContinuationToken
Encapsulates the state required to fetch the next page of search results from the index.
- searchRequestOptions
- SearchRequestOptions
Additional parameters for the operation
- customHeaders
- Dictionary<String,List<String>>
The headers that will be added to request.
- cancellationToken
- CancellationToken
The cancellation token.
Returns
Response containing the documents matching the query.
Remarks
The non-generic overloads of the ContinueSearch, ContinueSearchAsync, and ContinueSearchWithHttpMessagesAsync methods make a best-effort attempt to map JSON types in the response payload to .NET types. See GetWithHttpMessagesAsync(String, IEnumerable<String>, SearchRequestOptions, Dictionary<String,List<String>>, CancellationToken) for more information.
If Azure Cognitive Search can't include all results in a single response, the response returned will include a continuation token that can be passed to ContinueSearch to retrieve more results. See DocumentSearchResult.ContinuationToken for more information.
Note that this method is not meant to help you implement paging of search results. You can implement paging using the Top and Skip parameters to the Search method.
Applies to
ContinueSearchWithHttpMessagesAsync<T>(SearchContinuationToken, SearchRequestOptions, Dictionary<String,List<String>>, CancellationToken)
Retrieves the next page of search results from the search index. https://docs.microsoft.com/rest/api/searchservice/Search-Documents
public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Search.Models.DocumentSearchResult<T>>> ContinueSearchWithHttpMessagesAsync<T> (Microsoft.Azure.Search.Models.SearchContinuationToken continuationToken, Microsoft.Azure.Search.Models.SearchRequestOptions searchRequestOptions = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);abstract member ContinueSearchWithHttpMessagesAsync : Microsoft.Azure.Search.Models.SearchContinuationToken * Microsoft.Azure.Search.Models.SearchRequestOptions * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Search.Models.DocumentSearchResult<'T>>>Public Function ContinueSearchWithHttpMessagesAsync(Of T) (continuationToken As SearchContinuationToken, Optional searchRequestOptions As SearchRequestOptions = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of DocumentSearchResult(Of T)))Type Parameters
- T
The CLR type that maps to the index schema. Instances of this type can be retrieved as documents from the index.
Parameters
- continuationToken
- SearchContinuationToken
Encapsulates the state required to fetch the next page of search results from the index.
- searchRequestOptions
- SearchRequestOptions
Additional parameters for the operation
- customHeaders
- Dictionary<String,List<String>>
The headers that will be added to request.
- cancellationToken
- CancellationToken
The cancellation token.
Returns
Response containing the documents matching the query.
Remarks
The generic overloads of the ContinueSearch, ContinueSearchAsync, and ContinueSearchWithHttpMessagesAsync methods support mapping of search field types to .NET types via the type parameter T. See GetWithHttpMessagesAsync<T>(String, IEnumerable<String>, SearchRequestOptions, Dictionary<String,List<String>>, CancellationToken) for more details on the type mapping.
If Azure Cognitive Search can't include all results in a single response, the response returned will include a continuation token that can be passed to ContinueSearch to retrieve more results. See DocumentSearchResult.ContinuationToken for more information.
Note that this method is not meant to help you implement paging of search results. You can implement paging using the Top and Skip parameters to the Search method.
Applies to
Azure SDK for .NET