Class WorkflowStepMetadata

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

Runtime details and status for the workflow step.

See Also:

  • Method Details

    • stepExecutionId

      public final String stepExecutionId()

      A unique identifier for the workflow step, assigned at runtime.

      Returns:
      A unique identifier for the workflow step, assigned at runtime.

    • name

      public final String name()

      The name of the workflow step.

      Returns:
      The name of the workflow step.

    • description

      public final String description()

      Description of the workflow step.

      Returns:
      Description of the workflow step.

    • action

      public final String action()

      The step action name.

      Returns:
      The step action name.

    • status

      public final WorkflowStepExecutionStatus status()

      Runtime status for the workflow step.

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

      Returns:
      Runtime status for the workflow step.
      See Also:

    • statusAsString

      public final String statusAsString()

      Runtime status for the workflow step.

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

      Returns:
      Runtime status for the workflow step.
      See Also:

    • rollbackStatus

      public final WorkflowStepExecutionRollbackStatus rollbackStatus()

      Reports on the rollback status of the step, if applicable.

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

      Returns:
      Reports on the rollback status of the step, if applicable.
      See Also:

    • rollbackStatusAsString

      public final String rollbackStatusAsString()

      Reports on the rollback status of the step, if applicable.

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

      Returns:
      Reports on the rollback status of the step, if applicable.
      See Also:

    • message

      public final String message()

      Detailed output message that the workflow step provides at runtime.

      Returns:
      Detailed output message that the workflow step provides at runtime.

    • inputs

      public final String inputs()

      Input parameters that Image Builder provides for the workflow step, as a JSON-encoded string.

      Returns:
      Input parameters that Image Builder provides for the workflow step, as a JSON-encoded string.

    • outputs

      public final String outputs()

      The output values that the workflow step produced for this runtime instance of the workflow, as a JSON-encoded string. For example, a step that launches an instance outputs the instance ID. If the step failed, this field contains the error message.

      Returns:
      The output values that the workflow step produced for this runtime instance of the workflow, as a JSON-encoded string. For example, a step that launches an instance outputs the instance ID. If the step failed, this field contains the error message.

    • startTime

      public final String startTime()

      The timestamp when the workflow step started.

      Returns:
      The timestamp when the workflow step started.

    • endTime

      public final String endTime()

      The timestamp when the workflow step finished.

      Returns:
      The timestamp when the workflow step finished.

    • attemptNumber

      public final Integer attemptNumber()

      The current attempt number for the workflow step. The first run is attempt one. The number increases by one for each retry.

      Returns:
      The current attempt number for the workflow step. The first run is attempt one. The number increases by one for each retry.

    • maxAttempts

      public final Integer maxAttempts()

      The maximum number of attempts allowed for the workflow step, based on the retry configuration in the workflow document. If the step doesn't configure retries, the maximum is one attempt.

      Returns:
      The maximum number of attempts allowed for the workflow step, based on the retry configuration in the workflow document. If the step doesn't configure retries, the maximum is one attempt.

    • toBuilder

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

    • builder

      public static WorkflowStepMetadata.Builder builder()

    • serializableBuilderClass

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