@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateJobQueueRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Contains the parameters for CreateJobQueue.
NOOP| Constructor and Description |
|---|
CreateJobQueueRequest() |
| Modifier and Type | Method and Description |
|---|---|
CreateJobQueueRequest |
addTagsEntry(String key,
String value)
Add a single Tags entry
|
CreateJobQueueRequest |
clearTagsEntries()
Removes all the entries added into Tags.
|
CreateJobQueueRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
List<ComputeEnvironmentOrder> |
getComputeEnvironmentOrder()
The set of compute environments mapped to a job queue and their order relative to each other.
|
String |
getJobQueueName()
The name of the job queue.
|
List<JobStateTimeLimitAction> |
getJobStateTimeLimitActions()
The set of actions that Batch performs on jobs that remain at the head of the job queue in the specified state
longer than specified times.
|
Integer |
getPriority()
The priority of the job queue.
|
String |
getSchedulingPolicyArn()
The Amazon Resource Name (ARN) of the fair share scheduling policy.
|
String |
getState()
The state of the job queue.
|
Map<String,String> |
getTags()
The tags that you apply to the job queue to help you categorize and organize your resources.
|
int |
hashCode() |
void |
setComputeEnvironmentOrder(Collection<ComputeEnvironmentOrder> computeEnvironmentOrder)
The set of compute environments mapped to a job queue and their order relative to each other.
|
void |
setJobQueueName(String jobQueueName)
The name of the job queue.
|
void |
setJobStateTimeLimitActions(Collection<JobStateTimeLimitAction> jobStateTimeLimitActions)
The set of actions that Batch performs on jobs that remain at the head of the job queue in the specified state
longer than specified times.
|
void |
setPriority(Integer priority)
The priority of the job queue.
|
void |
setSchedulingPolicyArn(String schedulingPolicyArn)
The Amazon Resource Name (ARN) of the fair share scheduling policy.
|
void |
setState(JQState state)
The state of the job queue.
|
void |
setState(String state)
The state of the job queue.
|
void |
setTags(Map<String,String> tags)
The tags that you apply to the job queue to help you categorize and organize your resources.
|
String |
toString()
Returns a string representation of this object.
|
CreateJobQueueRequest |
withComputeEnvironmentOrder(Collection<ComputeEnvironmentOrder> computeEnvironmentOrder)
The set of compute environments mapped to a job queue and their order relative to each other.
|
CreateJobQueueRequest |
withComputeEnvironmentOrder(ComputeEnvironmentOrder... computeEnvironmentOrder)
The set of compute environments mapped to a job queue and their order relative to each other.
|
CreateJobQueueRequest |
withJobQueueName(String jobQueueName)
The name of the job queue.
|
CreateJobQueueRequest |
withJobStateTimeLimitActions(Collection<JobStateTimeLimitAction> jobStateTimeLimitActions)
The set of actions that Batch performs on jobs that remain at the head of the job queue in the specified state
longer than specified times.
|
CreateJobQueueRequest |
withJobStateTimeLimitActions(JobStateTimeLimitAction... jobStateTimeLimitActions)
The set of actions that Batch performs on jobs that remain at the head of the job queue in the specified state
longer than specified times.
|
CreateJobQueueRequest |
withPriority(Integer priority)
The priority of the job queue.
|
CreateJobQueueRequest |
withSchedulingPolicyArn(String schedulingPolicyArn)
The Amazon Resource Name (ARN) of the fair share scheduling policy.
|
CreateJobQueueRequest |
withState(JQState state)
The state of the job queue.
|
CreateJobQueueRequest |
withState(String state)
The state of the job queue.
|
CreateJobQueueRequest |
withTags(Map<String,String> tags)
The tags that you apply to the job queue to help you categorize and organize your resources.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeoutpublic void setJobQueueName(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 (_).
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 String getJobQueueName()
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 CreateJobQueueRequest withJobQueueName(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 (_).
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 void setState(String 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.
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.JQStatepublic String getState()
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.
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 CreateJobQueueRequest withState(String 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.
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.JQStatepublic void setState(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.
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.JQStatepublic CreateJobQueueRequest withState(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.
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.JQStatepublic void setSchedulingPolicyArn(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.
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.public String getSchedulingPolicyArn()
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 CreateJobQueueRequest withSchedulingPolicyArn(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.
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.public void setPriority(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 - 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.public Integer getPriority()
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 CreateJobQueueRequest withPriority(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 - 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.public List<ComputeEnvironmentOrder> getComputeEnvironmentOrder()
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.
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 void setComputeEnvironmentOrder(Collection<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.
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.
public CreateJobQueueRequest withComputeEnvironmentOrder(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.
NOTE: This method appends the values to the existing list (if any). Use
setComputeEnvironmentOrder(java.util.Collection) or
withComputeEnvironmentOrder(java.util.Collection) if you want to override the existing values.
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.
public CreateJobQueueRequest withComputeEnvironmentOrder(Collection<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.
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.
public Map<String,String> getTags()
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.
public void setTags(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.
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.public CreateJobQueueRequest withTags(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.
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.public CreateJobQueueRequest addTagsEntry(String key, String value)
public CreateJobQueueRequest clearTagsEntries()
public List<JobStateTimeLimitAction> getJobStateTimeLimitActions()
The set of actions that Batch performs on jobs that remain at the head of the job queue in the specified state
longer than specified times. Batch will perform each action after maxTimeSeconds has passed.
maxTimeSeconds has
passed.public void setJobStateTimeLimitActions(Collection<JobStateTimeLimitAction> jobStateTimeLimitActions)
The set of actions that Batch performs on jobs that remain at the head of the job queue in the specified state
longer than specified times. Batch will perform each action after maxTimeSeconds has passed.
jobStateTimeLimitActions - The set of actions that Batch performs on jobs that remain at the head of the job queue in the specified
state longer than specified times. Batch will perform each action after maxTimeSeconds has
passed.public CreateJobQueueRequest withJobStateTimeLimitActions(JobStateTimeLimitAction... jobStateTimeLimitActions)
The set of actions that Batch performs on jobs that remain at the head of the job queue in the specified state
longer than specified times. Batch will perform each action after maxTimeSeconds has passed.
NOTE: This method appends the values to the existing list (if any). Use
setJobStateTimeLimitActions(java.util.Collection) or
withJobStateTimeLimitActions(java.util.Collection) if you want to override the existing values.
jobStateTimeLimitActions - The set of actions that Batch performs on jobs that remain at the head of the job queue in the specified
state longer than specified times. Batch will perform each action after maxTimeSeconds has
passed.public CreateJobQueueRequest withJobStateTimeLimitActions(Collection<JobStateTimeLimitAction> jobStateTimeLimitActions)
The set of actions that Batch performs on jobs that remain at the head of the job queue in the specified state
longer than specified times. Batch will perform each action after maxTimeSeconds has passed.
jobStateTimeLimitActions - The set of actions that Batch performs on jobs that remain at the head of the job queue in the specified
state longer than specified times. Batch will perform each action after maxTimeSeconds has
passed.public String toString()
toString in class ObjectObject.toString()public CreateJobQueueRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()