com.amazonaws.services.deadline.model

Class CreateQueueRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.deadline.model.CreateQueueRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateQueueRequest()

Method Summary

Modifier and Type	Method and Description
CreateQueueRequest	addTagsEntry(String key, String value) Add a single Tags entry
CreateQueueRequest	clearTagsEntries() Removes all the entries added into Tags.
CreateQueueRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<String>	getAllowedStorageProfileIds() The storage profile IDs to include in the queue.
String	getClientToken() The unique token which the server uses to recognize retries of the same request.
String	getDefaultBudgetAction() The default action to take on a queue if a budget isn't configured.
String	getDescription() The description of the queue.
String	getDisplayName() The display name of the queue.
String	getFarmId() The farm ID of the farm to connect to the queue.
JobAttachmentSettings	getJobAttachmentSettings() The job attachment settings for the queue.
JobRunAsUser	getJobRunAsUser() The jobs in the queue run as the specified POSIX user.
List<String>	getRequiredFileSystemLocationNames() The file system location name to include in the queue.
String	getRoleArn() The IAM role ARN that workers will use while running jobs for this queue.
Map<String,String>	getTags() Each tag consists of a tag key and a tag value.
int	hashCode()
void	setAllowedStorageProfileIds(Collection<String> allowedStorageProfileIds) The storage profile IDs to include in the queue.
void	setClientToken(String clientToken) The unique token which the server uses to recognize retries of the same request.
void	setDefaultBudgetAction(String defaultBudgetAction) The default action to take on a queue if a budget isn't configured.
void	setDescription(String description) The description of the queue.
void	setDisplayName(String displayName) The display name of the queue.
void	setFarmId(String farmId) The farm ID of the farm to connect to the queue.
void	setJobAttachmentSettings(JobAttachmentSettings jobAttachmentSettings) The job attachment settings for the queue.
void	setJobRunAsUser(JobRunAsUser jobRunAsUser) The jobs in the queue run as the specified POSIX user.
void	setRequiredFileSystemLocationNames(Collection<String> requiredFileSystemLocationNames) The file system location name to include in the queue.
void	setRoleArn(String roleArn) The IAM role ARN that workers will use while running jobs for this queue.
void	setTags(Map<String,String> tags) Each tag consists of a tag key and a tag value.
String	toString() Returns a string representation of this object.
CreateQueueRequest	withAllowedStorageProfileIds(Collection<String> allowedStorageProfileIds) The storage profile IDs to include in the queue.
CreateQueueRequest	withAllowedStorageProfileIds(String... allowedStorageProfileIds) The storage profile IDs to include in the queue.
CreateQueueRequest	withClientToken(String clientToken) The unique token which the server uses to recognize retries of the same request.
CreateQueueRequest	withDefaultBudgetAction(DefaultQueueBudgetAction defaultBudgetAction) The default action to take on a queue if a budget isn't configured.
CreateQueueRequest	withDefaultBudgetAction(String defaultBudgetAction) The default action to take on a queue if a budget isn't configured.
CreateQueueRequest	withDescription(String description) The description of the queue.
CreateQueueRequest	withDisplayName(String displayName) The display name of the queue.
CreateQueueRequest	withFarmId(String farmId) The farm ID of the farm to connect to the queue.
CreateQueueRequest	withJobAttachmentSettings(JobAttachmentSettings jobAttachmentSettings) The job attachment settings for the queue.
CreateQueueRequest	withJobRunAsUser(JobRunAsUser jobRunAsUser) The jobs in the queue run as the specified POSIX user.
CreateQueueRequest	withRequiredFileSystemLocationNames(Collection<String> requiredFileSystemLocationNames) The file system location name to include in the queue.
CreateQueueRequest	withRequiredFileSystemLocationNames(String... requiredFileSystemLocationNames) The file system location name to include in the queue.
CreateQueueRequest	withRoleArn(String roleArn) The IAM role ARN that workers will use while running jobs for this queue.
CreateQueueRequest	withTags(Map<String,String> tags) Each tag consists of a tag key and a tag value.

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

CreateQueueRequest

public CreateQueueRequest()

Method Detail

