Class GetWorkflowResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.codecatalyst.model.CodeCatalystResponse

software.amazon.awssdk.services.codecatalyst.model.GetWorkflowResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetWorkflowResponse.Builder,GetWorkflowResponse>

@Generated("software.amazon.awssdk:codegen")
public final class GetWorkflowResponse
extends CodeCatalystResponse
implements ToCopyableBuilder<GetWorkflowResponse.Builder,GetWorkflowResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetWorkflowResponse.Builder

Method Summary

Modifier and Type	Method	Description
static GetWorkflowResponse.Builder	builder()
final Instant	createdTime()	The date and time the workflow was created, in coordinated universal time (UTC) timestamp format as specified in RFC 3339
final WorkflowDefinition	definition()	Information about the workflow definition file for the workflow.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)	Used to retrieve the value of a field from any class that extends SdkResponse.
final int	hashCode()
final String	id()	The ID of the workflow.
final Instant	lastUpdatedTime()	The date and time the workflow was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339
final String	name()	The name of the workflow.
final String	projectName()	The name of the project in the space.
final WorkflowRunMode	runMode()	The behavior to use when multiple workflows occur at the same time.
final String	runModeAsString()	The behavior to use when multiple workflows occur at the same time.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends GetWorkflowResponse.Builder>	serializableBuilderClass()
final String	sourceBranchName()	The name of the branch that contains the workflow YAML.
final String	sourceRepositoryName()	The name of the source repository where the workflow YAML is stored.
final String	spaceName()	The name of the space.
final WorkflowStatus	status()	The status of the workflow.
final String	statusAsString()	The status of the workflow.
GetWorkflowResponse.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.codecatalyst.model.CodeCatalystResponse

responseMetadata

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

sdkHttpResponse

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Details

spaceName

public final String spaceName()

The name of the space.

Returns:

The name of the space.

projectName

public final String projectName()

The name of the project in the space.

Returns:

The name of the project in the space.

id

public final String id()

The ID of the workflow.

Returns:

The ID of the 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 YAML is stored.

Returns:

The name of the source repository where the workflow YAML is stored.

sourceBranchName

public final String sourceBranchName()

The name of the branch that contains the workflow YAML.

Returns:

The name of the branch that contains the workflow YAML.

definition

public final WorkflowDefinition definition()

Information about the workflow definition file for the workflow.

Returns:

Information about the workflow definition file for the workflow.

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 behavior to use when multiple workflows occur at the same time. For more information, see https://docs.aws.amazon.com/codecatalyst/latest/userguide/workflows-configure-runs.html in the Amazon CodeCatalyst User Guide.

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 behavior to use when multiple workflows occur at the same time. For more information, see https://docs.aws.amazon.com/codecatalyst/latest/userguide/workflows-configure-runs.html in the Amazon CodeCatalyst User Guide.

See Also:

• WorkflowRunMode

runModeAsString

public final String runModeAsString()

The behavior to use when multiple workflows occur at the same time. For more information, see https://docs.aws.amazon.com/codecatalyst/latest/userguide/workflows-configure-runs.html in the Amazon CodeCatalyst User Guide.

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 behavior to use when multiple workflows occur at the same time. For more information, see https://docs.aws.amazon.com/codecatalyst/latest/userguide/workflows-configure-runs.html in the Amazon CodeCatalyst User Guide.

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 GetWorkflowResponse.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GetWorkflowResponse.Builder,GetWorkflowResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static GetWorkflowResponse.Builder builder()

serializableBuilderClass

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

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo

Returns:

The mapping between the field name and its corresponding field.