75 строки
7.7 KiB
YAML
75 строки
7.7 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.core.util.polling.AsyncPollResponse"
|
|
fullName: "com.azure.core.util.polling.AsyncPollResponse<T,U>"
|
|
name: "AsyncPollResponse<T,U>"
|
|
nameWithType: "AsyncPollResponse<T,U>"
|
|
summary: "Async<wbr>Poll<wbr>Response represents an event emitted by the <xref uid=\"com.azure.core.util.polling.PollerFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PollerFlux\"></xref> that asynchronously polls a long-running operation (LRO)."
|
|
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 **AsyncPollResponse<T,U>**"
|
|
methods:
|
|
- uid: "com.azure.core.util.polling.AsyncPollResponse.cancelOperation()"
|
|
fullName: "com.azure.core.util.polling.AsyncPollResponse<T,U>.cancelOperation()"
|
|
name: "cancelOperation()"
|
|
nameWithType: "AsyncPollResponse<T,U>.cancelOperation()"
|
|
summary: "Gets a <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> whereupon subscription it cancels the remote long-running operation if cancellation is supported by the service."
|
|
syntax: "public Mono<T> cancelOperation()"
|
|
desc: "Gets a <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> whereupon subscription it cancels the remote long-running operation if cancellation is supported by the service."
|
|
returns:
|
|
description: "A <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> whereupon subscription it cancels the remote long-running operation if cancellation\n is supported by the service."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.core.util.polling.AsyncPollResponse.getFinalResult()"
|
|
fullName: "com.azure.core.util.polling.AsyncPollResponse<T,U>.getFinalResult()"
|
|
name: "getFinalResult()"
|
|
nameWithType: "AsyncPollResponse<T,U>.getFinalResult()"
|
|
summary: "Gets a <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> whereupon subscription it fetches the final result of the long-running operation if it is supported by the service."
|
|
syntax: "public Mono<U> getFinalResult()"
|
|
desc: "Gets a <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> whereupon subscription it fetches the final result of the long-running operation if it is supported by the service.\n\nIf the long-running operation isn't complete an empty <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> will be returned."
|
|
returns:
|
|
description: "A <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> whereupon subscription it fetches the final result of the long-running operation if it is\n supported by the service. If the long-running operation is not completed, then an empty <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> will be\n returned."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"U?alt=U&text=U\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.core.util.polling.AsyncPollResponse.getStatus()"
|
|
fullName: "com.azure.core.util.polling.AsyncPollResponse<T,U>.getStatus()"
|
|
name: "getStatus()"
|
|
nameWithType: "AsyncPollResponse<T,U>.getStatus()"
|
|
summary: "Represents the status of the long-running operation at the time the last polling operation finished successfully."
|
|
syntax: "public LongRunningOperationStatus getStatus()"
|
|
desc: "Represents the status of the long-running operation at the time the last polling operation finished successfully."
|
|
returns:
|
|
description: "A <xref uid=\"com.azure.core.util.polling.LongRunningOperationStatus\" data-throw-if-not-resolved=\"false\" data-raw-source=\"LongRunningOperationStatus\"></xref> representing the result of the poll operation."
|
|
type: "<xref href=\"com.azure.core.util.polling.LongRunningOperationStatus?alt=com.azure.core.util.polling.LongRunningOperationStatus&text=LongRunningOperationStatus\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.core.util.polling.AsyncPollResponse.getValue()"
|
|
fullName: "com.azure.core.util.polling.AsyncPollResponse<T,U>.getValue()"
|
|
name: "getValue()"
|
|
nameWithType: "AsyncPollResponse<T,U>.getValue()"
|
|
summary: "The value returned as a result of the last successful poll operation."
|
|
syntax: "public T getValue()"
|
|
desc: "The value returned as a result of the last successful poll operation. This can be any custom user defined object, or null if no value was returned from the service."
|
|
returns:
|
|
description: "T result of poll operation."
|
|
type: "<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
typeParameters:
|
|
- description: "The type of poll response value."
|
|
name: "T"
|
|
- description: "The type of the final result of long-running operation."
|
|
name: "U"
|
|
desc: "AsyncPollResponse represents an event emitted by the <xref uid=\"com.azure.core.util.polling.PollerFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PollerFlux\"></xref> that asynchronously polls a long-running operation (LRO). An AsyncPollResponse event provides information such as the current <xref uid=\"com.azure.core.util.polling.LongRunningOperationStatus\" data-throw-if-not-resolved=\"false\" data-raw-source=\"status\"></xref> of the LRO, any <xref uid=\"com.azure.core.util.polling.AsyncPollResponse.getValue\" data-throw-if-not-resolved=\"false\" data-raw-source=\"value\"></xref> returned by the poll, as well as other useful information provided by the service. AsyncPollResponse also exposes <xref uid=\"com.azure.core.util.polling.AsyncPollResponse.cancelOperation\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#cancelOperation\"></xref> method to cancel the long-running operation from reactor operator chain and <xref uid=\"com.azure.core.util.polling.AsyncPollResponse.getFinalResult()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#getFinalResult()\"></xref> method that returns final result of the long-running operation."
|
|
metadata: {}
|
|
package: "com.azure.core.util.polling"
|
|
artifact: com.azure:azure-core:1.52.0
|