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

Class FailureConditions

java.lang.Object

software.amazon.awssdk.services.codepipeline.model.FailureConditions

All Implemented Interfaces:

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

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

The configuration that specifies the result, such as rollback, to occur upon stage failure.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FailureConditions.Builder

Method Summary

Modifier and Type	Method	Description
static FailureConditions.Builder	builder()
List<Condition>	conditions()	The conditions that are configured as failure conditions.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasConditions()	For responses, this returns true if the service returned a value for the Conditions property.
int	hashCode()
Result	result()	The specified result for when the failure conditions are met, such as rolling back the stage.
String	resultAsString()	The specified result for when the failure conditions are met, such as rolling back the stage.
RetryConfiguration	retryConfiguration()	The retry configuration specifies automatic retry for a failed stage, along with the configured retry mode.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends FailureConditions.Builder>	serializableBuilderClass()
FailureConditions.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 specified result for when the failure conditions are met, such as rolling back the stage.

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 specified result for when the failure conditions are met, such as rolling back the stage.

See Also:

Result

resultAsString

public final String resultAsString()

The specified result for when the failure conditions are met, such as rolling back the stage.

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 specified result for when the failure conditions are met, such as rolling back the stage.

See Also:

Result

retryConfiguration

public final RetryConfiguration retryConfiguration()

The retry configuration specifies automatic retry for a failed stage, along with the configured retry mode.

Returns:

The retry configuration specifies automatic retry for a failed stage, along with the configured retry mode.

hasConditions

public final boolean hasConditions()

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

conditions

public final List<Condition> conditions()

The conditions that are configured as failure conditions.

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

Returns:

The conditions that are configured as failure conditions.

toBuilder

public FailureConditions.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FailureConditions.Builder,FailureConditions>

builder

public static FailureConditions.Builder builder()

serializableBuilderClass

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