Class CreateQueueRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.deadline.model.DeadlineRequest
-
- software.amazon.awssdk.services.deadline.model.CreateQueueRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateQueueRequest.Builder,CreateQueueRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateQueueRequest extends DeadlineRequest implements ToCopyableBuilder<CreateQueueRequest.Builder,CreateQueueRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateQueueRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<String>allowedStorageProfileIds()The storage profile IDs to include in the queue.static CreateQueueRequest.Builderbuilder()StringclientToken()The unique token which the server uses to recognize retries of the same request.DefaultQueueBudgetActiondefaultBudgetAction()The default action to take on a queue if a budget isn't configured.StringdefaultBudgetActionAsString()The default action to take on a queue if a budget isn't configured.Stringdescription()The description of the queue.StringdisplayName()The display name of the queue.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringfarmId()The farm ID of the farm to connect to the queue.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAllowedStorageProfileIds()For responses, this returns true if the service returned a value for the AllowedStorageProfileIds property.inthashCode()booleanhasRequiredFileSystemLocationNames()For responses, this returns true if the service returned a value for the RequiredFileSystemLocationNames property.booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.JobAttachmentSettingsjobAttachmentSettings()The job attachment settings for the queue.JobRunAsUserjobRunAsUser()The jobs in the queue run as the specified POSIX user.List<String>requiredFileSystemLocationNames()The file system location name to include in the queue.StringroleArn()The IAM role ARN that workers will use while running jobs for this queue.List<SdkField<?>>sdkFields()static Class<? extends CreateQueueRequest.Builder>serializableBuilderClass()Map<String,String>tags()Each tag consists of a tag key and a tag value.CreateQueueRequest.BuildertoBuilder()StringtoString()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
-
hasAllowedStorageProfileIds
public final boolean hasAllowedStorageProfileIds()
For responses, this returns true if the service returned a value for the AllowedStorageProfileIds property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
allowedStorageProfileIds
public final List<String> allowedStorageProfileIds()
The storage profile IDs to include in the 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
hasAllowedStorageProfileIds()method.- Returns:
- The storage profile IDs to include in the queue.
-
clientToken
public final String clientToken()
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.
-
defaultBudgetAction
public final DefaultQueueBudgetAction defaultBudgetAction()
The default action to take on a queue if a budget isn't configured.
If the service returns an enum value that is not available in the current SDK version,
defaultBudgetActionwill returnDefaultQueueBudgetAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdefaultBudgetActionAsString().- Returns:
- The default action to take on a queue if a budget isn't configured.
- See Also:
DefaultQueueBudgetAction
-
defaultBudgetActionAsString
public final String defaultBudgetActionAsString()
The default action to take on a queue if a budget isn't configured.
If the service returns an enum value that is not available in the current SDK version,
defaultBudgetActionwill returnDefaultQueueBudgetAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdefaultBudgetActionAsString().- Returns:
- The default action to take on a queue if a budget isn't configured.
- See Also:
DefaultQueueBudgetAction
-
description
public final String description()
The description of the queue.
- Returns:
- The description of the queue.
-
displayName
public final String displayName()
The display name of the queue.
- Returns:
- The display name of the queue.
-
farmId
public final String farmId()
The farm ID of the farm to connect to the queue.
- Returns:
- The farm ID of the farm to connect to the queue.
-
jobAttachmentSettings
public final JobAttachmentSettings jobAttachmentSettings()
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.
-
jobRunAsUser
public final JobRunAsUser jobRunAsUser()
The jobs in the queue run as the specified POSIX user.
- Returns:
- The jobs in the queue run as the specified POSIX user.
-
hasRequiredFileSystemLocationNames
public final boolean hasRequiredFileSystemLocationNames()
For responses, this returns true if the service returned a value for the RequiredFileSystemLocationNames property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
requiredFileSystemLocationNames
public final List<String> requiredFileSystemLocationNames()
The file system location name to include in the 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
hasRequiredFileSystemLocationNames()method.- Returns:
- The file system location name to include in the queue.
-
roleArn
public final String roleArn()
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.
-
hasTags
public final boolean hasTags()
For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
tags
public final 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.
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.- 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.
-
toBuilder
public CreateQueueRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateQueueRequest.Builder,CreateQueueRequest>- Specified by:
toBuilderin classDeadlineRequest
-
builder
public static CreateQueueRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateQueueRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-