Class AbbreviatedExecution

java.lang.Object
software.amazon.awssdk.services.arcregionswitch.model.AbbreviatedExecution
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AbbreviatedExecution.Builder,AbbreviatedExecution>
@Generated("software.amazon.awssdk:codegen") public final class AbbreviatedExecution extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AbbreviatedExecution.Builder,AbbreviatedExecution>

A summarized representation of a plan execution. This structure contains key information about an execution without all the detailed step data.

See Also:

  • 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()

      An optional comment about the plan execution.

      Returns:
      An optional comment about the plan execution.

    • startTime

      public final Instant startTime()

      The timestamp when the plan execution was started.

      Returns:
      The timestamp when the plan execution was started.

    • endTime

      public final Instant endTime()

      The timestamp when the plan execution was ended.

      Returns:
      The timestamp when the plan execution was 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.

    • 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.

    • toBuilder

      public AbbreviatedExecution.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<AbbreviatedExecution.Builder,AbbreviatedExecution>
      Returns:
      a builder for type T

    • builder

      public static AbbreviatedExecution.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)

    • 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.