Class WorkflowStepSummary

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

The summary of the step in a migration workflow.

See Also:

  • Method Details

    • stepId

      public final String stepId()

      The ID of the step.

      Returns:
      The ID of the step.

    • name

      public final String name()

      The name of the step.

      Returns:
      The name of the step.

    • stepActionType

      public final StepActionType stepActionType()

      The action type of the step. You must run and update the status of a manual step for the workflow to continue after the completion of the step.

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

      Returns:
      The action type of the step. You must run and update the status of a manual step for the workflow to continue after the completion of the step.
      See Also:

    • stepActionTypeAsString

      public final String stepActionTypeAsString()

      The action type of the step. You must run and update the status of a manual step for the workflow to continue after the completion of the step.

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

      Returns:
      The action type of the step. You must run and update the status of a manual step for the workflow to continue after the completion of the step.
      See Also:

    • owner

      public final Owner owner()

      The owner of the step.

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

      Returns:
      The owner of the step.
      See Also:

    • ownerAsString

      public final String ownerAsString()

      The owner of the step.

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

      Returns:
      The owner of the step.
      See Also:

    • hasPrevious

      public final boolean hasPrevious()
      For responses, this returns true if the service returned a value for the Previous 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.

    • previous

      public final List<String> previous()

      The previous step.

      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 hasPrevious() method.

      Returns:
      The previous step.

    • hasNext

      public final boolean hasNext()
      For responses, this returns true if the service returned a value for the Next 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.

    • next

      public final List<String> next()

      The next step.

      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 hasNext() method.

      Returns:
      The next step.

    • status

      public final StepStatus status()

      The status of the step.

      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 the step.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the step.

      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 the step.
      See Also:

    • statusMessage

      public final String statusMessage()

      The status message of the migration workflow.

      Returns:
      The status message of the migration workflow.

    • noOfSrvCompleted

      public final Integer noOfSrvCompleted()

      The number of servers that have been migrated.

      Returns:
      The number of servers that have been migrated.

    • noOfSrvFailed

      public final Integer noOfSrvFailed()

      The number of servers that have failed to migrate.

      Returns:
      The number of servers that have failed to migrate.

    • totalNoOfSrv

      public final Integer totalNoOfSrv()

      The total number of servers that have been migrated.

      Returns:
      The total number of servers that have been migrated.

    • description

      public final String description()

      The description of the step.

      Returns:
      The description of the step.

    • scriptLocation

      public final String scriptLocation()

      The location of the script.

      Returns:
      The location of the script.

    • toBuilder

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

    • builder

      public static WorkflowStepSummary.Builder builder()

    • serializableBuilderClass

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