com.azure.core.util.polling

Class PollResponse<T>

java.lang.Object

com.azure.core.util.polling.PollResponse<T>

Type Parameters:

T - Type of poll response value.

public final class PollResponse<T>
extends Object

PollResponse represents a single response from a service for a long-running polling operation. It provides information such as the current 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<>(PollResponse.OperationStatus.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<>(PollResponse.OperationStatus.fromString("OTHER_CUSTOM_STATUS"), "my custom status response");

See Also:

PollResponse.OperationStatus, Poller

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PollResponse.OperationStatus An enum to represent all possible states that a long-running operation may find itself in.

Constructor Summary

Constructors

Constructor and Description
PollResponse(PollResponse.OperationStatus status, T value) Creates a new PollResponse with status and value.
PollResponse(PollResponse.OperationStatus status, T value, Duration retryAfter) Creates a new PollResponse with status, value and retryAfter.
PollResponse(PollResponse.OperationStatus status, T value, Duration retryAfter, Map<Object,Object> properties) Creates a new PollResponse with status, value, retryAfter and properties.

Method Summary

Modifier and Type	Method and Description
Map<Object,Object>	getProperties() A map of properties provided by the service that will be made available into the next poll operation.
Duration	getRetryAfter() Returns the delay the service has requested until the next polling operation is performed.
PollResponse.OperationStatus	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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PollResponse

public PollResponse(PollResponse.OperationStatus status,
                    T value,
                    Duration retryAfter,
                    Map<Object,Object> properties)

Creates a new PollResponse with status, value, retryAfter and properties.

Code Sample Creating PollResponse Object

// We can store some properties which we might need to execute poll Operation call.

Map<Object, Object> prop =  new HashMap<>();
prop.put("service.url", "http://azure.service.url");
prop.put("customer.id", 2635342);

// Lets say we want to crete poll response with status as IN_PROGRESS
PollResponse<String> inProgressPollResponse
    = new PollResponse<>(PollResponse.OperationStatus.IN_PROGRESS, "mycustom response",
    Duration.ofMillis(2000), prop);

Parameters:

status - Mandatory operation status as defined in PollResponse.OperationStatus.

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.

properties - A map of properties provided by the service that will be made available into the next poll operation.

Throws:

NullPointerException - If status is null.

PollResponse

public PollResponse(PollResponse.OperationStatus status,
                    T value,
                    Duration retryAfter)

Creates a new PollResponse with status, value and retryAfter.

Code Sample Creating PollResponse Object

// Lets say we want to crete poll response with status as IN_PROGRESS
// If nextRetry should happen after 2 seconds ...
PollResponse<String> inProgressPollResponse
    = new PollResponse<>(PollResponse.OperationStatus.IN_PROGRESS,  "my custom response",
    Duration.ofMillis(2000));

Parameters:

status - Mandatory operation status as defined in PollResponse.OperationStatus.

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.

Throws:

NullPointerException - If status is null.

PollResponse

public PollResponse(PollResponse.OperationStatus status,
                    T value)

Creates a new 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<>(PollResponse.OperationStatus.IN_PROGRESS, "my custom response");

Parameters:

status - Mandatory operation status as defined in PollResponse.OperationStatus.

value - The value as a result of poll operation. This can be any custom user-defined object. Null is also valid.

Throws:

NullPointerException - If status is null.

Method Detail

getStatus

public PollResponse.OperationStatus getStatus()

Represents the status of the long-running operation at the time the last polling operation finished successfully.

Returns:

A PollResponse.OperationStatus representing the result of the poll operation.

getValue

public T getValue()

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:

T result of poll operation.

getRetryAfter

public Duration getRetryAfter()

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:

Duration How long to wait before next retry.

getProperties

public Map<Object,Object> getProperties()

A map of properties provided by the service that will be made available into the next poll operation.

Returns:

Map of properties that were returned from the service, and which will be made available into the next poll operation.