117 строки
10 KiB
YAML
117 строки
10 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.search.util.SearchPagedResponse"
|
|
fullName: "com.azure.search.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\" />"
|
|
inheritedClassMethods:
|
|
- 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> implements <xref href=\"com.azure.core.util.paging.ContinuablePage?alt=com.azure.core.util.paging.ContinuablePage&text=ContinuablePage\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.search.models.SearchRequest?alt=com.azure.search.models.SearchRequest&text=SearchRequest\" data-throw-if-not-resolved=\"False\" />,<xref href=\"com.azure.search.models.SearchResult?alt=com.azure.search.models.SearchResult&text=SearchResult\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.search.models.SearchResult?alt=com.azure.search.models.SearchResult&text=SearchResult\" data-throw-if-not-resolved=\"False\" />>>"
|
|
constructors:
|
|
- uid: "com.azure.search.util.SearchPagedResponse.SearchPagedResponse(com.azure.core.http.rest.SimpleResponse<com.azure.search.models.SearchDocumentsResult>)"
|
|
fullName: "com.azure.search.util.SearchPagedResponse.SearchPagedResponse(SimpleResponse<SearchDocumentsResult> documentSearchResponse)"
|
|
name: "SearchPagedResponse(SimpleResponse<SearchDocumentsResult> documentSearchResponse)"
|
|
nameWithType: "SearchPagedResponse.SearchPagedResponse(SimpleResponse<SearchDocumentsResult> documentSearchResponse)"
|
|
summary: "Constructor"
|
|
parameters:
|
|
- description: "an http response with the results"
|
|
name: "documentSearchResponse"
|
|
type: "<xref href=\"com.azure.core.http.rest.SimpleResponse?alt=com.azure.core.http.rest.SimpleResponse&text=SimpleResponse\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.search.models.SearchDocumentsResult?alt=com.azure.search.models.SearchDocumentsResult&text=SearchDocumentsResult\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public SearchPagedResponse(SimpleResponse<SearchDocumentsResult> documentSearchResponse)"
|
|
desc: "Constructor"
|
|
methods:
|
|
- uid: "com.azure.search.util.SearchPagedResponse.getContinuationToken()"
|
|
fullName: "com.azure.search.util.SearchPagedResponse.getContinuationToken()"
|
|
name: "getContinuationToken()"
|
|
nameWithType: "SearchPagedResponse.getContinuationToken()"
|
|
syntax: "public SearchRequest getContinuationToken()"
|
|
returns:
|
|
type: "<xref href=\"com.azure.search.models.SearchRequest?alt=com.azure.search.models.SearchRequest&text=SearchRequest\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.util.SearchPagedResponse.getCount()"
|
|
fullName: "com.azure.search.util.SearchPagedResponse.getCount()"
|
|
name: "getCount()"
|
|
nameWithType: "SearchPagedResponse.getCount()"
|
|
summary: "The approximate number of documents that matched the search and filter parameters in the request."
|
|
syntax: "public Long getCount()"
|
|
desc: "The approximate number of documents that matched the search and filter parameters in the request.\n\nIf `count` is set to `false` in the request this will be `null`."
|
|
returns:
|
|
description: "The approximate number of documents that match the request if <code>count</code> is <code>true</code>, otherwise\n <code>null</code>."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
|
|
- uid: "com.azure.search.util.SearchPagedResponse.getCoverage()"
|
|
fullName: "com.azure.search.util.SearchPagedResponse.getCoverage()"
|
|
name: "getCoverage()"
|
|
nameWithType: "SearchPagedResponse.getCoverage()"
|
|
summary: "The percentage of the index covered in the search request."
|
|
syntax: "public Double getCoverage()"
|
|
desc: "The percentage of the index covered in the search request.\n\nIf `minimumCoverage` wasn't supplied in the request this will be `null`."
|
|
returns:
|
|
description: "The percentage of the index covered in the search request if <code>minimumCoverage</code> was set in the\n request, otherwise <code>null</code>."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html\">Double</a>"
|
|
- uid: "com.azure.search.util.SearchPagedResponse.getElements()"
|
|
fullName: "com.azure.search.util.SearchPagedResponse.getElements()"
|
|
name: "getElements()"
|
|
nameWithType: "SearchPagedResponse.getElements()"
|
|
syntax: "public IterableStream<SearchResult> getElements()"
|
|
returns:
|
|
type: "<xref href=\"com.azure.core.util.IterableStream?alt=com.azure.core.util.IterableStream&text=IterableStream\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.search.models.SearchResult?alt=com.azure.search.models.SearchResult&text=SearchResult\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.search.util.SearchPagedResponse.getFacets()"
|
|
fullName: "com.azure.search.util.SearchPagedResponse.getFacets()"
|
|
name: "getFacets()"
|
|
nameWithType: "SearchPagedResponse.getFacets()"
|
|
summary: "The facet query results based on the search request."
|
|
syntax: "public Map<String,List<FacetResult>> getFacets()"
|
|
desc: "The facet query results based on the search request.\n\nIf `facets` weren't supplied in the request this will be `null`."
|
|
returns:
|
|
description: "The facet query results if <code>facets</code> were supplied in the request, otherwise <code>null</code>."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<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><<xref href=\"com.azure.search.models.FacetResult?alt=com.azure.search.models.FacetResult&text=FacetResult\" data-throw-if-not-resolved=\"False\" />>>"
|
|
- uid: "com.azure.search.util.SearchPagedResponse.getHeaders()"
|
|
fullName: "com.azure.search.util.SearchPagedResponse.getHeaders()"
|
|
name: "getHeaders()"
|
|
nameWithType: "SearchPagedResponse.getHeaders()"
|
|
syntax: "public HttpHeaders getHeaders()"
|
|
returns:
|
|
type: "<xref href=\"com.azure.core.http.HttpHeaders?alt=com.azure.core.http.HttpHeaders&text=HttpHeaders\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.util.SearchPagedResponse.getRequest()"
|
|
fullName: "com.azure.search.util.SearchPagedResponse.getRequest()"
|
|
name: "getRequest()"
|
|
nameWithType: "SearchPagedResponse.getRequest()"
|
|
syntax: "public HttpRequest getRequest()"
|
|
returns:
|
|
type: "<xref href=\"com.azure.core.http.HttpRequest?alt=com.azure.core.http.HttpRequest&text=HttpRequest\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.util.SearchPagedResponse.getStatusCode()"
|
|
fullName: "com.azure.search.util.SearchPagedResponse.getStatusCode()"
|
|
name: "getStatusCode()"
|
|
nameWithType: "SearchPagedResponse.getStatusCode()"
|
|
syntax: "public int getStatusCode()"
|
|
returns:
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.util.SearchPagedResponse.getValue()"
|
|
fullName: "com.azure.search.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><<xref href=\"com.azure.search.models.SearchResult?alt=com.azure.search.models.SearchResult&text=SearchResult\" data-throw-if-not-resolved=\"False\" />>"
|
|
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."
|
|
implements:
|
|
- "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.search.models.SearchResult?alt=com.azure.search.models.SearchResult&text=SearchResult\" data-throw-if-not-resolved=\"False\" />>>"
|
|
- "<xref href=\"com.azure.core.util.paging.ContinuablePage?alt=com.azure.core.util.paging.ContinuablePage&text=ContinuablePage\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.search.models.SearchRequest?alt=com.azure.search.models.SearchRequest&text=SearchRequest\" data-throw-if-not-resolved=\"False\" />,<xref href=\"com.azure.search.models.SearchResult?alt=com.azure.search.models.SearchResult&text=SearchResult\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.search.util"
|
|
artifact: com.azure:azure-search:11.0.0-beta.1
|