getAllowedStorageProfileIds

public List<String> getAllowedStorageProfileIds()

The storage profile IDs to include in the queue.

Returns:

The storage profile IDs to include in the queue.

setAllowedStorageProfileIds

public void setAllowedStorageProfileIds(Collection<String> allowedStorageProfileIds)

The storage profile IDs to include in the queue.

Parameters:

allowedStorageProfileIds - The storage profile IDs to include in the queue.

withAllowedStorageProfileIds

public CreateQueueRequest withAllowedStorageProfileIds(String... allowedStorageProfileIds)

The storage profile IDs to include in the queue.

NOTE: This method appends the values to the existing list (if any). Use setAllowedStorageProfileIds(java.util.Collection) or withAllowedStorageProfileIds(java.util.Collection) if you want to override the existing values.

Parameters:

allowedStorageProfileIds - The storage profile IDs to include in the queue.

Returns:

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

withAllowedStorageProfileIds

public CreateQueueRequest withAllowedStorageProfileIds(Collection<String> allowedStorageProfileIds)

The storage profile IDs to include in the queue.

Parameters:

allowedStorageProfileIds - The storage profile IDs to include in the queue.

Returns:

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

setClientToken

public void setClientToken(String clientToken)

The unique token which the server uses to recognize retries of the same request.

Parameters:

clientToken - The unique token which the server uses to recognize retries of the same request.

getClientToken

public String getClientToken()

The unique token which the server uses to recognize retries of the same request.

Returns:

The unique token which the server uses to recognize retries of the same request.

withClientToken

public CreateQueueRequest withClientToken(String clientToken)

The unique token which the server uses to recognize retries of the same request.

Parameters:

clientToken - The unique token which the server uses to recognize retries of the same request.

Returns:

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

setDefaultBudgetAction

public void setDefaultBudgetAction(String defaultBudgetAction)

The default action to take on a queue if a budget isn't configured.

Parameters:

defaultBudgetAction - The default action to take on a queue if a budget isn't configured.

See Also:

DefaultQueueBudgetAction

getDefaultBudgetAction

public String getDefaultBudgetAction()

The default action to take on a queue if a budget isn't configured.

Returns:

The default action to take on a queue if a budget isn't configured.

See Also:

DefaultQueueBudgetAction

withDefaultBudgetAction

public CreateQueueRequest withDefaultBudgetAction(String defaultBudgetAction)

The default action to take on a queue if a budget isn't configured.

Parameters:

defaultBudgetAction - The default action to take on a queue if a budget isn't configured.

Returns:

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

See Also:

DefaultQueueBudgetAction

withDefaultBudgetAction

public CreateQueueRequest withDefaultBudgetAction(DefaultQueueBudgetAction defaultBudgetAction)

The default action to take on a queue if a budget isn't configured.

Parameters:

defaultBudgetAction - The default action to take on a queue if a budget isn't configured.

Returns:

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

See Also:

DefaultQueueBudgetAction

setDescription

public void setDescription(String description)

The description of the queue.

Parameters:

description - The description of the queue.

getDescription

public String getDescription()

The description of the queue.

Returns:

The description of the queue.

withDescription

public CreateQueueRequest withDescription(String description)

The description of the queue.

Parameters:

description - The description of the queue.

Returns:

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

setDisplayName

public void setDisplayName(String displayName)

The display name of the queue.

Parameters:

displayName - The display name of the queue.

getDisplayName

public String getDisplayName()

The display name of the queue.

Returns:

The display name of the queue.

withDisplayName

public CreateQueueRequest withDisplayName(String displayName)

The display name of the queue.

Parameters:

displayName - The display name of the queue.

Returns:

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

setFarmId

public void setFarmId(String farmId)

The farm ID of the farm to connect to the queue.

Parameters:

farmId - The farm ID of the farm to connect to the queue.

getFarmId

public String getFarmId()

The farm ID of the farm to connect to the queue.

Returns:

The farm ID of the farm to connect to the queue.

withFarmId

public CreateQueueRequest withFarmId(String farmId)

The farm ID of the farm to connect to the queue.

Parameters:

farmId - The farm ID of the farm to connect to the queue.

