Class Queue

java.lang.Object
software.amazon.awssdk.services.connect.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>

Contains information about a queue.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the queue.

      Returns:
      The name of the queue.

    • queueArn

      public final String queueArn()

      The Amazon Resource Name (ARN) for the queue.

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

    • queueId

      public final String queueId()

      The identifier for the queue.

      Returns:
      The identifier for the queue.

    • description

      public final String description()

      The description of the queue.

      Returns:
      The description of the queue.

    • outboundCallerConfig

      public final OutboundCallerConfig outboundCallerConfig()

      The outbound caller ID name, number, and outbound whisper flow.

      Returns:
      The outbound caller ID name, number, and outbound whisper flow.

    • outboundEmailConfig

      public final OutboundEmailConfig outboundEmailConfig()

      The outbound email address ID for a specified queue.

      Returns:
      The outbound email address ID for a specified queue.

    • hoursOfOperationId

      public final String hoursOfOperationId()

      The identifier for the hours of operation.

      Returns:
      The identifier for the hours of operation.

    • maxContacts

      public final Integer maxContacts()

      The maximum number of contacts that can be in the queue before it is considered full.

      Returns:
      The maximum number of contacts that can be in the queue before it is considered full.

    • status

      public final QueueStatus status()

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

    • statusAsString

      public final String statusAsString()

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

    • hasTags

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

    • tags

      public final Map<String,String> tags()

      The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

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

      Returns:
      The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The timestamp when this resource was last modified.

      Returns:
      The timestamp when this resource was last modified.

    • lastModifiedRegion

      public final String lastModifiedRegion()

      The Amazon Web Services Region where this resource was last modified.

      Returns:
      The Amazon Web Services Region where this resource was last modified.

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

    • sdkFieldNameToField

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