Class GetPlanExecutionResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.arcregionswitch.model.ArcRegionSwitchResponse
software.amazon.awssdk.services.arcregionswitch.model.GetPlanExecutionResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetPlanExecutionResponse.Builder,GetPlanExecutionResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetPlanExecutionResponse extends ArcRegionSwitchResponse implements ToCopyableBuilder<GetPlanExecutionResponse.Builder,GetPlanExecutionResponse>

  • Method Details

    • planArn

      public final String planArn()

      The Amazon Resource Name (ARN) of the plan.

      Returns:
      The Amazon Resource Name (ARN) of the plan.

    • executionId

      public final String executionId()

      The execution identifier of a plan execution.

      Returns:
      The execution identifier of a plan execution.

    • version

      public final String version()

      The version for the plan.

      Returns:
      The version for the plan.

    • updatedAt

      public final Instant updatedAt()

      The timestamp when the plan execution was last updated.

      Returns:
      The timestamp when the plan execution was last updated.

    • comment

      public final String comment()

      A comment included on the plan execution.

      Returns:
      A comment included on the plan execution.

    • startTime

      public final Instant startTime()

      The time (UTC) when the plan execution started.

      Returns:
      The time (UTC) when the plan execution started.

    • endTime

      public final Instant endTime()

      The time (UTC) when the plan execution ended.

      Returns:
      The time (UTC) when the plan execution ended.

    • mode

      public final ExecutionMode mode()

      The plan execution mode. Valid values are Practice, for testing without making actual changes, or Recovery, 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 return ExecutionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().

      Returns:
      The plan execution mode. Valid values are Practice, for testing without making actual changes, or Recovery, for actual traffic shifting and application recovery.
      See Also:

    • modeAsString

      public final String modeAsString()

      The plan execution mode. Valid values are Practice, for testing without making actual changes, or Recovery, 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 return ExecutionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().

      Returns:
      The plan execution mode. Valid values are Practice, for testing without making actual changes, or Recovery, for actual traffic shifting and application recovery.
      See Also:

    • executionState

      public final ExecutionState 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 return ExecutionState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from executionStateAsString().

      Returns:
      The plan execution state. Provides the state of a plan execution, for example, In Progress or Paused by Operator.
      See Also:

    • executionStateAsString

      public final String 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 return ExecutionState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from executionStateAsString().

      Returns:
      The plan execution state. Provides the state of a plan execution, for example, In Progress or Paused by Operator.
      See Also:

    • executionAction

      public final ExecutionAction executionAction()

      The plan execution action. Valid values are Activate, to activate an Amazon Web Services Region, or Deactivate, to deactivate a Region.

      If the service returns an enum value that is not available in the current SDK version, executionAction will return ExecutionAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from executionActionAsString().

      Returns:
      The plan execution action. Valid values are Activate, to activate an Amazon Web Services Region, or Deactivate, to deactivate a Region.
      See Also:

    • executionActionAsString

      public final String executionActionAsString()

      The plan execution action. Valid values are Activate, to activate an Amazon Web Services Region, or Deactivate, to deactivate a Region.

      If the service returns an enum value that is not available in the current SDK version, executionAction will return ExecutionAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from executionActionAsString().

      Returns:
      The plan execution action. Valid values are Activate, to activate an Amazon Web Services Region, or Deactivate, to deactivate a Region.
      See Also:

    • executionRegion

      public final String 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 the isEmpty() 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

      public final List<StepState> 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

      public final Plan plan()

      The details of the Region switch plan.

      Returns:
      The details of the Region switch plan.

    • actualRecoveryTime

      public final String 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

      public final String 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's nextToken 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's nextToken response to request the next page of results.

    • toBuilder

      public GetPlanExecutionResponse.Builder 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 interface ToCopyableBuilder<GetPlanExecutionResponse.Builder,GetPlanExecutionResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetPlanExecutionResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetPlanExecutionResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.