Class GetQueueResponse

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

        public final List<String> allowedStorageProfileIds()

        The storage profile IDs for 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 for the queue.
      • createdAt

        public final Instant createdAt()

        The date and time the resource was created.

        Returns:
        The date and time the resource was created.
      • createdBy

        public final String createdBy()

        The user or system that created this resource.

        Returns:
        The user or system that created this resource.
      • 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 for the queue.

        Returns:
        The farm ID for the queue.
      • jobAttachmentSettings

        public final JobAttachmentSettings jobAttachmentSettings()

        The job attachment settings for the queue.

        Returns:
        The job attachment settings for the queue.
      • jobRunAsUser

        public final JobRunAsUser jobRunAsUser()

        The jobs in the queue ran as this specified POSIX user.

        Returns:
        The jobs in the queue ran as this specified POSIX user.
      • queueId

        public final String queueId()

        The queue ID.

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

        public final List<String> requiredFileSystemLocationNames()

        A list of the required file system location names 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:
        A list of the required file system location names in the queue.
      • roleArn

        public final String roleArn()

        The IAM role ARN.

        Returns:
        The IAM role ARN.
      • status

        public final QueueStatus status()

        The status of the queue.

        • ACTIVE–The queue is active.

        • SCHEDULING–The queue is scheduling.

        • SCHEDULING_BLOCKED–The queue scheduling is blocked. See the provided reason.

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

        Returns:
        The status of the queue.

        • ACTIVE–The queue is active.

        • SCHEDULING–The queue is scheduling.

        • SCHEDULING_BLOCKED–The queue scheduling is blocked. See the provided reason.

        See Also:
        QueueStatus
      • statusAsString

        public final String statusAsString()

        The status of the queue.

        • ACTIVE–The queue is active.

        • SCHEDULING–The queue is scheduling.

        • SCHEDULING_BLOCKED–The queue scheduling is blocked. See the provided reason.

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

        Returns:
        The status of the queue.

        • ACTIVE–The queue is active.

        • SCHEDULING–The queue is scheduling.

        • SCHEDULING_BLOCKED–The queue scheduling is blocked. See the provided reason.

        See Also:
        QueueStatus
      • updatedAt

        public final Instant updatedAt()

        The date and time the resource was updated.

        Returns:
        The date and time the resource was updated.
      • updatedBy

        public final String updatedBy()

        The user or system that updated this resource.

        Returns:
        The user or system that updated this resource.
      • 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