Class QueueSummary

java.lang.Object
software.amazon.awssdk.services.deadline.model.QueueSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<QueueSummary.Builder,QueueSummary>
@Generated("software.amazon.awssdk:codegen") public final class QueueSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<QueueSummary.Builder,QueueSummary>

The details of a queue summary.

See Also:

  • Method Details

    • farmId

      public final String farmId()

      The farm ID.

      Returns:
      The farm ID.

    • queueId

      public final String queueId()

      The queue ID.

      Returns:
      The queue ID.

    • displayName

      public final String displayName()

      The display name of the queue summary 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 summary 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.

    • status

      public final QueueStatus status()

      That status of the queue.

      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:
      That status of the queue.
      See Also:

    • statusAsString

      public final String statusAsString()

      That status of the queue.

      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:
      That status of the queue.
      See Also:

    • defaultBudgetAction

      public final DefaultQueueBudgetAction defaultBudgetAction()

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

    • defaultBudgetActionAsString

      public final String defaultBudgetActionAsString()

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

    • blockedReason

      public final QueueBlockedReason blockedReason()

      The reason the queue is blocked, if applicable.

      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 is blocked, if applicable.
      See Also:

    • blockedReasonAsString

      public final String blockedReasonAsString()

      The reason the queue is blocked, if applicable.

      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 is blocked, if applicable.
      See Also:

    • 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 QueueSummary.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<QueueSummary.Builder,QueueSummary>
      Returns:
      a builder for type T

    • builder

      public static QueueSummary.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

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