### YamlMime:JavaType
uid: "com.azure.search.documents.util.SearchPagedResponse"
fullName: "com.azure.search.documents.util.SearchPagedResponse"
name: "SearchPagedResponse"
nameWithType: "SearchPagedResponse"
summary: "Represents an HTTP response from the search API request that contains a list of items deserialized into a <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Page\"></xref>."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.core.http.rest.PagedResponseBase?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"com.azure.core.http.rest.PagedResponseBase?alt=com.azure.core.http.rest.PagedResponseBase&text=PagedResponseBase\" data-throw-if-not-resolved=\"False\" />"
  methodsRef:
  - "<xref href=\"com.azure.core.http.rest.PagedResponseBase.close()?alt=com.azure.core.http.rest.PagedResponseBase.close&text=close\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"com.azure.core.http.rest.PagedResponseBase.getContinuationToken()?alt=com.azure.core.http.rest.PagedResponseBase.getContinuationToken&text=getContinuationToken\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"com.azure.core.http.rest.PagedResponseBase.getDeserializedHeaders()?alt=com.azure.core.http.rest.PagedResponseBase.getDeserializedHeaders&text=getDeserializedHeaders\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"com.azure.core.http.rest.PagedResponseBase.getElements()?alt=com.azure.core.http.rest.PagedResponseBase.getElements&text=getElements\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"com.azure.core.http.rest.PagedResponseBase.getHeaders()?alt=com.azure.core.http.rest.PagedResponseBase.getHeaders&text=getHeaders\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"com.azure.core.http.rest.PagedResponseBase.getRequest()?alt=com.azure.core.http.rest.PagedResponseBase.getRequest&text=getRequest\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"com.azure.core.http.rest.PagedResponseBase.getStatusCode()?alt=com.azure.core.http.rest.PagedResponseBase.getStatusCode&text=getStatusCode\" data-throw-if-not-resolved=\"False\" />"
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **SearchPagedResponse**</br> extends <xref href=\"com.azure.core.http.rest.PagedResponseBase?alt=com.azure.core.http.rest.PagedResponseBase&text=PagedResponseBase\" data-throw-if-not-resolved=\"False\" />&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>,<xref href=\"com.azure.search.documents.models.SearchResult?alt=com.azure.search.documents.models.SearchResult&text=SearchResult\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.search.documents.util.SearchPagedResponse.SearchPagedResponse(com.azure.core.http.rest.Response<java.util.List<com.azure.search.documents.models.SearchResult>>,java.lang.String,java.util.Map<java.lang.String,java.util.List<com.azure.search.documents.models.FacetResult>>,java.lang.Long,java.lang.Double)"
  fullName: "com.azure.search.documents.util.SearchPagedResponse.SearchPagedResponse(Response<List<SearchResult>> response, String continuationToken, Map<String,List<FacetResult>> facets, Long count, Double coverage)"
  name: "SearchPagedResponse(Response<List<SearchResult>> response, String continuationToken, Map<String,List<FacetResult>> facets, Long count, Double coverage)"
  nameWithType: "SearchPagedResponse.SearchPagedResponse(Response<List<SearchResult>> response, String continuationToken, Map<String,List<FacetResult>> facets, Long count, Double coverage)"
  summary: "Constructor"
  parameters:
  - description: "The response containing information such as the request, status code, headers, and values."
    name: "response"
    type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.search.documents.models.SearchResult?alt=com.azure.search.documents.models.SearchResult&text=SearchResult\" data-throw-if-not-resolved=\"False\" />&gt;&gt;"
  - description: "Continuation token for the next operation."
    name: "continuationToken"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "Facets contained in the search."
    name: "facets"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.search.documents.models.FacetResult?alt=com.azure.search.documents.models.FacetResult&text=FacetResult\" data-throw-if-not-resolved=\"False\" />&gt;&gt;"
  - description: "Total number of documents available as a result for the search."
    name: "count"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
  - description: "Percent of the index used in the search operation."
    name: "coverage"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html\">Double</a>"
  syntax: "public SearchPagedResponse(Response<List<SearchResult>> response, String continuationToken, Map<String,List<FacetResult>> facets, Long count, Double coverage)"
  desc: "Constructor"
