136 строки
12 KiB
YAML
136 строки
12 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.core.util.polling.LongRunningOperationStatus"
|
|
fullName: "com.azure.core.util.polling.LongRunningOperationStatus"
|
|
name: "LongRunningOperationStatus"
|
|
nameWithType: "LongRunningOperationStatus"
|
|
summary: "An enum to represent all possible states that a long-running operation may find itself in."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.core.util.ExpandableStringEnum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>fromString(java.lang.String,java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>fromString&text=<T>fromString\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>values(java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>values&text=<T>values\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.equals(java.lang.Object)?alt=com.azure.core.util.ExpandableStringEnum.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.getValue()?alt=com.azure.core.util.ExpandableStringEnum.getValue&text=getValue\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.hashCode()?alt=com.azure.core.util.ExpandableStringEnum.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.toString()?alt=com.azure.core.util.ExpandableStringEnum.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **LongRunningOperationStatus**</br> extends <xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.polling.LongRunningOperationStatus?alt=com.azure.core.util.polling.LongRunningOperationStatus&text=LongRunningOperationStatus\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.core.util.polling.LongRunningOperationStatus.LongRunningOperationStatus()"
|
|
fullName: "com.azure.core.util.polling.LongRunningOperationStatus.LongRunningOperationStatus()"
|
|
name: "LongRunningOperationStatus()"
|
|
nameWithType: "LongRunningOperationStatus.LongRunningOperationStatus()"
|
|
summary: "Creates a new instance of <xref uid=\"com.azure.core.util.polling.LongRunningOperationStatus\" data-throw-if-not-resolved=\"false\" data-raw-source=\"LongRunningOperationStatus\"></xref> without a <xref uid=\"com.azure.core.util.polling.LongRunningOperationStatus.toString*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#toString()\"></xref> value."
|
|
deprecatedTag: "Use one of the constants or the <xref uid=\"com.azure.core.util.polling.LongRunningOperationStatus.fromString(java.lang.String,boolean)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#fromString(String, boolean)\"></xref> factory method."
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public LongRunningOperationStatus()"
|
|
desc: "Creates a new instance of <xref uid=\"com.azure.core.util.polling.LongRunningOperationStatus\" data-throw-if-not-resolved=\"false\" data-raw-source=\"LongRunningOperationStatus\"></xref> without a <xref uid=\"com.azure.core.util.polling.LongRunningOperationStatus.toString*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#toString()\"></xref> value.\n\nThis constructor shouldn't be called as it will produce a <xref uid=\"com.azure.core.util.polling.LongRunningOperationStatus\" data-throw-if-not-resolved=\"false\" data-raw-source=\"LongRunningOperationStatus\"></xref> which doesn't have a String enum value."
|
|
hasDeprecatedTag: true
|
|
fields:
|
|
- uid: "com.azure.core.util.polling.LongRunningOperationStatus.FAILED"
|
|
fullName: "com.azure.core.util.polling.LongRunningOperationStatus.FAILED"
|
|
name: "FAILED"
|
|
nameWithType: "LongRunningOperationStatus.FAILED"
|
|
summary: "Represents that the long-running operation has failed to successfully complete, however this is still considered as complete long-running operation, meaning that the <xref uid=\"com.azure.core.util.polling.PollerFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PollerFlux\"></xref> instance will report that it is complete."
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
type: "<xref href=\"com.azure.core.util.polling.LongRunningOperationStatus?alt=com.azure.core.util.polling.LongRunningOperationStatus&text=LongRunningOperationStatus\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static final LongRunningOperationStatus FAILED"
|
|
desc: "Represents that the long-running operation has failed to successfully complete, however this is still considered as complete long-running operation, meaning that the <xref uid=\"com.azure.core.util.polling.PollerFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PollerFlux\"></xref> instance will report that it is complete."
|
|
- uid: "com.azure.core.util.polling.LongRunningOperationStatus.IN_PROGRESS"
|
|
fullName: "com.azure.core.util.polling.LongRunningOperationStatus.IN_PROGRESS"
|
|
name: "IN_PROGRESS"
|
|
nameWithType: "LongRunningOperationStatus.IN_PROGRESS"
|
|
summary: "Represents that the long-running operation is in progress and not yet complete."
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
type: "<xref href=\"com.azure.core.util.polling.LongRunningOperationStatus?alt=com.azure.core.util.polling.LongRunningOperationStatus&text=LongRunningOperationStatus\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static final LongRunningOperationStatus IN_PROGRESS"
|
|
desc: "Represents that the long-running operation is in progress and not yet complete."
|
|
- uid: "com.azure.core.util.polling.LongRunningOperationStatus.NOT_STARTED"
|
|
fullName: "com.azure.core.util.polling.LongRunningOperationStatus.NOT_STARTED"
|
|
name: "NOT_STARTED"
|
|
nameWithType: "LongRunningOperationStatus.NOT_STARTED"
|
|
summary: "Represents that polling has not yet started for this long-running operation."
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
type: "<xref href=\"com.azure.core.util.polling.LongRunningOperationStatus?alt=com.azure.core.util.polling.LongRunningOperationStatus&text=LongRunningOperationStatus\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static final LongRunningOperationStatus NOT_STARTED"
|
|
desc: "Represents that polling has not yet started for this long-running operation."
|
|
- uid: "com.azure.core.util.polling.LongRunningOperationStatus.SUCCESSFULLY_COMPLETED"
|
|
fullName: "com.azure.core.util.polling.LongRunningOperationStatus.SUCCESSFULLY_COMPLETED"
|
|
name: "SUCCESSFULLY_COMPLETED"
|
|
nameWithType: "LongRunningOperationStatus.SUCCESSFULLY_COMPLETED"
|
|
summary: "Represent that the long-running operation is completed successfully."
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
type: "<xref href=\"com.azure.core.util.polling.LongRunningOperationStatus?alt=com.azure.core.util.polling.LongRunningOperationStatus&text=LongRunningOperationStatus\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static final LongRunningOperationStatus SUCCESSFULLY_COMPLETED"
|
|
desc: "Represent that the long-running operation is completed successfully."
|
|
- uid: "com.azure.core.util.polling.LongRunningOperationStatus.USER_CANCELLED"
|
|
fullName: "com.azure.core.util.polling.LongRunningOperationStatus.USER_CANCELLED"
|
|
name: "USER_CANCELLED"
|
|
nameWithType: "LongRunningOperationStatus.USER_CANCELLED"
|
|
summary: "Represents that the long-running operation is cancelled by user, however this is still considered as complete long-running operation."
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
type: "<xref href=\"com.azure.core.util.polling.LongRunningOperationStatus?alt=com.azure.core.util.polling.LongRunningOperationStatus&text=LongRunningOperationStatus\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static final LongRunningOperationStatus USER_CANCELLED"
|
|
desc: "Represents that the long-running operation is cancelled by user, however this is still considered as complete long-running operation."
|
|
methods:
|
|
- uid: "com.azure.core.util.polling.LongRunningOperationStatus.fromString(java.lang.String,boolean)"
|
|
fullName: "com.azure.core.util.polling.LongRunningOperationStatus.fromString(String name, boolean isComplete)"
|
|
name: "fromString(String name, boolean isComplete)"
|
|
nameWithType: "LongRunningOperationStatus.fromString(String name, boolean isComplete)"
|
|
summary: "Creates or finds a <xref uid=\"com.azure.core.util.polling.LongRunningOperationStatus\" data-throw-if-not-resolved=\"false\" data-raw-source=\"LongRunningOperationStatus\"></xref> from its string representation."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "a name to look for"
|
|
name: "name"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "a status to indicate if the operation is complete or not."
|
|
name: "isComplete"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static LongRunningOperationStatus fromString(String name, boolean isComplete)"
|
|
desc: "Creates or finds a <xref uid=\"com.azure.core.util.polling.LongRunningOperationStatus\" data-throw-if-not-resolved=\"false\" data-raw-source=\"LongRunningOperationStatus\"></xref> from its string representation."
|
|
returns:
|
|
description: "the corresponding <xref uid=\"com.azure.core.util.polling.LongRunningOperationStatus\" data-throw-if-not-resolved=\"false\" data-raw-source=\"LongRunningOperationStatus\"></xref>"
|
|
type: "<xref href=\"com.azure.core.util.polling.LongRunningOperationStatus?alt=com.azure.core.util.polling.LongRunningOperationStatus&text=LongRunningOperationStatus\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.core.util.polling.LongRunningOperationStatus.isComplete()"
|
|
fullName: "com.azure.core.util.polling.LongRunningOperationStatus.isComplete()"
|
|
name: "isComplete()"
|
|
nameWithType: "LongRunningOperationStatus.isComplete()"
|
|
summary: "Returns a boolean to represent if the operation is in a completed state or not."
|
|
syntax: "public boolean isComplete()"
|
|
desc: "Returns a boolean to represent if the operation is in a completed state or not."
|
|
returns:
|
|
description: "True if the operation is in a completed state, otherwise false."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "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`."
|
|
metadata: {}
|
|
package: "com.azure.core.util.polling"
|
|
artifact: com.azure:azure-core:1.52.0
|