Package software.amazon.awssdk.services.codepipeline.model

Class GetPipelineStateResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.codepipeline.model.CodePipelineResponse

software.amazon.awssdk.services.codepipeline.model.GetPipelineStateResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetPipelineStateResponse.Builder,GetPipelineStateResponse>

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

Represents the output of a GetPipelineState action.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetPipelineStateResponse.Builder

Method Summary

Modifier and Type	Method	Description
static GetPipelineStateResponse.Builder	builder()
Instant	created()	The date and time the pipeline was created, in timestamp format.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasStageStates()	For responses, this returns true if the service returned a value for the StageStates property.
String	pipelineName()	The name of the pipeline for which you want to get the state.
Integer	pipelineVersion()	The version number of the pipeline.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GetPipelineStateResponse.Builder>	serializableBuilderClass()
List<StageState>	stageStates()	A list of the pipeline stage output information, including stage name, state, most recent run details, whether the stage is disabled, and other data.
GetPipelineStateResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Instant	updated()	The date and time the pipeline was last updated, in timestamp format.

Methods inherited from class software.amazon.awssdk.services.codepipeline.model.CodePipelineResponse

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

pipelineName

public final String pipelineName()

The name of the pipeline for which you want to get the state.

Returns:

The name of the pipeline for which you want to get the state.

pipelineVersion

public final Integer pipelineVersion()

The version number of the pipeline.

A newly created pipeline is always assigned a version number of 1.

Returns:

The version number of the pipeline.

A newly created pipeline is always assigned a version number of 1.

hasStageStates

public final boolean hasStageStates()

For responses, this returns true if the service returned a value for the StageStates 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.

stageStates

public final List<StageState> stageStates()

A list of the pipeline stage output information, including stage name, state, most recent run details, whether the stage is disabled, and other data.

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 hasStageStates() method.

Returns:

A list of the pipeline stage output information, including stage name, state, most recent run details, whether the stage is disabled, and other data.

created

public final Instant created()

The date and time the pipeline was created, in timestamp format.

Returns:

The date and time the pipeline was created, in timestamp format.

updated

public final Instant updated()

The date and time the pipeline was last updated, in timestamp format.

Returns:

The date and time the pipeline was last updated, in timestamp format.

toBuilder

public GetPipelineStateResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetPipelineStateResponse.Builder,GetPipelineStateResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetPipelineStateResponse.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

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

Specified by:

sdkFieldNameToField in interface SdkPojo