com.azure.core.util.polling

Class PollResponse.OperationStatus

java.lang.Object

com.azure.core.util.ExpandableStringEnum<PollResponse.OperationStatus>

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

Enclosing class:

PollResponse<T>

public static final class PollResponse.OperationStatus
extends ExpandableStringEnum<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.

Field Summary

Fields

Modifier and Type	Field and Description
static 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.
static PollResponse.OperationStatus	IN_PROGRESS Represents that this long-running operation is in progress and not yet complete.
static PollResponse.OperationStatus	NOT_STARTED Represents that polling has not yet started for this long-running operation.
static PollResponse.OperationStatus	SUCCESSFULLY_COMPLETED Represent that this long-running operation is completed successfully.
static PollResponse.OperationStatus	USER_CANCELLED Represents that this long-running operation is cancelled by user, however this is still considered as complete long-running operation.

Constructor Summary

Constructors

Constructor and Description
OperationStatus()

Method Summary

Modifier and Type	Method and Description
static PollResponse.OperationStatus	fromString(String name) Creates or finds a PollResponse.OperationStatus from its string representation.

Methods inherited from class com.azure.core.util.ExpandableStringEnum

equals, fromString, hashCode, toString, values

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

Constructor Detail

OperationStatus

public OperationStatus()

Method Detail

fromString

public static PollResponse.OperationStatus fromString(String name)

Creates or finds a PollResponse.OperationStatus from its string representation.

Parameters:

name - a name to look for

Returns:

the corresponding PollResponse.OperationStatus