java.lang.Object
- software.amazon.awssdk.services.codepipeline.model.StageDeclaration

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<StageDeclaration.Builder,StageDeclaration>

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

Represents information about a stage and its definition.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface StageDeclaration.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<ActionDeclaration>`	`actions()`	The actions included in a stage.
`BeforeEntryConditions`	`beforeEntry()`	The method to use when a stage allows entry.
`List<BlockerDeclaration>`	`blockers()`	Reserved for future use.
`static StageDeclaration.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasActions()`	For responses, this returns true if the service returned a value for the Actions property.
`boolean`	`hasBlockers()`	For responses, this returns true if the service returned a value for the Blockers property.
`int`	`hashCode()`
`String`	`name()`	The name of the stage.
`FailureConditions`	`onFailure()`	The method to use when a stage has not completed successfully.
`SuccessConditions`	`onSuccess()`	The method to use when a stage has succeeded.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends StageDeclaration.Builder>`	`serializableBuilderClass()`
`StageDeclaration.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
  - name
```
public final String name()
```
    The name of the stage.
    
    Returns:
    
    The name of the stage.
  - hasBlockers
```
public final boolean hasBlockers()
```
    For responses, this returns true if the service returned a value for the Blockers 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.
  - blockers
```
public final List<BlockerDeclaration> blockers()
```
    Reserved for future use.
    
    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 hasBlockers() method.
    
    Returns:
    
    Reserved for future use.
  - hasActions
```
public final boolean hasActions()
```
    For responses, this returns true if the service returned a value for the Actions 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.
  - actions
```
public final List<ActionDeclaration> actions()
```
    The actions included in 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 hasActions() method.
    
    Returns:
    
    The actions included in a stage.
  - onFailure
```
public final FailureConditions onFailure()
```
    The method to use when a stage has not completed successfully. For example, configuring this field for rollback will roll back a failed stage automatically to the last successful pipeline execution in the stage.
    
    Returns:
    
    The method to use when a stage has not completed successfully. For example, configuring this field for rollback will roll back a failed stage automatically to the last successful pipeline execution in the stage.
  - onSuccess
```
public final SuccessConditions onSuccess()
```
    The method to use when a stage has succeeded. For example, configuring this field for conditions will allow the stage to succeed when the conditions are met.
    
    Returns:
    
    The method to use when a stage has succeeded. For example, configuring this field for conditions will allow the stage to succeed when the conditions are met.
  - beforeEntry
```
public final BeforeEntryConditions beforeEntry()
```
    The method to use when a stage allows entry. For example, configuring this field for conditions will allow entry to the stage when the conditions are met.
    
    Returns:
    
    The method to use when a stage allows entry. For example, configuring this field for conditions will allow entry to the stage when the conditions are met.
  - toBuilder
```
public StageDeclaration.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<StageDeclaration.Builder,StageDeclaration>
  - builder
```
public static StageDeclaration.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends StageDeclaration.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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class StageDeclaration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

name

hasBlockers

blockers

hasActions

actions

onFailure

onSuccess

beforeEntry

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField