Class GetWorkflowStepExecutionResponse

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.GetWorkflowStepExecutionResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetWorkflowStepExecutionResponse.Builder,GetWorkflowStepExecutionResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetWorkflowStepExecutionResponse extends ImagebuilderResponse implements ToCopyableBuilder<GetWorkflowStepExecutionResponse.Builder,GetWorkflowStepExecutionResponse>

  • Method Details

    • requestId

      public final String requestId()

      The request ID that uniquely identifies this request.

      Returns:
      The request ID that uniquely identifies this request.

    • stepExecutionId

      public final String stepExecutionId()

      The unique identifier for the runtime instance of the workflow step that you specified in the request.

      Returns:
      The unique identifier for the runtime instance of the workflow step that you specified in the request.

    • workflowBuildVersionArn

      public final String workflowBuildVersionArn()

      The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource that defines this workflow step.

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

    • 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 build version that owns the specified runtime instance of the workflow step.

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

    • name

      public final String name()

      The name of the specified runtime instance of the workflow step.

      Returns:
      The name of the specified runtime instance of the workflow step.

    • description

      public final String description()

      Describes the specified workflow step.

      Returns:
      Describes the specified workflow step.

    • action

      public final String action()

      The name of the action that the specified step performs.

      Returns:
      The name of the action that the specified step performs.

    • status

      public final WorkflowStepExecutionStatus status()

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

    • statusAsString

      public final String statusAsString()

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

    • rollbackStatus

      public final WorkflowStepExecutionRollbackStatus rollbackStatus()

      Reports on the rollback status of the specified runtime instance of the workflow step, if applicable. Rollback runs when the workflow execution fails, and undoes the work that completed steps performed.

      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 specified runtime instance of the workflow step, if applicable. Rollback runs when the workflow execution fails, and undoes the work that completed steps performed.
      See Also:

    • rollbackStatusAsString

      public final String rollbackStatusAsString()

      Reports on the rollback status of the specified runtime instance of the workflow step, if applicable. Rollback runs when the workflow execution fails, and undoes the work that completed steps performed.

      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 specified runtime instance of the workflow step, if applicable. Rollback runs when the workflow execution fails, and undoes the work that completed steps performed.
      See Also:

    • message

      public final String message()

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

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

    • inputs

      public final String inputs()

      Input parameters that Image Builder provided for the specified runtime instance of the workflow step, as a JSON-encoded string.

      Returns:
      Input parameters that Image Builder provided for the specified runtime instance of the workflow step, as a JSON-encoded string.

    • outputs

      public final String outputs()

      The output values that the specified runtime instance of the workflow step produced, 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 specified runtime instance of the workflow step produced, 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 specified runtime instance of the workflow step started.

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

    • endTime

      public final String endTime()

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

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

    • onFailure

      public final String onFailure()

      The action that the workflow takes if this step fails, as configured in the workflow document. Abort fails the workflow and rolls back completed steps. Continue proceeds to the next step. If the step doesn't set a value, it defaults to Abort.

      Returns:
      The action that the workflow takes if this step fails, as configured in the workflow document. Abort fails the workflow and rolls back completed steps. Continue proceeds to the next step. If the step doesn't set a value, it defaults to Abort.

    • timeoutSeconds

      public final Integer timeoutSeconds()

      The maximum duration in seconds for this step to complete its action. If the workflow document doesn't set a timeout for the step, Image Builder applies the default timeout for the step's action. This field returns that value.

      Returns:
      The maximum duration in seconds for this step to complete its action. If the workflow document doesn't set a timeout for the step, Image Builder applies the default timeout for the step's action. This field returns that value.

    • attemptNumber

      public final Integer attemptNumber()

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

      Returns:
      The current attempt number for the specified runtime instance of 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 specified runtime instance of 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 specified runtime instance of 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 GetWorkflowStepExecutionResponse.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<GetWorkflowStepExecutionResponse.Builder,GetWorkflowStepExecutionResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetWorkflowStepExecutionResponse.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.