Package software.amazon.awssdk.services.codecatalyst.model

Class WorkflowRunSummary

java.lang.Object

software.amazon.awssdk.services.codecatalyst.model.WorkflowRunSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<WorkflowRunSummary.Builder,WorkflowRunSummary>

@Generated("software.amazon.awssdk:codegen")
public final class WorkflowRunSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<WorkflowRunSummary.Builder,WorkflowRunSummary>

Information about a workflow run.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	WorkflowRunSummary.Builder

Method Summary

Modifier and Type	Method	Description
static WorkflowRunSummary.Builder	builder()
Instant	endTime()	The date and time the workflow run ended, in coordinated universal time (UTC) timestamp format as specified in RFC 3339
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasStatusReasons()	For responses, this returns true if the service returned a value for the StatusReasons property.
String	id()	The system-generated unique ID of the workflow run.
Instant	lastUpdatedTime()	The date and time the workflow was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339
List<SdkField<?>>	sdkFields()
static Class<? extends WorkflowRunSummary.Builder>	serializableBuilderClass()
Instant	startTime()	The date and time the workflow run began, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.
WorkflowRunStatus	status()	The status of the workflow run.
String	statusAsString()	The status of the workflow run.
List<WorkflowRunStatusReason>	statusReasons()	The reasons for the workflow run status.
WorkflowRunSummary.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	workflowId()	The system-generated unique ID of the workflow.
String	workflowName()	The name of the 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

id

public final String id()

The system-generated unique ID of the workflow run.

Returns:

The system-generated unique ID of the workflow run.

workflowId

public final String workflowId()

The system-generated unique ID of the workflow.

Returns:

The system-generated unique ID of the workflow.

workflowName

public final String workflowName()

The name of the workflow.

Returns:

The name of the workflow.

status

public final WorkflowRunStatus status()

The status of the workflow run.

If the service returns an enum value that is not available in the current SDK version, status will return WorkflowRunStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of the workflow run.

See Also:

WorkflowRunStatus

statusAsString

public final String statusAsString()

The status of the workflow run.

If the service returns an enum value that is not available in the current SDK version, status will return WorkflowRunStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of the workflow run.

See Also:

WorkflowRunStatus

hasStatusReasons

public final boolean hasStatusReasons()

For responses, this returns true if the service returned a value for the StatusReasons property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

statusReasons

public final List<WorkflowRunStatusReason> statusReasons()

The reasons for the workflow run status.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStatusReasons() method.

Returns:

The reasons for the workflow run status.

startTime

public final Instant startTime()

The date and time the workflow run began, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

Returns:

The date and time the workflow run began, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

endTime

public final Instant endTime()

The date and time the workflow run ended, in coordinated universal time (UTC) timestamp format as specified in RFC 3339

Returns:

The date and time the workflow run ended, in coordinated universal time (UTC) timestamp format as specified in RFC 3339

lastUpdatedTime

public final Instant lastUpdatedTime()

The date and time the workflow was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339

Returns:

The date and time the workflow was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339

toBuilder

public WorkflowRunSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<WorkflowRunSummary.Builder,WorkflowRunSummary>

builder

public static WorkflowRunSummary.Builder builder()

serializableBuilderClass

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