- uid: "com.azure.search.documents.util.SearchPagedResponse.SearchPagedResponse(com.azure.core.http.rest.Response<java.util.List<com.azure.search.documents.models.SearchResult>>,java.lang.String,java.util.Map<java.lang.String,java.util.List<com.azure.search.documents.models.FacetResult>>,java.lang.Long,java.lang.Double,java.util.List<com.azure.search.documents.models.QueryAnswerResult>,com.azure.search.documents.models.SemanticErrorReason,com.azure.search.documents.models.SemanticSearchResultsType)"
  fullName: "com.azure.search.documents.util.SearchPagedResponse.SearchPagedResponse(Response<List<SearchResult>> response, String continuationToken, Map<String,List<FacetResult>> facets, Long count, Double coverage, List<QueryAnswerResult> queryAnswers, SemanticErrorReason semanticErrorReason, SemanticSearchResultsType semanticSearchResultsType)"
  name: "SearchPagedResponse(Response<List<SearchResult>> response, String continuationToken, Map<String,List<FacetResult>> facets, Long count, Double coverage, List<QueryAnswerResult> queryAnswers, SemanticErrorReason semanticErrorReason, SemanticSearchResultsType semanticSearchResultsType)"
  nameWithType: "SearchPagedResponse.SearchPagedResponse(Response<List<SearchResult>> response, String continuationToken, Map<String,List<FacetResult>> facets, Long count, Double coverage, List<QueryAnswerResult> queryAnswers, SemanticErrorReason semanticErrorReason, SemanticSearchResultsType semanticSearchResultsType)"
  summary: "Constructor"
  parameters:
  - description: "The response containing information such as the request, status code, headers, and values."
    name: "response"
    type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.search.documents.models.SearchResult?alt=com.azure.search.documents.models.SearchResult&text=SearchResult\" data-throw-if-not-resolved=\"False\" />&gt;&gt;"
  - description: "Continuation token for the next operation."
    name: "continuationToken"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "Facets contained in the search."
    name: "facets"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.search.documents.models.FacetResult?alt=com.azure.search.documents.models.FacetResult&text=FacetResult\" data-throw-if-not-resolved=\"False\" />&gt;&gt;"
  - description: "Total number of documents available as a result for the search."
    name: "count"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
  - description: "Percent of the index used in the search operation."
    name: "coverage"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html\">Double</a>"
  - description: "Answers contained in the search."
    name: "queryAnswers"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.search.documents.models.QueryAnswerResult?alt=com.azure.search.documents.models.QueryAnswerResult&text=QueryAnswerResult\" data-throw-if-not-resolved=\"False\" />&gt;"
  - description: "Reason that a partial response was returned for a semantic search request."
    name: "semanticErrorReason"
    type: "<xref href=\"com.azure.search.documents.models.SemanticErrorReason?alt=com.azure.search.documents.models.SemanticErrorReason&text=SemanticErrorReason\" data-throw-if-not-resolved=\"False\" />"
  - description: "Type of the partial response returned for a semantic search request."
    name: "semanticSearchResultsType"
    type: "<xref href=\"com.azure.search.documents.models.SemanticSearchResultsType?alt=com.azure.search.documents.models.SemanticSearchResultsType&text=SemanticSearchResultsType\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public SearchPagedResponse(Response<List<SearchResult>> response, String continuationToken, Map<String,List<FacetResult>> facets, Long count, Double coverage, List<QueryAnswerResult> queryAnswers, SemanticErrorReason semanticErrorReason, SemanticSearchResultsType semanticSearchResultsType)"
  desc: "Constructor"
methods:
- uid: "com.azure.search.documents.util.SearchPagedResponse.getValue()"
  fullName: "com.azure.search.documents.util.SearchPagedResponse.getValue()"
  name: "getValue()"
  nameWithType: "SearchPagedResponse.getValue()"
  syntax: "public List<SearchResult> getValue()"
  returns:
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.search.documents.models.SearchResult?alt=com.azure.search.documents.models.SearchResult&text=SearchResult\" data-throw-if-not-resolved=\"False\" />&gt;"
type: "class"
desc: "Represents an HTTP response from the search API request that contains a list of items deserialized into a <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Page\"></xref>. Each page contains additional information returned by the API request. In the Search API case the additional information is: count - number of total documents returned. Will be returned only if isIncludeTotalResultCount is set to true coverage - coverage value."
metadata: {}
package: "com.azure.search.documents.util"
artifact: com.azure:azure-search-documents:11.7.1