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 that represents the details for an 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 that job placement is preferred.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasComputeEnvironmentOrder() For responses, this returns true if the service returned a value for the ComputeEnvironmentOrder property.
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	jobQueueArn() The Amazon Resource Name (ARN) of the job queue.
String	jobQueueName() The job queue name.
Integer	priority() The priority of the job queue.
String	schedulingPolicyArn() The Amazon Resource Name (ARN) of the scheduling policy.
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 for the current status of the job queue.
Map<String,String>	tags() The tags that are applied to the job queue.
JobQueueDetail.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

jobQueueName

public final String jobQueueName()

The job queue name.

Returns:

The job queue name.

jobQueueArn

public final String jobQueueArn()

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

Returns:

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

state

public final JQState state()

Describes the ability of the queue to accept new jobs. If the job queue state is ENABLED, it can accept jobs. If the job queue state is DISABLED, new jobs can't be added to the queue, but jobs already in the queue can finish.

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. If the job queue state is ENABLED, it can accept jobs. If the job queue state is DISABLED, new jobs can't be added to the queue, but jobs already in the queue can finish.

See Also:

JQState

stateAsString

public final String stateAsString()

Describes the ability of the queue to accept new jobs. If the job queue state is ENABLED, it can accept jobs. If the job queue state is DISABLED, new jobs can't be added to the queue, but jobs already in the queue can finish.

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. If the job queue state is ENABLED, it can accept jobs. If the job queue state is DISABLED, new jobs can't be added to the queue, but jobs already in the queue can finish.

See Also:

JQState

schedulingPolicyArn

public final String schedulingPolicyArn()

The Amazon Resource Name (ARN) of the scheduling policy. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name . For example, aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.

Returns:

The Amazon Resource Name (ARN) of the scheduling policy. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name . For example, aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.

status

public final 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 final 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 final String statusReason()

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

Returns:

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

priority

public final Integer priority()

The priority of the job queue. Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order. For example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT). EC2 and Fargate compute environments can't be mixed.

Returns:

The priority of the job queue. Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order. For example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate ( FARGATE or FARGATE_SPOT). EC2 and Fargate compute environments can't be mixed.

hasComputeEnvironmentOrder

public final boolean hasComputeEnvironmentOrder()

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

computeEnvironmentOrder

public final List<ComputeEnvironmentOrder> computeEnvironmentOrder()

The compute environments that are attached to the job queue and the order that 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.

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

Returns:

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

hasTags

public final boolean hasTags()

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

tags

public final Map<String,String> tags()

The tags that are applied to the job queue. For more information, see Tagging your Batch resources in Batch User Guide.

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

Returns:

The tags that are applied to the job queue. For more information, see Tagging your Batch resources in Batch User Guide.

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 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