Class GetPlanExecutionResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetPlanExecutionResponse.Builder,
GetPlanExecutionResponse>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal String
The actual recovery time that Region switch calculates for a plan execution.builder()
final String
comment()
A comment included on the plan execution.final Instant
endTime()
The time (UTC) when the plan execution ended.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final ExecutionAction
The plan execution action.final String
The plan execution action.final String
The execution identifier of a plan execution.final String
The Amazon Web Services Region for a plan execution.final ExecutionState
The plan execution state.final String
The plan execution state.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the StepStates property.final ExecutionMode
mode()
The plan execution mode.final String
The plan execution mode.final String
Specifies that you want to receive the next page of results.final Plan
plan()
The details of the Region switch plan.final String
planArn()
The Amazon Resource Name (ARN) of the plan.static Class
<? extends GetPlanExecutionResponse.Builder> final Instant
The time (UTC) when the plan execution started.The states of the steps in the plan execution.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Instant
The timestamp when the plan execution was last updated.final String
version()
The version for the plan.Methods inherited from class software.amazon.awssdk.services.arcregionswitch.model.ArcRegionSwitchResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
planArn
The Amazon Resource Name (ARN) of the plan.
- Returns:
- The Amazon Resource Name (ARN) of the plan.
-
executionId
The execution identifier of a plan execution.
- Returns:
- The execution identifier of a plan execution.
-
version
-
updatedAt
The timestamp when the plan execution was last updated.
- Returns:
- The timestamp when the plan execution was last updated.
-
comment
A comment included on the plan execution.
- Returns:
- A comment included on the plan execution.
-
startTime
The time (UTC) when the plan execution started.
- Returns:
- The time (UTC) when the plan execution started.
-
endTime
The time (UTC) when the plan execution ended.
- Returns:
- The time (UTC) when the plan execution ended.
-
mode
The plan execution mode. Valid values are
Practice
, for testing without making actual changes, orRecovery
, for actual traffic shifting and application recovery.If the service returns an enum value that is not available in the current SDK version,
mode
will returnExecutionMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommodeAsString()
.- Returns:
- The plan execution mode. Valid values are
Practice
, for testing without making actual changes, orRecovery
, for actual traffic shifting and application recovery. - See Also:
-
modeAsString
The plan execution mode. Valid values are
Practice
, for testing without making actual changes, orRecovery
, for actual traffic shifting and application recovery.If the service returns an enum value that is not available in the current SDK version,
mode
will returnExecutionMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommodeAsString()
.- Returns:
- The plan execution mode. Valid values are
Practice
, for testing without making actual changes, orRecovery
, for actual traffic shifting and application recovery. - See Also:
-
executionState
The plan execution state. Provides the state of a plan execution, for example, In Progress or Paused by Operator.
If the service returns an enum value that is not available in the current SDK version,
executionState
will returnExecutionState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromexecutionStateAsString()
.- Returns:
- The plan execution state. Provides the state of a plan execution, for example, In Progress or Paused by Operator.
- See Also:
-
executionStateAsString
The plan execution state. Provides the state of a plan execution, for example, In Progress or Paused by Operator.
If the service returns an enum value that is not available in the current SDK version,
executionState
will returnExecutionState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromexecutionStateAsString()
.- Returns:
- The plan execution state. Provides the state of a plan execution, for example, In Progress or Paused by Operator.
- See Also:
-
executionAction
The plan execution action. Valid values are
Activate
, to activate an Amazon Web Services Region, orDeactivate
, to deactivate a Region.If the service returns an enum value that is not available in the current SDK version,
executionAction
will returnExecutionAction.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromexecutionActionAsString()
.- Returns:
- The plan execution action. Valid values are
Activate
, to activate an Amazon Web Services Region, orDeactivate
, to deactivate a Region. - See Also:
-
executionActionAsString
The plan execution action. Valid values are
Activate
, to activate an Amazon Web Services Region, orDeactivate
, to deactivate a Region.If the service returns an enum value that is not available in the current SDK version,
executionAction
will returnExecutionAction.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromexecutionActionAsString()
.- Returns:
- The plan execution action. Valid values are
Activate
, to activate an Amazon Web Services Region, orDeactivate
, to deactivate a Region. - See Also:
-
executionRegion
The Amazon Web Services Region for a plan execution.
- Returns:
- The Amazon Web Services Region for a plan execution.
-
hasStepStates
public final boolean hasStepStates()For responses, this returns true if the service returned a value for the StepStates property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
stepStates
The states of the steps in the plan execution.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasStepStates()
method.- Returns:
- The states of the steps in the plan execution.
-
plan
The details of the Region switch plan.
- Returns:
- The details of the Region switch plan.
-
actualRecoveryTime
The actual recovery time that Region switch calculates for a plan execution. Actual recovery time includes the time for the plan to run added to the time elapsed until the application health alarms that you've specified are healthy again.
- Returns:
- The actual recovery time that Region switch calculates for a plan execution. Actual recovery time includes the time for the plan to run added to the time elapsed until the application health alarms that you've specified are healthy again.
-
nextToken
Specifies that you want to receive the next page of results. Valid only if you received a
nextToken
response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call'snextToken
response to request the next page of results.- Returns:
- Specifies that you want to receive the next page of results. Valid only if you received a
nextToken
response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call'snextToken
response to request the next page of results.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<GetPlanExecutionResponse.Builder,
GetPlanExecutionResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-