95 строки
9.5 KiB
YAML
95 строки
9.5 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.core.util.polling.PollResponse"
|
|
fullName: "com.azure.core.util.polling.PollResponse<T>"
|
|
name: "PollResponse<T>"
|
|
nameWithType: "PollResponse<T>"
|
|
summary: "Poll<wbr>Response represents a single response from a service for a long-running polling operation."
|
|
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 **PollResponse<T>**"
|
|
constructors:
|
|
- uid: "com.azure.core.util.polling.PollResponse.PollResponse(com.azure.core.util.polling.LongRunningOperationStatus,T)"
|
|
fullName: "com.azure.core.util.polling.PollResponse<T>.PollResponse(LongRunningOperationStatus status, T value)"
|
|
name: "PollResponse(LongRunningOperationStatus status, T value)"
|
|
nameWithType: "PollResponse<T>.PollResponse(LongRunningOperationStatus status, T value)"
|
|
summary: "Creates a new <xref uid=\"com.azure.core.util.polling.PollResponse\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PollResponse\"></xref> with status and value."
|
|
parameters:
|
|
- description: "Mandatory operation status as defined in <xref uid=\"com.azure.core.util.polling.LongRunningOperationStatus\" data-throw-if-not-resolved=\"false\" data-raw-source=\"LongRunningOperationStatus\"></xref>."
|
|
name: "status"
|
|
type: "<xref href=\"com.azure.core.util.polling.LongRunningOperationStatus?alt=com.azure.core.util.polling.LongRunningOperationStatus&text=LongRunningOperationStatus\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The value as a result of poll operation. This can be any custom user-defined object. Null is also\n valid."
|
|
name: "value"
|
|
type: "<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public PollResponse(LongRunningOperationStatus status, T value)"
|
|
desc: "Creates a new <xref uid=\"com.azure.core.util.polling.PollResponse\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PollResponse\"></xref> with status and value.\n\n**Code Sample Creating PollResponse Object**\n\n```java\n// Lets say we want to crete poll response with status as IN_PROGRESS\n\n PollResponse<String> inProgressPollResponse\n = new PollResponse<>(LongRunningOperationStatus.IN_PROGRESS, \"my custom response\");\n```"
|
|
- uid: "com.azure.core.util.polling.PollResponse.PollResponse(com.azure.core.util.polling.LongRunningOperationStatus,T,java.time.Duration)"
|
|
fullName: "com.azure.core.util.polling.PollResponse<T>.PollResponse(LongRunningOperationStatus status, T value, Duration retryAfter)"
|
|
name: "PollResponse(LongRunningOperationStatus status, T value, Duration retryAfter)"
|
|
nameWithType: "PollResponse<T>.PollResponse(LongRunningOperationStatus status, T value, Duration retryAfter)"
|
|
summary: "Creates a new <xref uid=\"com.azure.core.util.polling.PollResponse\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PollResponse\"></xref> with status, value, retry<wbr>After and properties."
|
|
parameters:
|
|
- description: "Mandatory operation status as defined in <xref uid=\"com.azure.core.util.polling.LongRunningOperationStatus\" data-throw-if-not-resolved=\"false\" data-raw-source=\"LongRunningOperationStatus\"></xref>."
|
|
name: "status"
|
|
type: "<xref href=\"com.azure.core.util.polling.LongRunningOperationStatus?alt=com.azure.core.util.polling.LongRunningOperationStatus&text=LongRunningOperationStatus\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The value as a result of poll operation. This can be any custom user-defined object. Null is also\n valid."
|
|
name: "value"
|
|
type: "<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Represents the delay the service has requested until the next polling operation is performed. A\n <code>null</code>, zero or negative value will be taken to mean that the poller should determine on its\n own when the next poll operation is to occur."
|
|
name: "retryAfter"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
syntax: "public PollResponse(LongRunningOperationStatus status, T value, Duration retryAfter)"
|
|
desc: "Creates a new <xref uid=\"com.azure.core.util.polling.PollResponse\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PollResponse\"></xref> with status, value, retryAfter and properties.\n\n**Code Sample Creating PollResponse Object**\n\n```java\n// Lets say we want to crete poll response with status as IN_PROGRESS\n PollResponse<String> inProgressPollResponse\n = new PollResponse<>(LongRunningOperationStatus.IN_PROGRESS, \"my custom response\",\n Duration.ofMillis(2000));\n```"
|
|
methods:
|
|
- uid: "com.azure.core.util.polling.PollResponse.getRetryAfter()"
|
|
fullName: "com.azure.core.util.polling.PollResponse<T>.getRetryAfter()"
|
|
name: "getRetryAfter()"
|
|
nameWithType: "PollResponse<T>.getRetryAfter()"
|
|
summary: "Returns the delay the service has requested until the next polling operation is performed."
|
|
syntax: "public Duration getRetryAfter()"
|
|
desc: "Returns the delay the service has requested until the next polling operation is performed. A null or negative value will be taken to mean that the poller should determine on its own when the next poll operation is to occur."
|
|
returns:
|
|
description: "Duration How long to wait before next retry."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- uid: "com.azure.core.util.polling.PollResponse.getStatus()"
|
|
fullName: "com.azure.core.util.polling.PollResponse<T>.getStatus()"
|
|
name: "getStatus()"
|
|
nameWithType: "PollResponse<T>.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.PollResponse.getValue()"
|
|
fullName: "com.azure.core.util.polling.PollResponse<T>.getValue()"
|
|
name: "getValue()"
|
|
nameWithType: "PollResponse<T>.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: "Type of poll response value."
|
|
name: "T"
|
|
desc: "PollResponse represents a single response from a service for a long-running polling operation. It 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 long-running operation, any <xref uid=\"com.azure.core.util.polling.PollResponse.getValue\" data-throw-if-not-resolved=\"false\" data-raw-source=\"value\"></xref> returned in the poll, as well as other useful information provided by the service.\n\n**Code Sample Creating PollResponse Object**\n\n```java\n// Lets say we want to crete poll response with status as IN_PROGRESS\n\n PollResponse<String> inProgressPollResponse\n = new PollResponse<>(LongRunningOperationStatus.IN_PROGRESS, \"my custom response\");\n```\n\n**Code Sample Creating PollResponse Object with custom status**\n\n```java\n// Lets say we want to crete poll response with custom status as OTHER_CUSTOM_STATUS\n\n PollResponse<String> pollResponseWithCustomStatus\n = new PollResponse<>(LongRunningOperationStatus.fromString(\"OTHER_CUSTOM_STATUS\", false),\n \"my custom status response\");\n```"
|
|
metadata: {}
|
|
package: "com.azure.core.util.polling"
|
|
artifact: com.azure:azure-core:1.54.0
|