Class StageState
- java.lang.Object
-
- software.amazon.awssdk.services.codepipeline.model.StageState
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<StageState.Builder,StageState>
@Generated("software.amazon.awssdk:codegen") public final class StageState extends Object implements SdkPojo, Serializable, ToCopyableBuilder<StageState.Builder,StageState>
Represents information about the state of the stage.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceStageState.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<ActionState>actionStates()The state of the stage.StageConditionStatebeforeEntryConditionState()The state of the entry conditions for a stage.static StageState.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasActionStates()For responses, this returns true if the service returned a value for the ActionStates property.inthashCode()booleanhasInboundExecutions()For responses, this returns true if the service returned a value for the InboundExecutions property.StageExecutioninboundExecution()Returns the value of the InboundExecution property for this object.List<StageExecution>inboundExecutions()The inbound executions for a stage.TransitionStateinboundTransitionState()The state of the inbound transition, which is either enabled or disabled.StageExecutionlatestExecution()Information about the latest execution in the stage, including its ID and status.StageConditionStateonFailureConditionState()The state of the failure conditions for a stage.StageConditionStateonSuccessConditionState()The state of the success conditions for a stage.RetryStageMetadataretryStageMetadata()he details of a specific automatic retry on stage failure, including the attempt number and trigger.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends StageState.Builder>serializableBuilderClass()StringstageName()The name of the stage.StageState.BuildertoBuilder()StringtoString()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
-
stageName
public final String stageName()
The name of the stage.
- Returns:
- The name of the stage.
-
inboundExecution
public final StageExecution inboundExecution()
Returns the value of the InboundExecution property for this object.- Returns:
- The value of the InboundExecution property for this object.
-
hasInboundExecutions
public final boolean hasInboundExecutions()
For responses, this returns true if the service returned a value for the InboundExecutions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
inboundExecutions
public final List<StageExecution> inboundExecutions()
The inbound executions for a stage.
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
hasInboundExecutions()method.- Returns:
- The inbound executions for a stage.
-
inboundTransitionState
public final TransitionState inboundTransitionState()
The state of the inbound transition, which is either enabled or disabled.
- Returns:
- The state of the inbound transition, which is either enabled or disabled.
-
hasActionStates
public final boolean hasActionStates()
For responses, this returns true if the service returned a value for the ActionStates property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
actionStates
public final List<ActionState> actionStates()
The state of the stage.
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
hasActionStates()method.- Returns:
- The state of the stage.
-
latestExecution
public final StageExecution latestExecution()
Information about the latest execution in the stage, including its ID and status.
- Returns:
- Information about the latest execution in the stage, including its ID and status.
-
beforeEntryConditionState
public final StageConditionState beforeEntryConditionState()
The state of the entry conditions for a stage.
- Returns:
- The state of the entry conditions for a stage.
-
onSuccessConditionState
public final StageConditionState onSuccessConditionState()
The state of the success conditions for a stage.
- Returns:
- The state of the success conditions for a stage.
-
onFailureConditionState
public final StageConditionState onFailureConditionState()
The state of the failure conditions for a stage.
- Returns:
- The state of the failure conditions for a stage.
-
retryStageMetadata
public final RetryStageMetadata retryStageMetadata()
he details of a specific automatic retry on stage failure, including the attempt number and trigger.
- Returns:
- he details of a specific automatic retry on stage failure, including the attempt number and trigger.
-
toBuilder
public StageState.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<StageState.Builder,StageState>
-
builder
public static StageState.Builder builder()
-
serializableBuilderClass
public static Class<? extends StageState.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-