software.amazon.awssdk.services.imagebuilder.model

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(value="software.amazon.awssdk:codegen")
public final class GetWorkflowStepExecutionResponse
extends ImagebuilderResponse
implements ToCopyableBuilder<GetWorkflowStepExecutionResponse.Builder,GetWorkflowStepExecutionResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetWorkflowStepExecutionResponse.Builder

Method Summary

Modifier and Type	Method and Description
String	action() The name of the action that the specified step performs.
static GetWorkflowStepExecutionResponse.Builder	builder()
String	description() Describes the specified workflow step.
String	endTime() The timestamp when the specified runtime instance of the workflow step finished.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	imageBuildVersionArn() The Amazon Resource Name (ARN) of the image resource build version that the specified runtime instance of the workflow step creates.
String	inputs() Input parameters that Image Builder provided for the specified runtime instance of the workflow step.
String	message() The output message from the specified runtime instance of the workflow step, if applicable.
String	name() The name of the specified runtime instance of the workflow step.
String	onFailure() The action to perform if the workflow step fails.
String	outputs() The file names that the specified runtime version of the workflow step created as output.
String	requestId() The request ID that uniquely identifies this request.
WorkflowStepExecutionRollbackStatus	rollbackStatus() Reports on the rollback status of the specified runtime version of the workflow step, if applicable.
String	rollbackStatusAsString() Reports on the rollback status of the specified runtime version of the workflow step, if applicable.
List<SdkField<?>>	sdkFields()
static Class<? extends GetWorkflowStepExecutionResponse.Builder>	serializableBuilderClass()
String	startTime() The timestamp when the specified runtime version of the workflow step started.
WorkflowStepExecutionStatus	status() The current status for the specified runtime version of the workflow step.
String	statusAsString() The current status for the specified runtime version of the workflow step.
String	stepExecutionId() The unique identifier for the runtime version of the workflow step that you specified in the request.
Integer	timeoutSeconds() The maximum duration in seconds for this step to complete its action.
GetWorkflowStepExecutionResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	workflowBuildVersionArn() The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource that defines this workflow step.
String	workflowExecutionId() The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.

Methods inherited from class software.amazon.awssdk.services.imagebuilder.model.ImagebuilderResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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 version of the workflow step that you specified in the request.

Returns:

The unique identifier for the runtime version 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 resource build version that the specified runtime instance of the workflow step creates.

Returns:

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

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 version 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 version of the workflow step.

See Also:

WorkflowStepExecutionStatus

statusAsString

public final String statusAsString()

The current status for the specified runtime version 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 version of the workflow step.

See Also:

WorkflowStepExecutionStatus

rollbackStatus

public final WorkflowStepExecutionRollbackStatus rollbackStatus()

Reports on the rollback status of the specified runtime version of the workflow 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 specified runtime version of the workflow step, if applicable.

See Also:

WorkflowStepExecutionRollbackStatus

rollbackStatusAsString

public final String rollbackStatusAsString()

Reports on the rollback status of the specified runtime version of the workflow 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 specified runtime version of the workflow step, if applicable.

See Also:

WorkflowStepExecutionRollbackStatus

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.

Returns:

Input parameters that Image Builder provided for the specified runtime instance of the workflow step.

outputs

public final String outputs()

The file names that the specified runtime version of the workflow step created as output.

Returns:

The file names that the specified runtime version of the workflow step created as output.

startTime

public final String startTime()

The timestamp when the specified runtime version of the workflow step started.

Returns:

The timestamp when the specified runtime version 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 to perform if the workflow step fails.

Returns:

The action to perform if the workflow step fails.

timeoutSeconds

public final Integer timeoutSeconds()

The maximum duration in seconds for this step to complete its action.

Returns:

The maximum duration in seconds for this step to complete its action.

toBuilder

public GetWorkflowStepExecutionResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetWorkflowStepExecutionResponse.Builder,GetWorkflowStepExecutionResponse>

Overrides:

toBuilder in class AwsResponse

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo