software.amazon.awssdk.services.imagebuilder.model

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetWorkflowExecutionResponse.Builder

Method Summary

Modifier and Type	Method and Description
static GetWorkflowExecutionResponse.Builder	builder()
String	endTime() The timestamp when the specified runtime instance of the workflow 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 created.
String	message() The output message from the specified runtime instance of the workflow, if applicable.
String	requestId() The request ID that uniquely identifies this request.
List<SdkField<?>>	sdkFields()
static Class<? extends GetWorkflowExecutionResponse.Builder>	serializableBuilderClass()
String	startTime() The timestamp when the specified runtime instance of the workflow started.
WorkflowExecutionStatus	status() The current runtime status for the specified runtime instance of the workflow.
String	statusAsString() The current runtime status for the specified runtime instance of the workflow.
GetWorkflowExecutionResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Integer	totalStepCount() The total number of steps in the specified runtime instance of the workflow that ran.
Integer	totalStepsFailed() A runtime count for the number of steps that failed in the specified runtime instance of the workflow.
Integer	totalStepsSkipped() A runtime count for the number of steps that were skipped in the specified runtime instance of the workflow.
Integer	totalStepsSucceeded() A runtime count for the number of steps that ran successfully in the specified runtime instance of the workflow.
WorkflowType	type() The type of workflow that Image Builder ran for the specified runtime instance of the workflow.
String	typeAsString() The type of workflow that Image Builder ran for the specified runtime instance of the workflow.
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.
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.

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:

WorkflowType

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:

WorkflowType

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:

WorkflowExecutionStatus

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:

WorkflowExecutionStatus

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.

toBuilder

public GetWorkflowExecutionResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetWorkflowExecutionResponse.Builder,GetWorkflowExecutionResponse>

Overrides:

toBuilder in class AwsResponse

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)

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