Package com.azure.search.documents.util

Class AutocompletePagedResponse

java.lang.Object
com.azure.core.http.rest.PagedResponseBase<Void,AutocompleteItem>
com.azure.search.documents.util.AutocompletePagedResponse
All Implemented Interfaces:
com.azure.core.http.rest.Page<AutocompleteItem>, com.azure.core.http.rest.PagedResponse<AutocompleteItem>, com.azure.core.http.rest.Response<List<AutocompleteItem>>, com.azure.core.util.paging.ContinuablePage<String,AutocompleteItem>, Closeable, AutoCloseable
public final class AutocompletePagedResponse extends com.azure.core.http.rest.PagedResponseBase<Void,AutocompleteItem>
This class represents a response from the autocomplete API. It contains the AutocompleteItems returned from the service.

  • Constructor Summary

    Constructors
    Constructor
    Description
    AutocompletePagedResponse(com.azure.core.http.rest.SimpleResponse<AutocompleteResult> autocompleteResponse)
    Creates an AutocompletePagedResponse from the returned Response.

  • Method Summary

    Modifier and Type
    Method
    Description
    Double
    getCoverage()
    The percentage of the index covered in the autocomplete 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 Details

    • AutocompletePagedResponse

      public AutocompletePagedResponse(com.azure.core.http.rest.SimpleResponse<AutocompleteResult> autocompleteResponse)
      Creates an AutocompletePagedResponse from the returned Response.
      Parameters:
      autocompleteResponse - Autocomplete response returned from the service.

  • Method Details

    • getCoverage

      public Double getCoverage()
      The percentage of the index covered in the autocomplete 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.