software.amazon.awssdk.services.batch.model

Class JobQueueDetail

java.lang.Object

software.amazon.awssdk.services.batch.model.JobQueueDetail

All Implemented Interfaces:

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

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

An object representing the details of an AWS Batch job queue.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	JobQueueDetail.Builder

Method Summary

Modifier and Type	Method and Description
static JobQueueDetail.Builder	builder()
List<ComputeEnvironmentOrder>	computeEnvironmentOrder() The compute environments that are attached to the job queue and the order in which job placement is preferred.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	jobQueueArn() The Amazon Resource Name (ARN) of the job queue.
String	jobQueueName() The name of the job queue.
Integer	priority() The priority of the job queue.
List<SdkField<?>>	sdkFields()
static Class<? extends JobQueueDetail.Builder>	serializableBuilderClass()
JQState	state() Describes the ability of the queue to accept new jobs.
String	stateAsString() Describes the ability of the queue to accept new jobs.
JQStatus	status() The status of the job queue (for example, CREATING or VALID).
String	statusAsString() The status of the job queue (for example, CREATING or VALID).
String	statusReason() A short, human-readable string to provide additional details about the current status of the job queue.
JobQueueDetail.Builder	toBuilder()
String	toString()

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

jobQueueName

public String jobQueueName()

The name of the job queue.

Returns:

The name of the job queue.

jobQueueArn

public String jobQueueArn()

The Amazon Resource Name (ARN) of the job queue.

Returns:

The Amazon Resource Name (ARN) of the job queue.

state

public JQState state()

Describes the ability of the queue to accept new jobs.

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

Returns:

Describes the ability of the queue to accept new jobs.

See Also:

JQState

stateAsString

public String stateAsString()

Describes the ability of the queue to accept new jobs.

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

Returns:

Describes the ability of the queue to accept new jobs.

See Also:

JQState

status

public JQStatus status()

The status of the job queue (for example, CREATING or VALID).

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

Returns:

The status of the job queue (for example, CREATING or VALID).

See Also:

JQStatus

statusAsString

public String statusAsString()

The status of the job queue (for example, CREATING or VALID).

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

Returns:

The status of the job queue (for example, CREATING or VALID).

See Also:

JQStatus

statusReason

public String statusReason()

A short, human-readable string to provide additional details about the current status of the job queue.

Returns:

A short, human-readable string to provide additional details about the current status of the job queue.

priority

public Integer priority()

The priority of the job queue.

Returns:

The priority of the job queue.

computeEnvironmentOrder

public List<ComputeEnvironmentOrder> computeEnvironmentOrder()

The compute environments that are attached to the job queue and the order in which job placement is preferred. Compute environments are selected for job placement in ascending order.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The compute environments that are attached to the job queue and the order in which job placement is preferred. Compute environments are selected for job placement in ascending order.

toBuilder

public JobQueueDetail.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<JobQueueDetail.Builder,JobQueueDetail>

builder

public static JobQueueDetail.Builder builder()

serializableBuilderClass

public static Class<? extends JobQueueDetail.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo