@Generated(value="software.amazon.awssdk:codegen") public final class CreateJobQueueRequest extends BatchRequest implements ToCopyableBuilder<CreateJobQueueRequest.Builder,CreateJobQueueRequest>
Contains the parameters for CreateJobQueue.
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateJobQueueRequest.Builder |
| 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()
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 |
jobQueueName()
The name of the job queue.
|
Integer |
priority()
The priority of the job queue.
|
String |
schedulingPolicyArn()
The Amazon Resource Name (ARN) of the fair share scheduling policy.
|
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.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String jobQueueName()
The name of the job queue. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
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().
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.JQStatepublic 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().
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.JQStatepublic final String schedulingPolicyArn()
The Amazon Resource Name (ARN) of the fair share scheduling policy. If this parameter is specified, the job queue
uses a fair share scheduling policy. If this parameter isn't specified, the job queue uses a first in, first out
(FIFO) scheduling policy. After a job queue is created, you can replace but can't remove the fair share
scheduling policy. The format is
aws:Partition:batch:Region:Account:scheduling-policy/Name . An example
is aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.
aws:Partition:batch:Region:Account:scheduling-policy/Name . An
example is aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.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.
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.public final boolean hasComputeEnvironmentOrder()
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.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 runs 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. 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.
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.
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. Batch doesn't support mixing compute environment architecture types in a single job queue.
public final boolean hasTags()
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.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 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.
public CreateJobQueueRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<CreateJobQueueRequest.Builder,CreateJobQueueRequest>toBuilder in class BatchRequestpublic static CreateJobQueueRequest.Builder builder()
public static Class<? extends CreateJobQueueRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2023. All rights reserved.