SuggestPagedResponse Class

Package:

com.azure.search.documents.util

Maven Artifact:

com.azure:azure-search-documents:11.7.4

• java.lang.Object
• • com.azure.core.http.rest.PagedResponseBase<H,T>
  • • com.azure.search.documents.util.SuggestPagedResponse

public final class SuggestPagedResponse
extends PagedResponseBase<Void,SuggestResult>

Represents an HTTP response from the suggest API request that contains a list of items deserialized into a Page. Each page contains additional information returned by the API request. In the Suggest API case the additional information is: coverage - coverage value.

Constructor Summary

Constructor	Description
SuggestPagedResponse(Response<List<SuggestResult>> response, Double coverage)	Constructor

Method Summary

Modifier and Type	Method and Description
Double	getCoverage() The percentage of the index covered in the suggest request.

Methods inherited from PagedResponseBase

close getContinuationToken getDeserializedHeaders getElements getHeaders getRequest getStatusCode

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

SuggestPagedResponse

public SuggestPagedResponse(Response> response, Double coverage)

Constructor

Parameters:

response - The response containing information such as the request, status code, headers, and values.

coverage - Percent of the index used in the suggest operation.

Method Details

getCoverage

public Double getCoverage()

The percentage of the index covered in the suggest request.

If minimumCoverage wasn't supplied in the request this will be null.

Returns:

The percentage of the index covered in the suggest request if minimumCoverage was set in the request, otherwise null.