Returns:

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

setJobAttachmentSettings

public void setJobAttachmentSettings(JobAttachmentSettings jobAttachmentSettings)

The job attachment settings for the queue. These are the Amazon S3 bucket name and the Amazon S3 prefix.

Parameters:

jobAttachmentSettings - The job attachment settings for the queue. These are the Amazon S3 bucket name and the Amazon S3 prefix.

getJobAttachmentSettings

public JobAttachmentSettings getJobAttachmentSettings()

The job attachment settings for the queue. These are the Amazon S3 bucket name and the Amazon S3 prefix.

Returns:

The job attachment settings for the queue. These are the Amazon S3 bucket name and the Amazon S3 prefix.

withJobAttachmentSettings

public CreateQueueRequest withJobAttachmentSettings(JobAttachmentSettings jobAttachmentSettings)

The job attachment settings for the queue. These are the Amazon S3 bucket name and the Amazon S3 prefix.

Parameters:

jobAttachmentSettings - The job attachment settings for the queue. These are the Amazon S3 bucket name and the Amazon S3 prefix.

Returns:

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

setJobRunAsUser

public void setJobRunAsUser(JobRunAsUser jobRunAsUser)

The jobs in the queue run as the specified POSIX user.

Parameters:

jobRunAsUser - The jobs in the queue run as the specified POSIX user.

getJobRunAsUser

public JobRunAsUser getJobRunAsUser()

The jobs in the queue run as the specified POSIX user.

Returns:

The jobs in the queue run as the specified POSIX user.

withJobRunAsUser

public CreateQueueRequest withJobRunAsUser(JobRunAsUser jobRunAsUser)

The jobs in the queue run as the specified POSIX user.

Parameters:

jobRunAsUser - The jobs in the queue run as the specified POSIX user.

Returns:

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

getRequiredFileSystemLocationNames

public List<String> getRequiredFileSystemLocationNames()

The file system location name to include in the queue.

Returns:

The file system location name to include in the queue.

setRequiredFileSystemLocationNames

public void setRequiredFileSystemLocationNames(Collection<String> requiredFileSystemLocationNames)

The file system location name to include in the queue.

Parameters:

requiredFileSystemLocationNames - The file system location name to include in the queue.

withRequiredFileSystemLocationNames

public CreateQueueRequest withRequiredFileSystemLocationNames(String... requiredFileSystemLocationNames)

The file system location name to include in the queue.

NOTE: This method appends the values to the existing list (if any). Use setRequiredFileSystemLocationNames(java.util.Collection) or withRequiredFileSystemLocationNames(java.util.Collection) if you want to override the existing values.

Parameters:

requiredFileSystemLocationNames - The file system location name to include in the queue.

Returns:

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

withRequiredFileSystemLocationNames

public CreateQueueRequest withRequiredFileSystemLocationNames(Collection<String> requiredFileSystemLocationNames)

The file system location name to include in the queue.

Parameters:

requiredFileSystemLocationNames - The file system location name to include in the queue.

Returns:

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

setRoleArn

public void setRoleArn(String roleArn)

The IAM role ARN that workers will use while running jobs for this queue.

Parameters:

roleArn - The IAM role ARN that workers will use while running jobs for this queue.

getRoleArn

public String getRoleArn()

The IAM role ARN that workers will use while running jobs for this queue.

Returns:

The IAM role ARN that workers will use while running jobs for this queue.

withRoleArn

public CreateQueueRequest withRoleArn(String roleArn)

The IAM role ARN that workers will use while running jobs for this queue.

Parameters:

roleArn - The IAM role ARN that workers will use while running jobs for this queue.

Returns:

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

getTags

public Map<String,String> getTags()

Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.

Returns:

Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.

setTags

public void setTags(Map<String,String> tags)

Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.

Parameters:

tags - Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.

withTags

public CreateQueueRequest withTags(Map<String,String> tags)

Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.

Parameters:

tags - Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.

Returns:

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

addTagsEntry

public CreateQueueRequest addTagsEntry(String key,
                                       String value)

Add a single Tags entry

See Also:

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

clearTagsEntries

public CreateQueueRequest 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 CreateQueueRequest 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()