84 строки
11 KiB
YAML
84 строки
11 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.search.documents.util.SuggestPagedIterable"
|
|
fullName: "com.azure.search.documents.util.SuggestPagedIterable"
|
|
name: "SuggestPagedIterable"
|
|
nameWithType: "SuggestPagedIterable"
|
|
summary: "Implementation of <xref uid=\"com.azure.core.http.rest.PagedIterableBase\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PagedIterableBase\"></xref> where the element type is <xref uid=\"com.azure.search.documents.models.SuggestResult\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SuggestResult\"></xref> and the page type is <xref uid=\"com.azure.search.documents.util.SuggestPagedResponse\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SuggestPagedResponse\"></xref>."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.core.util.IterableStream?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.core.util.paging.ContinuablePagedIterable?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.core.http.rest.PagedIterableBase?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"com.azure.core.util.IterableStream?alt=com.azure.core.util.IterableStream&text=IterableStream\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"com.azure.core.util.IterableStream.<T>of(java.lang.Iterable<T>)?alt=com.azure.core.util.IterableStream.<T>of&text=<T>of\" data-throw-if-not-resolved=\"False\" />"
|
|
- classRef: "<xref href=\"com.azure.core.util.paging.ContinuablePagedIterable?alt=com.azure.core.util.paging.ContinuablePagedIterable&text=ContinuablePagedIterable\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"com.azure.core.util.paging.ContinuablePagedIterable.iterableByPage()?alt=com.azure.core.util.paging.ContinuablePagedIterable.iterableByPage&text=iterableByPage\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.core.util.paging.ContinuablePagedIterable.iterableByPage(C)?alt=com.azure.core.util.paging.ContinuablePagedIterable.iterableByPage&text=iterableByPage\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.core.util.paging.ContinuablePagedIterable.iterableByPage(C,int)?alt=com.azure.core.util.paging.ContinuablePagedIterable.iterableByPage&text=iterableByPage\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.core.util.paging.ContinuablePagedIterable.iterableByPage(int)?alt=com.azure.core.util.paging.ContinuablePagedIterable.iterableByPage&text=iterableByPage\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.core.util.paging.ContinuablePagedIterable.iterator()?alt=com.azure.core.util.paging.ContinuablePagedIterable.iterator&text=iterator\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.core.util.paging.ContinuablePagedIterable.stream()?alt=com.azure.core.util.paging.ContinuablePagedIterable.stream&text=stream\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.core.util.paging.ContinuablePagedIterable.streamByPage()?alt=com.azure.core.util.paging.ContinuablePagedIterable.streamByPage&text=streamByPage\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.core.util.paging.ContinuablePagedIterable.streamByPage(C)?alt=com.azure.core.util.paging.ContinuablePagedIterable.streamByPage&text=streamByPage\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.core.util.paging.ContinuablePagedIterable.streamByPage(C,int)?alt=com.azure.core.util.paging.ContinuablePagedIterable.streamByPage&text=streamByPage\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.core.util.paging.ContinuablePagedIterable.streamByPage(int)?alt=com.azure.core.util.paging.ContinuablePagedIterable.streamByPage&text=streamByPage\" 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 **SuggestPagedIterable**</br> extends <xref href=\"com.azure.core.http.rest.PagedIterableBase?alt=com.azure.core.http.rest.PagedIterableBase&text=PagedIterableBase\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.search.documents.models.SuggestResult?alt=com.azure.search.documents.models.SuggestResult&text=SuggestResult\" data-throw-if-not-resolved=\"False\" />,<xref href=\"com.azure.search.documents.util.SuggestPagedResponse?alt=com.azure.search.documents.util.SuggestPagedResponse&text=SuggestPagedResponse\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.search.documents.util.SuggestPagedIterable.SuggestPagedIterable(com.azure.search.documents.util.SuggestPagedFlux)"
|
|
fullName: "com.azure.search.documents.util.SuggestPagedIterable.SuggestPagedIterable(SuggestPagedFlux pagedFluxBase)"
|
|
name: "SuggestPagedIterable(SuggestPagedFlux pagedFluxBase)"
|
|
nameWithType: "SuggestPagedIterable.SuggestPagedIterable(SuggestPagedFlux pagedFluxBase)"
|
|
summary: "Creates instance given <xref uid=\"com.azure.search.documents.util.SuggestPagedIterable\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SuggestPagedIterable\"></xref>."
|
|
parameters:
|
|
- description: "The <xref uid=\"com.azure.search.documents.util.SuggestPagedIterable\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SuggestPagedIterable\"></xref> that will be consumed as an iterable."
|
|
name: "pagedFluxBase"
|
|
type: "<xref href=\"com.azure.search.documents.util.SuggestPagedFlux?alt=com.azure.search.documents.util.SuggestPagedFlux&text=SuggestPagedFlux\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public SuggestPagedIterable(SuggestPagedFlux pagedFluxBase)"
|
|
desc: "Creates instance given <xref uid=\"com.azure.search.documents.util.SuggestPagedIterable\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SuggestPagedIterable\"></xref>."
|
|
- uid: "com.azure.search.documents.util.SuggestPagedIterable.SuggestPagedIterable(java.util.function.Supplier<com.azure.search.documents.util.SuggestPagedResponse>)"
|
|
fullName: "com.azure.search.documents.util.SuggestPagedIterable.SuggestPagedIterable(Supplier<SuggestPagedResponse> firstPageRetriever)"
|
|
name: "SuggestPagedIterable(Supplier<SuggestPagedResponse> firstPageRetriever)"
|
|
nameWithType: "SuggestPagedIterable.SuggestPagedIterable(Supplier<SuggestPagedResponse> firstPageRetriever)"
|
|
summary: "Creates an instance of <xref uid=\"com.azure.search.documents.util.SuggestPagedIterable\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SuggestPagedIterable\"></xref>."
|
|
parameters:
|
|
- description: "Supplier that retrieves the first page"
|
|
name: "firstPageRetriever"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html\">Supplier</a><<xref href=\"com.azure.search.documents.util.SuggestPagedResponse?alt=com.azure.search.documents.util.SuggestPagedResponse&text=SuggestPagedResponse\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public SuggestPagedIterable(Supplier<SuggestPagedResponse> firstPageRetriever)"
|
|
desc: "Creates an instance of <xref uid=\"com.azure.search.documents.util.SuggestPagedIterable\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SuggestPagedIterable\"></xref>. The constructor takes a `Supplier`. The `Supplier` returns the first page of `SuggestPagedResponse`."
|
|
- uid: "com.azure.search.documents.util.SuggestPagedIterable.SuggestPagedIterable(java.util.function.Supplier<com.azure.search.documents.util.SuggestPagedResponse>,java.util.function.Function<java.lang.String,com.azure.search.documents.util.SuggestPagedResponse>)"
|
|
fullName: "com.azure.search.documents.util.SuggestPagedIterable.SuggestPagedIterable(Supplier<SuggestPagedResponse> firstPageRetriever, Function<String,SuggestPagedResponse> nextPageRetriever)"
|
|
name: "SuggestPagedIterable(Supplier<SuggestPagedResponse> firstPageRetriever, Function<String,SuggestPagedResponse> nextPageRetriever)"
|
|
nameWithType: "SuggestPagedIterable.SuggestPagedIterable(Supplier<SuggestPagedResponse> firstPageRetriever, Function<String,SuggestPagedResponse> nextPageRetriever)"
|
|
summary: "Creates an instance of <xref uid=\"com.azure.search.documents.util.SuggestPagedIterable\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SuggestPagedIterable\"></xref>."
|
|
parameters:
|
|
- description: "Supplier that retrieves the first page"
|
|
name: "firstPageRetriever"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html\">Supplier</a><<xref href=\"com.azure.search.documents.util.SuggestPagedResponse?alt=com.azure.search.documents.util.SuggestPagedResponse&text=SuggestPagedResponse\" data-throw-if-not-resolved=\"False\" />>"
|
|
- description: "Function that retrieves the next page given a continuation token"
|
|
name: "nextPageRetriever"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html\">Function</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<xref href=\"com.azure.search.documents.util.SuggestPagedResponse?alt=com.azure.search.documents.util.SuggestPagedResponse&text=SuggestPagedResponse\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public SuggestPagedIterable(Supplier<SuggestPagedResponse> firstPageRetriever, Function<String,SuggestPagedResponse> nextPageRetriever)"
|
|
desc: "Creates an instance of <xref uid=\"com.azure.search.documents.util.SuggestPagedIterable\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SuggestPagedIterable\"></xref>. The constructor takes a `Supplier` and `Function`. The `Supplier` returns the first page of `SuggestPagedResponse`, the `Function` retrieves subsequent pages of `SuggestPagedResponse`."
|
|
type: "class"
|
|
desc: "Implementation of <xref uid=\"com.azure.core.http.rest.PagedIterableBase\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PagedIterableBase\"></xref> where the element type is <xref uid=\"com.azure.search.documents.models.SuggestResult\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SuggestResult\"></xref> and the page type is <xref uid=\"com.azure.search.documents.util.SuggestPagedResponse\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SuggestPagedResponse\"></xref>."
|
|
metadata: {}
|
|
package: "com.azure.search.documents.util"
|
|
artifact: com.azure:azure-search-documents:11.7.3
|