Class WorkflowExecutionMetadata

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

Metadata that includes details and status from this runtime instance of the workflow.

See Also:

  • Method Details

    • workflowBuildVersionArn

      public final String workflowBuildVersionArn()

      The Amazon Resource Name (ARN) of the workflow resource build version that ran.

      Returns:
      The Amazon Resource Name (ARN) of the workflow resource build version that ran.

    • workflowExecutionId

      public final String workflowExecutionId()

      Unique identifier that Image Builder assigns to keep track of runtime resources each time it runs a workflow.

      Returns:
      Unique identifier that Image Builder assigns to keep track of runtime resources each time it runs a workflow.

    • type

      public final WorkflowType type()

      Indicates what type of workflow that Image Builder ran for this runtime instance of the workflow.

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

      Returns:
      Indicates what type of workflow that Image Builder ran for this runtime instance of the workflow.
      See Also:

    • typeAsString

      public final String typeAsString()

      Indicates what type of workflow that Image Builder ran for this runtime instance of the workflow.

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

      Returns:
      Indicates what type of workflow that Image Builder ran for this runtime instance of the workflow.
      See Also:

    • status

      public final WorkflowExecutionStatus status()

      The current runtime status for this workflow.

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

      Returns:
      The current runtime status for this workflow.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current runtime status for this workflow.

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

      Returns:
      The current runtime status for this workflow.
      See Also:

    • message

      public final String message()

      The runtime output message from the workflow, if applicable.

      Returns:
      The runtime output message from the workflow, if applicable.

    • totalStepCount

      public final Integer totalStepCount()

      The total number of steps that the workflow document defines for this runtime instance of the workflow. Image Builder sets this count before any steps run. The sum of succeeded, skipped, and failed steps only reaches this total if every step finishes in one of those states.

      Returns:
      The total number of steps that the workflow document defines for this runtime instance of the workflow. Image Builder sets this count before any steps run. The sum of succeeded, skipped, and failed steps only reaches this total if every step finishes in one of those states.

    • totalStepsSucceeded

      public final Integer totalStepsSucceeded()

      A runtime count for the number of steps in the workflow that ran successfully.

      Returns:
      A runtime count for the number of steps in the workflow that ran successfully.

    • totalStepsFailed

      public final Integer totalStepsFailed()

      A runtime count for the number of steps in the workflow that failed.

      Returns:
      A runtime count for the number of steps in the workflow that failed.

    • totalStepsSkipped

      public final Integer totalStepsSkipped()

      A runtime count for the number of steps in the workflow that were skipped.

      Returns:
      A runtime count for the number of steps in the workflow that were skipped.

    • startTime

      public final String startTime()

      The timestamp when the runtime instance of this workflow started.

      Returns:
      The timestamp when the runtime instance of this workflow started.

    • endTime

      public final String endTime()

      The timestamp when this runtime instance of the workflow finished.

      Returns:
      The timestamp when this runtime instance of the workflow finished.

    • parallelGroup

      public final String parallelGroup()

      The name of the test group that included the test workflow resource at runtime.

      Returns:
      The name of the test group that included the test workflow resource at runtime.

    • retried

      public final Boolean retried()

      Indicates whether a retry of the image build superseded this runtime instance of the workflow. When you retry a failed image build, Image Builder sets this flag to true on the original workflow executions that the retry re-ran.

      Returns:
      Indicates whether a retry of the image build superseded this runtime instance of the workflow. When you retry a failed image build, Image Builder sets this flag to true on the original workflow executions that the retry re-ran.

    • toBuilder

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

    • builder

      public static WorkflowExecutionMetadata.Builder builder()

    • serializableBuilderClass

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