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

Class WorkflowSummary

java.lang.Object

software.amazon.awssdk.services.codecatalyst.model.WorkflowSummary

All Implemented Interfaces:

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

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

Information about a workflow.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	WorkflowSummary.Builder

Method Summary

Modifier and Type	Method	Description
static WorkflowSummary.Builder	builder()
Instant	createdTime()	The date and time the workflow was created, in coordinated universal time (UTC) timestamp format as specified in RFC 3339
WorkflowDefinitionSummary	definition()	Information about the workflow definition file.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id()	The system-generated unique ID of a workflow.
Instant	lastUpdatedTime()	The date and time the workflow was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339
String	name()	The name of the workflow.
WorkflowRunMode	runMode()	The run mode of the workflow.
String	runModeAsString()	The run mode of the workflow.
List<SdkField<?>>	sdkFields()
static Class<? extends WorkflowSummary.Builder>	serializableBuilderClass()
String	sourceBranchName()	The name of the branch of the source repository where the workflow definition file is stored.
String	sourceRepositoryName()	The name of the source repository where the workflow definition file is stored.
WorkflowStatus	status()	The status of the workflow.
String	statusAsString()	The status of the workflow.
WorkflowSummary.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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 a workflow.

Returns:

The system-generated unique ID of a workflow.

name

public final String name()

The name of the workflow.

Returns:

The name of the workflow.

sourceRepositoryName

public final String sourceRepositoryName()

The name of the source repository where the workflow definition file is stored.

Returns:

The name of the source repository where the workflow definition file is stored.

sourceBranchName

public final String sourceBranchName()

The name of the branch of the source repository where the workflow definition file is stored.

Returns:

The name of the branch of the source repository where the workflow definition file is stored.

definition

public final WorkflowDefinitionSummary definition()

Information about the workflow definition file.

Returns:

Information about the workflow definition file.

createdTime

public final Instant createdTime()

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

Returns:

The date and time the workflow was created, 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

runMode

public final WorkflowRunMode runMode()

The run mode of the workflow.

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

Returns:

The run mode of the workflow.

See Also:

WorkflowRunMode

runModeAsString

public final String runModeAsString()

The run mode of the workflow.

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

Returns:

The run mode of the workflow.

See Also:

WorkflowRunMode

status

public final WorkflowStatus status()

The status of the workflow.

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

Returns:

The status of the workflow.

See Also:

WorkflowStatus

statusAsString

public final String statusAsString()

The status of the workflow.

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

Returns:

The status of the workflow.

See Also:

WorkflowStatus

toBuilder

public WorkflowSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<WorkflowSummary.Builder,WorkflowSummary>

builder

public static WorkflowSummary.Builder builder()

serializableBuilderClass

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