SuggestPagedResponse (Azure SDK for Java Reference Documentation)

java.lang.Object
- com.azure.core.http.rest.PagedResponseBase<Void,SuggestResult>
- - com.azure.search.documents.util.SuggestPagedResponse

All Implemented Interfaces:

com.azure.core.http.rest.Page<SuggestResult>, com.azure.core.http.rest.PagedResponse<SuggestResult>, com.azure.core.http.rest.Response<List<SuggestResult>>, com.azure.core.util.paging.ContinuablePage<String,SuggestResult>, Closeable, AutoCloseable
```
public final class SuggestPagedResponse
extends com.azure.core.http.rest.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
  
  Constructors
  Constructor Description
  
  SuggestPagedResponse(com.azure.core.http.rest.Response<List<SuggestResult>> response, Double coverage)
  Constructor
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  Double getCoverage()
  The percentage of the index covered in the suggest request.
  - Methods inherited from class com.azure.core.http.rest.PagedResponseBase
    close, getContinuationToken, getDeserializedHeaders, getElements, getHeaders, getRequest, getStatusCode
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  - Methods inherited from interface com.azure.core.http.rest.Page
    getItems
  - Methods inherited from interface com.azure.core.http.rest.PagedResponse
    getValue

- Constructor Detail
  - SuggestPagedResponse
```
public SuggestPagedResponse(com.azure.core.http.rest.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 Detail
  - 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.