Class SuggestPagedResponse

java.lang.Object
com.azure.core.http.rest.PagedResponseBase<Void,SuggestResult>
com.azure.search.documents.util.SuggestPagedResponse
All Implemented Interfaces:
Page<SuggestResult>, PagedResponse<SuggestResult>, Response<List<SuggestResult>>, ContinuablePage<String,SuggestResult>, Closeable, AutoCloseable

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 Details

    • SuggestPagedResponse

      public SuggestPagedResponse(Response<List<SuggestResult>> 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.