SearchContinuationToken Class

Package:
com.azure.search.documents.models
Maven Artifact:
com.azure:azure-search-documents:12.0.0
  • java.lang.Object
    • com.azure.search.documents.models.SearchContinuationToken

Implements

JsonSerializable<SearchContinuationToken>

public final class SearchContinuationToken
implements JsonSerializable<SearchContinuationToken>

Continuation token used when searching documents to iterate through REST API pages.

Constructor Summary

Constructor Description
SearchContinuationToken(SearchRequest nextPageParameters, SearchServiceVersion apiVersion)

Creates a new SearchContinuationToken.

Method Summary

Modifier and Type Method and Description
SearchServiceVersion getApiVersion()

Gets the apiVersion property: API version used when sending the query request.
SearchRequest getNextPageParameters()

Get the nextPageParameters property: Continuation JSON payload returned when the query can't return all the requested results in a single response.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

SearchContinuationToken

public SearchContinuationToken(SearchRequest nextPageParameters, SearchServiceVersion apiVersion)

Creates a new SearchContinuationToken.

Parameters:

nextPageParameters - The SearchRequest to use when retrieving the next page of search results.
apiVersion - The SearchServiceVersion used when searching, subsequent page requests must use the same SearchServiceVersion.

Method Details

getApiVersion

public SearchServiceVersion getApiVersion()

Gets the apiVersion property: API version used when sending the query request. Must remain consistent for all requests in the paged operation.

Returns:

the apiVersion value.

getNextPageParameters

public SearchRequest getNextPageParameters()

Get the nextPageParameters property: Continuation JSON payload returned when the query can't return all the requested results in a single response. You can use this JSON along with.

Returns:

the nextPageParameters value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to