com.azure.core.util.polling

Enum PollResponse.OperationStatus

java.lang.Object

java.lang.Enum<PollResponse.OperationStatus>

com.azure.core.util.polling.PollResponse.OperationStatus

All Implemented Interfaces:

Serializable, Comparable<PollResponse.OperationStatus>

Enclosing class:

PollResponse<T>

public static enum PollResponse.OperationStatus
extends Enum<PollResponse.OperationStatus>

An enum to represent all possible states that a long-running operation may find itself in. The poll operation is considered complete when the status is one of SUCCESSFULLY_COMPLETED, USER_CANCELLED or FAILED.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FAILED Represents that this long-running operation has failed to successfully complete, however this is still considered as complete long-running operation, meaning that the Poller instance will report that it is complete.
IN_PROGRESS Represents that this long-running operation is in progress and not yet complete.
NOT_STARTED Represents that polling has not yet started for this long-running operation.
OTHER When long-running operation status could not be represented by any status in PollResponse.OperationStatus, this status represents a custom status Azure service could be in.
SUCCESSFULLY_COMPLETED Represent that this long-running operation is completed successfully.
USER_CANCELLED Represents that this long-running operation is cancelled by user, however this is still considered as complete long-running operation.

Method Summary

Modifier and Type	Method and Description
static PollResponse.OperationStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static PollResponse.OperationStatus[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NOT_STARTED

public static final PollResponse.OperationStatus NOT_STARTED

Represents that polling has not yet started for this long-running operation.

IN_PROGRESS

public static final PollResponse.OperationStatus IN_PROGRESS

Represents that this long-running operation is in progress and not yet complete.

SUCCESSFULLY_COMPLETED

public static final PollResponse.OperationStatus SUCCESSFULLY_COMPLETED

Represent that this long-running operation is completed successfully.

FAILED

public static final PollResponse.OperationStatus FAILED

Represents that this long-running operation has failed to successfully complete, however this is still considered as complete long-running operation, meaning that the Poller instance will report that it is complete.

USER_CANCELLED

public static final PollResponse.OperationStatus USER_CANCELLED

Represents that this long-running operation is cancelled by user, however this is still considered as complete long-running operation.

OTHER

public static final PollResponse.OperationStatus OTHER

When long-running operation status could not be represented by any status in PollResponse.OperationStatus, this status represents a custom status Azure service could be in. This custom status is not considered as complete long-running operation. It must have valid value for otherStatus as String.

Method Detail

values

public static PollResponse.OperationStatus[] values()

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PollResponse.OperationStatus valueOf(String name)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null