Package com.azure.core.util.polling
Class LongRunningOperationStatus
java.lang.Object
com.azure.core.util.ExpandableStringEnum<LongRunningOperationStatus>
com.azure.core.util.polling.LongRunningOperationStatus
public final class LongRunningOperationStatus
extends ExpandableStringEnum<LongRunningOperationStatus>
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
Modifier and TypeFieldDescriptionstatic final LongRunningOperationStatus
Represents that the long-running operation has failed to successfully complete, however this is still considered as complete long-running operation, meaning that thePollerFlux
instance will report that it is complete.static final LongRunningOperationStatus
Represents that the long-running operation is in progress and not yet complete.static final LongRunningOperationStatus
Represents that polling has not yet started for this long-running operation.static final LongRunningOperationStatus
Represent that the long-running operation is completed successfully.static final LongRunningOperationStatus
Represents that the long-running operation is cancelled by user, however this is still considered as complete long-running operation. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic LongRunningOperationStatus
fromString
(String name, boolean isComplete) Creates or finds aLongRunningOperationStatus
from its string representation.boolean
Returns a boolean to represent if the operation is in a completed state or not.Methods inherited from class com.azure.core.util.ExpandableStringEnum
equals, fromString, hashCode, toString, values
-
Field Details
-
NOT_STARTED
Represents that polling has not yet started for this long-running operation. -
IN_PROGRESS
Represents that the long-running operation is in progress and not yet complete. -
SUCCESSFULLY_COMPLETED
Represent that the long-running operation is completed successfully. -
FAILED
Represents that the long-running operation has failed to successfully complete, however this is still considered as complete long-running operation, meaning that thePollerFlux
instance will report that it is complete. -
USER_CANCELLED
Represents that the long-running operation is cancelled by user, however this is still considered as complete long-running operation.
-
-
Constructor Details
-
LongRunningOperationStatus
Deprecated.Use one of the constants or thefromString(String, boolean)
factory method.Creates a new instance ofLongRunningOperationStatus
without aExpandableStringEnum.toString()
value.This constructor shouldn't be called as it will produce a
LongRunningOperationStatus
which doesn't have a String enum value.
-
-
Method Details
-
fromString
Creates or finds aLongRunningOperationStatus
from its string representation.- Parameters:
name
- a name to look forisComplete
- a status to indicate if the operation is complete or not.- Returns:
- the corresponding
LongRunningOperationStatus
- Throws:
IllegalArgumentException
- ifname
matches a pre-configuredLongRunningOperationStatus
butisComplete
doesn't match its pre-configured complete status.
-
isComplete
public boolean isComplete()Returns a boolean to represent if the operation is in a completed state or not.- Returns:
- True if the operation is in a completed state, otherwise false.
-
fromString(String, boolean)
factory method.