Class Queue

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

A queue resource.

See Also:

  • Method Details

    • name

      public final String name()

      The name that identifies the queue.

      Returns:
      The name that identifies the queue.

    • id

      public final String id()

      The generated unique ID of the queue.

      Returns:
      The generated unique ID of the queue.

    • arn

      public final String arn()

      The unique Amazon Resource Name (ARN) of the queue.

      Returns:
      The unique Amazon Resource Name (ARN) of the queue.

    • clusterId

      public final String clusterId()

      The ID of the cluster of the queue.

      Returns:
      The ID of the cluster of the queue.

    • createdAt

      public final Instant createdAt()

      The date and time the resource was created.

      Returns:
      The date and time the resource was created.

    • modifiedAt

      public final Instant modifiedAt()

      The date and time the resource was modified.

      Returns:
      The date and time the resource was modified.

    • status

      public final QueueStatus status()

      The provisioning status of the queue.

      The provisioning status doesn't indicate the overall health 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:
      The provisioning status of the queue.

      The provisioning status doesn't indicate the overall health of the queue.

      See Also:

    • statusAsString

      public final String statusAsString()

      The provisioning status of the queue.

      The provisioning status doesn't indicate the overall health 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:
      The provisioning status of the queue.

      The provisioning status doesn't indicate the overall health of the queue.

      See Also:

    • hasComputeNodeGroupConfigurations

      public final boolean hasComputeNodeGroupConfigurations()
      For responses, this returns true if the service returned a value for the ComputeNodeGroupConfigurations 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.

    • computeNodeGroupConfigurations

      public final List<ComputeNodeGroupConfiguration> computeNodeGroupConfigurations()

      The list of compute node group configurations associated with the queue. Queues assign jobs to associated compute node groups.

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

      Returns:
      The list of compute node group configurations associated with the queue. Queues assign jobs to associated compute node groups.

    • hasErrorInfo

      public final boolean hasErrorInfo()
      For responses, this returns true if the service returned a value for the ErrorInfo 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.

    • errorInfo

      public final List<ErrorInfo> errorInfo()

      The list of errors that occurred during queue provisioning.

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

      Returns:
      The list of errors that occurred during queue provisioning.

    • toBuilder

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

    • builder

      public static Queue.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Queue.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.