com.amazonaws.services.batch.model

Class CreateJobQueueRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.batch.model.CreateJobQueueRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateJobQueueRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Contains the parameters for CreateJobQueue.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateJobQueueRequest()

Method Summary

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.
Integer	getPriority() The priority of the job queue.
String	getSchedulingPolicyArn() 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	setPriority(Integer priority) The priority of the job queue.
void	setSchedulingPolicyArn(String schedulingPolicyArn) 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	withPriority(Integer priority) The priority of the job queue.
CreateJobQueueRequest	withSchedulingPolicyArn(String schedulingPolicyArn) 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.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateJobQueueRequest

public CreateJobQueueRequest()

Method Detail

setJobQueueName

public void setJobQueueName(String jobQueueName)

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

Parameters:

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

getJobQueueName

public String getJobQueueName()

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.

withJobQueueName

public CreateJobQueueRequest withJobQueueName(String jobQueueName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setState

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.

Parameters:

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.

See Also:

JQState

getState

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

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

withState

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

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

JQState

setState

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

Parameters:

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.

See Also:

JQState

withState

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

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

JQState

setSchedulingPolicyArn

public void setSchedulingPolicyArn(String schedulingPolicyArn)

Amazon Resource Name (ARN) of the fair share scheduling policy. If this parameter is specified, the job queue will use a fair share scheduling policy. If this parameter is not specified, the job queue will use a first in, first out (FIFO) scheduling policy. Once a job queue is created, the fair share scheduling policy can be replaced but not removed. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name . For example, aws:aws:batch:us-west-2:012345678910:scheduling-policy/MySchedulingPolicy.

Parameters:

schedulingPolicyArn - Amazon Resource Name (ARN) of the fair share scheduling policy. If this parameter is specified, the job queue will use a fair share scheduling policy. If this parameter is not specified, the job queue will use a first in, first out (FIFO) scheduling policy. Once a job queue is created, the fair share scheduling policy can be replaced but not removed. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name . For example, aws:aws:batch:us-west-2:012345678910:scheduling-policy/MySchedulingPolicy.

getSchedulingPolicyArn

public String getSchedulingPolicyArn()

Amazon Resource Name (ARN) of the fair share scheduling policy. If this parameter is specified, the job queue will use a fair share scheduling policy. If this parameter is not specified, the job queue will use a first in, first out (FIFO) scheduling policy. Once a job queue is created, the fair share scheduling policy can be replaced but not removed. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name . For example, aws:aws:batch:us-west-2:012345678910:scheduling-policy/MySchedulingPolicy.

Returns:

Amazon Resource Name (ARN) of the fair share scheduling policy. If this parameter is specified, the job queue will use a fair share scheduling policy. If this parameter is not specified, the job queue will use a first in, first out (FIFO) scheduling policy. Once a job queue is created, the fair share scheduling policy can be replaced but not removed. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name . For example, aws:aws:batch:us-west-2:012345678910:scheduling-policy/MySchedulingPolicy.

withSchedulingPolicyArn

public CreateJobQueueRequest withSchedulingPolicyArn(String schedulingPolicyArn)

Amazon Resource Name (ARN) of the fair share scheduling policy. If this parameter is specified, the job queue will use a fair share scheduling policy. If this parameter is not specified, the job queue will use a first in, first out (FIFO) scheduling policy. Once a job queue is created, the fair share scheduling policy can be replaced but not removed. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name . For example, aws:aws:batch:us-west-2:012345678910:scheduling-policy/MySchedulingPolicy.

Parameters:

schedulingPolicyArn - Amazon Resource Name (ARN) of the fair share scheduling policy. If this parameter is specified, the job queue will use a fair share scheduling policy. If this parameter is not specified, the job queue will use a first in, first out (FIFO) scheduling policy. Once a job queue is created, the fair share scheduling policy can be replaced but not removed. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name . For example, aws:aws:batch:us-west-2:012345678910:scheduling-policy/MySchedulingPolicy.

Returns:

Returns a reference to this object so that method calls can be chained together.

setPriority

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.

Parameters:

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.

getPriority

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.

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.

withPriority

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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

getComputeEnvironmentOrder

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 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. Batch doesn't support mixing compute environment architecture types in a single job queue.

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. Batch doesn't support mixing compute environment architecture types in a single job queue.

setComputeEnvironmentOrder

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 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. Batch doesn't support mixing compute environment architecture types in a single job queue.

Parameters:

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. Batch doesn't support mixing compute environment architecture types in a single job queue.

withComputeEnvironmentOrder

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

Parameters:

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. Batch doesn't support mixing compute environment architecture types in a single job queue.

Returns:

Returns a reference to this object so that method calls can be chained together.

withComputeEnvironmentOrder

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 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. Batch doesn't support mixing compute environment architecture types in a single job queue.

Parameters:

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. Batch doesn't support mixing compute environment architecture types in a single job queue.

Returns:

Returns a reference to this object so that method calls can be chained together.

getTags

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.

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 Batch resources in Batch User Guide.

setTags

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.

Parameters:

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.

withTags

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

addTagsEntry

public CreateJobQueueRequest addTagsEntry(String key,
                                          String value)

Add a single Tags entry

See Also:

withTags(java.util.Map<java.lang.String, java.lang.String>)

clearTagsEntries

public CreateJobQueueRequest clearTagsEntries()

Removes all the entries added into Tags.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateJobQueueRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()