Class Queue
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Queue.Builder,
Queue>
Contains information about a queue.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Queue.Builder
builder()
final String
The description of the queue.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
The identifier for the hours of operation.final String
The Amazon Web Services Region where this resource was last modified.final Instant
The timestamp when this resource was last modified.final Integer
The maximum number of contacts that can be in the queue before it is considered full.final String
name()
The name of the queue.final OutboundCallerConfig
The outbound caller ID name, number, and outbound whisper flow.final String
queueArn()
The Amazon Resource Name (ARN) for the queue.final String
queueId()
The identifier for the queue.static Class
<? extends Queue.Builder> final QueueStatus
status()
The status of the queue.final String
The status of the queue.tags()
The tags used to organize, track, or control access for this resource.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the queue.
- Returns:
- The name of the queue.
-
queueArn
The Amazon Resource Name (ARN) for the queue.
- Returns:
- The Amazon Resource Name (ARN) for the queue.
-
queueId
The identifier for the queue.
- Returns:
- The identifier for the queue.
-
description
The description of the queue.
- Returns:
- The description of the queue.
-
outboundCallerConfig
The outbound caller ID name, number, and outbound whisper flow.
- Returns:
- The outbound caller ID name, number, and outbound whisper flow.
-
hoursOfOperationId
The identifier for the hours of operation.
- Returns:
- The identifier for the hours of operation.
-
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
The status of the queue.
If the service returns an enum value that is not available in the current SDK version,
status
will returnQueueStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the queue.
- See Also:
-
statusAsString
The status of the queue.
If the service returns an enum value that is not available in the current SDK version,
status
will returnQueueStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- 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 theisEmpty()
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
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
The timestamp when this resource was last modified.
- Returns:
- The timestamp when this resource was last modified.
-
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
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 interfaceToCopyableBuilder<Queue.Builder,
Queue> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-