software.amazon.awssdk.services.batch.model

Class RetryStrategy

java.lang.Object

software.amazon.awssdk.services.batch.model.RetryStrategy

All Implemented Interfaces:

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

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

The retry strategy that's associated with a job. For more information, see Automated job retries in the Batch User Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RetryStrategy.Builder

Method Summary

Modifier and Type	Method and Description
Integer	attempts() The number of times to move a job to the RUNNABLE status.
static RetryStrategy.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<EvaluateOnExit>	evaluateOnExit() Array of up to 5 objects that specify the conditions where jobs are retried or failed.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEvaluateOnExit() For responses, this returns true if the service returned a value for the EvaluateOnExit property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends RetryStrategy.Builder>	serializableBuilderClass()
RetryStrategy.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

attempts

public final Integer attempts()

The number of times to move a job to the RUNNABLE status. You can specify between 1 and 10 attempts. If the value of attempts is greater than one, the job is retried on failure the same number of attempts as the value.

Returns:

The number of times to move a job to the RUNNABLE status. You can specify between 1 and 10 attempts. If the value of attempts is greater than one, the job is retried on failure the same number of attempts as the value.

hasEvaluateOnExit

public final boolean hasEvaluateOnExit()

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

evaluateOnExit

public final List<EvaluateOnExit> evaluateOnExit()

Array of up to 5 objects that specify the conditions where jobs are retried or failed. If this parameter is specified, then the attempts parameter must also be specified. If none of the listed conditions match, then the job is retried.

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

Returns:

Array of up to 5 objects that specify the conditions where jobs are retried or failed. If this parameter is specified, then the attempts parameter must also be specified. If none of the listed conditions match, then the job is retried.

toBuilder

public RetryStrategy.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RetryStrategy.Builder,RetryStrategy>

builder

public static RetryStrategy.Builder builder()

serializableBuilderClass

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