software.amazon.awssdk.services.batch.model

Class CreateJobQueueRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.batch.model.BatchRequest

software.amazon.awssdk.services.batch.model.CreateJobQueueRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateJobQueueRequest.Builder,CreateJobQueueRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateJobQueueRequest
extends BatchRequest
implements ToCopyableBuilder<CreateJobQueueRequest.Builder,CreateJobQueueRequest>

Contains the parameters for CreateJobQueue.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateJobQueueRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateJobQueueRequest.Builder	builder()
List<ComputeEnvironmentOrder>	computeEnvironmentOrder() The set of compute environments mapped to a job queue and their order relative to each other.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasComputeEnvironmentOrder() Returns true if the ComputeEnvironmentOrder property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	jobQueueName() The name of the job queue.
Integer	priority() The priority of the job queue.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateJobQueueRequest.Builder>	serializableBuilderClass()
JQState	state() The state of the job queue.
String	stateAsString() The state of the job queue.
Map<String,String>	tags() The tags that you apply to the job queue to help you categorize and organize your resources.
CreateJobQueueRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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 name of the job queue. Up to 128 letters (uppercase and lowercase), numbers, and underscores are allowed.

Returns:

The name of the job queue. Up to 128 letters (uppercase and lowercase), numbers, and underscores are allowed.

state

public final JQState state()

The state of the job queue. If the job queue state is ENABLED, it is able to 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:

The state of the job queue. If the job queue state is ENABLED, it is able to 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()

The state of the job queue. If the job queue state is ENABLED, it is able to 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:

The state of the job queue. If the job queue state is ENABLED, it is able to 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

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 cannot 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 cannot be mixed.

hasComputeEnvironmentOrder

public final boolean hasComputeEnvironmentOrder()

Returns true if the ComputeEnvironmentOrder property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

computeEnvironmentOrder

public final List<ComputeEnvironmentOrder> computeEnvironmentOrder()

The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler uses this parameter to determine which compute environment should run a specific job. Compute environments must be in the VALID state before you can associate them with a job queue. You can associate up to three compute environments with a job queue. 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.

All compute environments that are associated with a job queue must share the same architecture. AWS Batch doesn't support mixing compute environment architecture types in a single job queue.

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

You can use hasComputeEnvironmentOrder() to see if a value was sent in this field.

Returns:

The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler uses this parameter to determine which compute environment should run a specific job. Compute environments must be in the VALID state before you can associate them with a job queue. You can associate up to three compute environments with a job queue. 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.

All compute environments that are associated with a job queue must share the same architecture. AWS Batch doesn't support mixing compute environment architecture types in a single job queue.

hasTags

public final boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public final Map<String,String> tags()

The tags that you apply to the job queue to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging your AWS Batch resources in AWS Batch User Guide.

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

You can use hasTags() to see if a value was sent in this field.

Returns:

The tags that you apply to the job queue to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging your AWS Batch resources in AWS Batch User Guide.

toBuilder

public CreateJobQueueRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateJobQueueRequest.Builder,CreateJobQueueRequest>

Specified by:

toBuilder in class BatchRequest

builder

public static CreateJobQueueRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo