Package com.azure.core.util.polling

Class 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<>(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");
    See Also:
    LongRunningOperationStatus

    • Constructor Detail

      • PollResponse

        public PollResponse​(LongRunningOperationStatus status,
                    T value,
                    Duration retryAfter)
        Creates a new 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));
        Parameters:
        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.
        Throws:
        NullPointerException - If status is null.

      • PollResponse

        public PollResponse​(LongRunningOperationStatus 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<>(LongRunningOperationStatus.IN_PROGRESS, "my custom response");
        Parameters:
        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.
        Throws:
        NullPointerException - If status is null.

    • Method Detail

      • 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.