Package software.amazon.awssdk.services.batch.model

Class JobStateTimeLimitAction

java.lang.Object

software.amazon.awssdk.services.batch.model.JobStateTimeLimitAction

All Implemented Interfaces:

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

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

Specifies an action that Batch will take after the job has remained at the head of the queue in the specified state for longer than the specified time.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	JobStateTimeLimitAction.Builder

Method Summary

Modifier and Type	Method	Description
JobStateTimeLimitActionsAction	action()	The action to take when a job is at the head of the job queue in the specified state for the specified period of time.
String	actionAsString()	The action to take when a job is at the head of the job queue in the specified state for the specified period of time.
static JobStateTimeLimitAction.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxTimeSeconds()	The approximate amount of time, in seconds, that must pass with the job in the specified state before the action is taken.
String	reason()	The reason to log for the action being taken.
List<SdkField<?>>	sdkFields()
static Class<? extends JobStateTimeLimitAction.Builder>	serializableBuilderClass()
JobStateTimeLimitActionsState	state()	The state of the job needed to trigger the action.
String	stateAsString()	The state of the job needed to trigger the action.
JobStateTimeLimitAction.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

reason

public final String reason()

The reason to log for the action being taken.

Returns:

The reason to log for the action being taken.

state

public final JobStateTimeLimitActionsState state()

The state of the job needed to trigger the action. The only supported value is "RUNNABLE".

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

Returns:

The state of the job needed to trigger the action. The only supported value is "RUNNABLE".

See Also:

JobStateTimeLimitActionsState

stateAsString

public final String stateAsString()

The state of the job needed to trigger the action. The only supported value is "RUNNABLE".

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

Returns:

The state of the job needed to trigger the action. The only supported value is "RUNNABLE".

See Also:

JobStateTimeLimitActionsState

maxTimeSeconds

public final Integer maxTimeSeconds()

The approximate amount of time, in seconds, that must pass with the job in the specified state before the action is taken. The minimum value is 600 (10 minutes) and the maximum value is 86,400 (24 hours).

Returns:

The approximate amount of time, in seconds, that must pass with the job in the specified state before the action is taken. The minimum value is 600 (10 minutes) and the maximum value is 86,400 (24 hours).

action

public final JobStateTimeLimitActionsAction action()

The action to take when a job is at the head of the job queue in the specified state for the specified period of time. The only supported value is "CANCEL", which will cancel the job.

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

Returns:

The action to take when a job is at the head of the job queue in the specified state for the specified period of time. The only supported value is "CANCEL", which will cancel the job.

See Also:

JobStateTimeLimitActionsAction

actionAsString

public final String actionAsString()

The action to take when a job is at the head of the job queue in the specified state for the specified period of time. The only supported value is "CANCEL", which will cancel the job.

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

Returns:

The action to take when a job is at the head of the job queue in the specified state for the specified period of time. The only supported value is "CANCEL", which will cancel the job.

See Also:

JobStateTimeLimitActionsAction

toBuilder

public JobStateTimeLimitAction.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<JobStateTimeLimitAction.Builder,JobStateTimeLimitAction>

builder

public static JobStateTimeLimitAction.Builder builder()

serializableBuilderClass

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