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

Class Condition

java.lang.Object

software.amazon.awssdk.services.codepipeline.model.Condition

All Implemented Interfaces:

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

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

The condition for the stage. A condition is made up of the rules and the result for the condition. For more information about conditions, see Stage conditions. For more information about rules, see the CodePipeline rule reference.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Condition.Builder

Method Summary

Modifier and Type	Method	Description
static Condition.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRules()	For responses, this returns true if the service returned a value for the Rules property.
Result	result()	The action to be done when the condition is met.
String	resultAsString()	The action to be done when the condition is met.
List<RuleDeclaration>	rules()	The rules that make up the condition.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Condition.Builder>	serializableBuilderClass()
Condition.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

result

public final Result result()

The action to be done when the condition is met. For example, rolling back an execution for a failure condition.

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

Returns:

The action to be done when the condition is met. For example, rolling back an execution for a failure condition.

See Also:

Result

resultAsString

public final String resultAsString()

The action to be done when the condition is met. For example, rolling back an execution for a failure condition.

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

Returns:

The action to be done when the condition is met. For example, rolling back an execution for a failure condition.

See Also:

Result

hasRules

public final boolean hasRules()

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

rules

public final List<RuleDeclaration> rules()

The rules that make up the condition.

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

Returns:

The rules that make up the condition.

toBuilder

public Condition.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Condition.Builder,Condition>

builder

public static Condition.Builder builder()

serializableBuilderClass

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