Class GetWorkflowExecutionResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.imagebuilder.model.ImagebuilderResponse
software.amazon.awssdk.services.imagebuilder.model.GetWorkflowExecutionResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetWorkflowExecutionResponse.Builder,GetWorkflowExecutionResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetWorkflowExecutionResponse extends ImagebuilderResponse implements ToCopyableBuilder<GetWorkflowExecutionResponse.Builder,GetWorkflowExecutionResponse>

  • Method Details

    • requestId

      public final String requestId()

      The request ID that uniquely identifies this request.

      Returns:
      The request ID that uniquely identifies this request.

    • workflowBuildVersionArn

      public final String workflowBuildVersionArn()

      The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource that defines the specified runtime instance of the workflow.

      Returns:
      The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource that defines the specified runtime instance of the workflow.

    • workflowExecutionId

      public final String workflowExecutionId()

      The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.

      Returns:
      The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.

    • imageBuildVersionArn

      public final String imageBuildVersionArn()

      The Amazon Resource Name (ARN) of the image resource build version that the specified runtime instance of the workflow created.

      Returns:
      The Amazon Resource Name (ARN) of the image resource build version that the specified runtime instance of the workflow created.

    • type

      public final WorkflowType type()

      The type of workflow that Image Builder ran for the specified 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:
      The type of workflow that Image Builder ran for the specified runtime instance of the workflow.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of workflow that Image Builder ran for the specified 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:
      The type of workflow that Image Builder ran for the specified runtime instance of the workflow.
      See Also:

    • status

      public final WorkflowExecutionStatus status()

      The current runtime status for the specified runtime instance of the 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 the specified runtime instance of the workflow.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current runtime status for the specified runtime instance of the 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 the specified runtime instance of the workflow.
      See Also:

    • message

      public final String message()

      The output message from the specified runtime instance of the workflow, if applicable.

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

    • totalStepCount

      public final Integer totalStepCount()

      The total number of steps in the specified runtime instance of the workflow that ran. This number should equal the sum of the step counts for steps that succeeded, were skipped, and failed.

      Returns:
      The total number of steps in the specified runtime instance of the workflow that ran. This number should equal the sum of the step counts for steps that succeeded, were skipped, and failed.

    • totalStepsSucceeded

      public final Integer totalStepsSucceeded()

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

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

    • totalStepsFailed

      public final Integer totalStepsFailed()

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

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

    • totalStepsSkipped

      public final Integer totalStepsSkipped()

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

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

    • startTime

      public final String startTime()

      The timestamp when the specified runtime instance of the workflow started.

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

    • endTime

      public final String endTime()

      The timestamp when the specified runtime instance of the workflow finished.

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

    • parallelGroup

      public final String parallelGroup()

      Test workflows are defined within named runtime groups. The parallel group is a named group that contains one or more test workflows.

      Returns:
      Test workflows are defined within named runtime groups. The parallel group is a named group that contains one or more test workflows.

    • toBuilder

      public GetWorkflowExecutionResponse.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<GetWorkflowExecutionResponse.Builder,GetWorkflowExecutionResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetWorkflowExecutionResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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