Package software.amazon.awssdk.services.imagebuilder.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	WorkflowExecutionMetadata.Builder

Method Summary

Modifier and Type	Method	Description
static WorkflowExecutionMetadata.Builder	builder()
String	endTime()	The timestamp when this 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	message()	The runtime output message from the workflow, if applicable.
String	parallelGroup()	The name of the test group that included the test workflow resource at runtime.
List<SdkField<?>>	sdkFields()
static Class<? extends WorkflowExecutionMetadata.Builder>	serializableBuilderClass()
String	startTime()	The timestamp when the runtime instance of this workflow started.
WorkflowExecutionStatus	status()	The current runtime status for this workflow.
String	statusAsString()	The current runtime status for this workflow.
WorkflowExecutionMetadata.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Integer	totalStepCount()	The total number of steps in the workflow.
Integer	totalStepsFailed()	A runtime count for the number of steps in the workflow that failed.
Integer	totalStepsSkipped()	A runtime count for the number of steps in the workflow that were skipped.
Integer	totalStepsSucceeded()	A runtime count for the number of steps in the workflow that ran successfully.
WorkflowType	type()	Indicates what type of workflow that Image Builder ran for this runtime instance of the workflow.
String	typeAsString()	Indicates what type of workflow that Image Builder ran for this runtime instance of the workflow.
String	workflowBuildVersionArn()	The Amazon Resource Name (ARN) of the workflow resource build version that ran.
String	workflowExecutionId()	Unique identifier that Image Builder assigns to keep track of runtime resources each time it runs a workflow.

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

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:

WorkflowType

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:

WorkflowType

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:

WorkflowExecutionStatus

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:

WorkflowExecutionStatus

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 in the workflow. This should equal the sum of the step counts for steps that succeeded, were skipped, and failed.

Returns:

The total number of steps in the workflow. This 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 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.

toBuilder

public WorkflowExecutionMetadata.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<WorkflowExecutionMetadata.Builder,WorkflowExecutionMetadata>

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)

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo