T
- Type of poll response value.public final class PollResponse<T> extends Object
status
of the long-running operation, any
value
returned in the poll, as well as other useful information provided by the service.
Code Sample Creating PollResponse Object
// Lets say we want to crete poll response with status as IN_PROGRESS PollResponse<String> inProgressPollResponse = new PollResponse<>(LongRunningOperationStatus.IN_PROGRESS, "my custom response");
Code Sample Creating PollResponse Object with custom status
// Lets say we want to crete poll response with custom status as OTHER_CUSTOM_STATUS PollResponse<String> pollResponseWithCustomStatus = new PollResponse<>(LongRunningOperationStatus.fromString("OTHER_CUSTOM_STATUS", false), "my custom status response");
LongRunningOperationStatus
Constructor and Description |
---|
PollResponse(LongRunningOperationStatus status,
T value)
Creates a new
PollResponse with status and value. |
PollResponse(LongRunningOperationStatus status,
T value,
Duration retryAfter)
Creates a new
PollResponse with status, value, retryAfter and properties. |
Modifier and Type | Method and Description |
---|---|
Duration |
getRetryAfter()
Returns the delay the service has requested until the next polling operation is performed.
|
LongRunningOperationStatus |
getStatus()
Represents the status of the long-running operation at the time the last polling operation finished successfully.
|
T |
getValue()
The value returned as a result of the last successful poll operation.
|
public PollResponse(LongRunningOperationStatus status, T value, Duration retryAfter)
PollResponse
with status, value, retryAfter and properties.
Code Sample Creating PollResponse Object
// Lets say we want to crete poll response with status as IN_PROGRESS PollResponse<String> inProgressPollResponse = new PollResponse<>(LongRunningOperationStatus.IN_PROGRESS, "mycustom response", Duration.ofMillis(2000));
status
- Mandatory operation status as defined in LongRunningOperationStatus
.value
- The value as a result of poll operation. This can be any custom user-defined object. Null is also
valid.retryAfter
- Represents the delay the service has requested until the next polling operation is performed. A
null
, zero or negative value will be taken to mean that the poller should determine on its
own when the next poll operation is to occur.NullPointerException
- If status
is null
.public PollResponse(LongRunningOperationStatus status, T value)
PollResponse
with status and value.
Code Sample Creating PollResponse Object
// Lets say we want to crete poll response with status as IN_PROGRESS PollResponse<String> inProgressPollResponse = new PollResponse<>(LongRunningOperationStatus.IN_PROGRESS, "my custom response");
status
- Mandatory operation status as defined in LongRunningOperationStatus
.value
- The value as a result of poll operation. This can be any custom user-defined object. Null is also
valid.NullPointerException
- If status
is null
.public LongRunningOperationStatus getStatus()
LongRunningOperationStatus
representing the result of the poll operation.public T getValue()
public Duration getRetryAfter()
Copyright © 2021 Microsoft Corporation. All rights reserved.