Class StepState

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

Represents the state of a step in a plan execution.

See Also:

  • Method Details

    • name

      public final String name()

      The name of a step in a workflow.

      Returns:
      The name of a step in a workflow.

    • status

      public final StepStatus status()

      The status of a step in a workflow. For example, a status might be Completed or Pending Approval.

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

      Returns:
      The status of a step in a workflow. For example, a status might be Completed or Pending Approval.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of a step in a workflow. For example, a status might be Completed or Pending Approval.

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

      Returns:
      The status of a step in a workflow. For example, a status might be Completed or Pending Approval.
      See Also:

    • startTime

      public final Instant startTime()

      The timestamp when a step started execution.

      Returns:
      The timestamp when a step started execution.

    • endTime

      public final Instant endTime()

      The timestamp when a step endeded execution.

      Returns:
      The timestamp when a step endeded execution.

    • stepMode

      public final ExecutionMode stepMode()

      The mode for a step execution. The mode can be Graceful or Ungraceful.

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

      Returns:
      The mode for a step execution. The mode can be Graceful or Ungraceful.
      See Also:

    • stepModeAsString

      public final String stepModeAsString()

      The mode for a step execution. The mode can be Graceful or Ungraceful.

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

      Returns:
      The mode for a step execution. The mode can be Graceful or Ungraceful.
      See Also:

    • toBuilder

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

    • builder

      public static StepState.Builder builder()

    • serializableBuilderClass

      public static Class<? extends StepState.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.