Class UpdateQueueRequest

    • Method Detail

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

        public final String clientToken()

        The idempotency token to update in the queue.

        Returns:
        The idempotency token to update in the queue.
      • 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:
        DefaultQueueBudgetAction
      • description

        public final String description()

        The description of the queue to update.

        Returns:
        The description of the queue to update.
      • displayName

        public final String displayName()

        The display name of the queue to update.

        Returns:
        The display name of the queue to update.
      • farmId

        public final String farmId()

        The farm ID to update in the queue.

        Returns:
        The farm ID to update in the queue.
      • jobAttachmentSettings

        public final JobAttachmentSettings jobAttachmentSettings()

        The job attachment settings to update for the queue.

        Returns:
        The job attachment settings to update for the 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.
      • queueId

        public final String queueId()

        The queue ID to update.

        Returns:
        The queue ID to update.
      • 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.
      • 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.
      • 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