Enum StudioComponentState
- All Implemented Interfaces:
Serializable
,Comparable<StudioComponentState>
The current state of the studio component resource.
While a studio component is being created, modified, or deleted, its state will be CREATE_IN_PROGRESS
,
UPDATE_IN_PROGRESS
, or DELETE_IN_PROGRESS
.
These are called transition states.
No modifications may be made to the studio component while it is in a transition state.
If creation of the resource fails, the state will change to CREATE_FAILED
. The resource
StatusCode
and StatusMessage
will provide more information of why creation failed. The
resource in this state will automatically be deleted from your account after a period of time.
If updating the resource fails, the state will change to UPDATE_FAILED
. The resource
StatusCode
and StatusMessage
will provide more information of why the update failed. The
resource will be returned to the state it was in when the update request was invoked.
If deleting the resource fails, the state will change to DELETE_FAILED
. The resource
StatusCode
and StatusMessage
will provide more information of why the update failed. The
resource will be returned to the state it was in when the update request was invoked. After the resource is deleted
successfully, it will change to the DELETED
state. The resource will no longer count against service
quotas and cannot be used or acted upon any futher. It will be removed from your account after a period of time.
-
Enum Constant Summary
Enum ConstantDescription -
Method Summary
Modifier and TypeMethodDescriptionstatic StudioComponentState
Use this in place of valueOf to convert the raw string returned by the service into the enum value.static Set
<StudioComponentState> toString()
static StudioComponentState
Returns the enum constant of this type with the specified name.static StudioComponentState[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
CREATE_IN_PROGRESS
-
READY
-
UPDATE_IN_PROGRESS
-
DELETE_IN_PROGRESS
-
DELETED
-
DELETE_FAILED
-
CREATE_FAILED
-
UPDATE_FAILED
-
UNKNOWN_TO_SDK_VERSION
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- 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 nameNullPointerException
- if the argument is null
-
toString
- Overrides:
toString
in classEnum<StudioComponentState>
-
fromValue
Use this in place of valueOf to convert the raw string returned by the service into the enum value.- Parameters:
value
- real value- Returns:
- StudioComponentState corresponding to the value
-
knownValues
Use this in place ofvalues()
to return aSet
of all values known to the SDK. This will return all known enum values exceptUNKNOWN_TO_SDK_VERSION
.- Returns:
- a
Set
of knownStudioComponentState
s
-