Class GetQueueResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.deadline.model.DeadlineResponse
software.amazon.awssdk.services.deadline.model.GetQueueResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetQueueResponse.Builder,GetQueueResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetQueueResponse extends DeadlineResponse implements ToCopyableBuilder<GetQueueResponse.Builder,GetQueueResponse>

  • Method Details

    • queueId

      public final String queueId()

      The queue ID.

      Returns:
      The queue ID.

    • displayName

      public final String displayName()

      The display name of the queue.

      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.

      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.

      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.

      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.

    • farmId

      public final String farmId()

      The farm ID for the queue.

      Returns:
      The farm ID for the queue.

    • 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:

    • 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:

    • defaultBudgetAction

      public final DefaultQueueBudgetAction defaultBudgetAction()

      The default action taken on a queue if a budget wasn'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 taken on a queue if a budget wasn't configured.
      See Also:

    • defaultBudgetActionAsString

      public final String defaultBudgetActionAsString()

      The default action taken on a queue if a budget wasn'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 taken on a queue if a budget wasn't configured.
      See Also:

    • blockedReason

      public final QueueBlockedReason blockedReason()

      The reason the queue was blocked.

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

      Returns:
      The reason the queue was blocked.
      See Also:

    • blockedReasonAsString

      public final String blockedReasonAsString()

      The reason the queue was blocked.

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

      Returns:
      The reason the queue was blocked.
      See Also:

    • jobAttachmentSettings

      public final JobAttachmentSettings jobAttachmentSettings()

      The job attachment settings for the queue.

      Returns:
      The job attachment settings for the queue.

    • roleArn

      public final String roleArn()

      The IAM role ARN.

      Returns:
      The IAM role ARN.

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

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

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

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

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

    • toBuilder

      public GetQueueResponse.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<GetQueueResponse.Builder,GetQueueResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetQueueResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.