Class UpdateQueueRequest

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.UpdateQueueRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateQueueRequest.Builder,UpdateQueueRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateQueueRequest extends DeadlineRequest implements ToCopyableBuilder<UpdateQueueRequest.Builder,UpdateQueueRequest>

  • Method Details

    • clientToken

      public final String clientToken()

      The idempotency token to update in the queue.

      Returns:
      The idempotency token to update in the queue.

    • farmId

      public final String farmId()

      The farm ID to update in the queue.

      Returns:
      The farm ID to update in the queue.

    • queueId

      public final String queueId()

      The queue ID to update.

      Returns:
      The queue ID to update.

    • displayName

      public final String displayName()

      The display name of the queue to update.

      This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

      Returns:
      The display name of the queue to update.

      This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

    • description

      public final String description()

      The description of the queue to update.

      This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

      Returns:
      The description of the queue to update.

      This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

    • defaultBudgetAction

      public final DefaultQueueBudgetAction defaultBudgetAction()

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

      If the service returns an enum value that is not available in the current SDK version, defaultBudgetAction will return DefaultQueueBudgetAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from defaultBudgetActionAsString().

      Returns:
      The default action to take for a queue update if a budget isn't configured.
      See Also:

    • defaultBudgetActionAsString

      public final String defaultBudgetActionAsString()

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

      If the service returns an enum value that is not available in the current SDK version, defaultBudgetAction will return DefaultQueueBudgetAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from defaultBudgetActionAsString().

      Returns:
      The default action to take for a queue update if a budget isn't configured.
      See Also:

    • jobAttachmentSettings

      public final JobAttachmentSettings jobAttachmentSettings()

      The job attachment settings to update for the queue.

      Returns:
      The job attachment settings to update for the queue.

    • roleArn

      public final String roleArn()

      The IAM role ARN that's used to run jobs from this queue.

      Returns:
      The IAM role ARN that's used to run jobs from this queue.

    • jobRunAsUser

      public final JobRunAsUser jobRunAsUser()

      Update the jobs in the queue to run as a specified POSIX user.

      Returns:
      Update the jobs in the queue to run as a specified POSIX user.

    • hasRequiredFileSystemLocationNamesToAdd

      public final boolean hasRequiredFileSystemLocationNamesToAdd()
      For responses, this returns true if the service returned a value for the RequiredFileSystemLocationNamesToAdd property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • requiredFileSystemLocationNamesToAdd

      public final List<String> requiredFileSystemLocationNamesToAdd()

      The required file system location names to add to 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 hasRequiredFileSystemLocationNamesToAdd() method.

      Returns:
      The required file system location names to add to the queue.

    • hasRequiredFileSystemLocationNamesToRemove

      public final boolean hasRequiredFileSystemLocationNamesToRemove()
      For responses, this returns true if the service returned a value for the RequiredFileSystemLocationNamesToRemove property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • requiredFileSystemLocationNamesToRemove

      public final List<String> requiredFileSystemLocationNamesToRemove()

      The required file system location names to remove from 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 hasRequiredFileSystemLocationNamesToRemove() method.

      Returns:
      The required file system location names to remove from the queue.

    • hasAllowedStorageProfileIdsToAdd

      public final boolean hasAllowedStorageProfileIdsToAdd()
      For responses, this returns true if the service returned a value for the AllowedStorageProfileIdsToAdd property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • allowedStorageProfileIdsToAdd

      public final List<String> allowedStorageProfileIdsToAdd()

      The storage profile IDs to add.

      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 hasAllowedStorageProfileIdsToAdd() method.

      Returns:
      The storage profile IDs to add.

    • hasAllowedStorageProfileIdsToRemove

      public final boolean hasAllowedStorageProfileIdsToRemove()
      For responses, this returns true if the service returned a value for the AllowedStorageProfileIdsToRemove property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • allowedStorageProfileIdsToRemove

      public final List<String> allowedStorageProfileIdsToRemove()

      The storage profile ID to remove.

      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 hasAllowedStorageProfileIdsToRemove() method.

      Returns:
      The storage profile ID to remove.

    • toBuilder

      public UpdateQueueRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdateQueueRequest.Builder,UpdateQueueRequest>
      Specified by:
      toBuilder in class DeadlineRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateQueueRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateQueueRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.