CreateQueueRequest (aws-android-sdk-connect 2.81.1 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.connect.model.CreateQueueRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class CreateQueueRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable
```
This API is in preview release for Amazon Connect and is subject to change.

Creates a new queue for the specified Amazon Connect instance.

If the number being used in the input is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the OutboundCallerIdNumberId value of the OutboundCallerConfig request body parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.

Only use the phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

CreateQueueRequest()

Constructors
Constructor and Description
`CreateQueueRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateQueueRequest`	`addTagsEntry(java.lang.String key, java.lang.String value)` The tags used to organize, track, or control access for this resource.
`CreateQueueRequest`	`clearTagsEntries()` Removes all the entries added into Tags.
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getDescription()` The description of the queue.
`java.lang.String`	`getHoursOfOperationId()` The identifier for the hours of operation.
`java.lang.String`	`getInstanceId()` The identifier of the Amazon Connect instance.
`java.lang.Integer`	`getMaxContacts()` The maximum number of contacts that can be in the queue before it is considered full.
`java.lang.String`	`getName()` The name of the queue.
`OutboundCallerConfig`	`getOutboundCallerConfig()` The outbound caller ID name, number, and outbound whisper flow.
`java.util.List<java.lang.String>`	`getQuickConnectIds()` The quick connects available to agents who are working the queue.
`java.util.Map<java.lang.String,java.lang.String>`	`getTags()` The tags used to organize, track, or control access for this resource.
`int`	`hashCode()`
`void`	`setDescription(java.lang.String description)` The description of the queue.
`void`	`setHoursOfOperationId(java.lang.String hoursOfOperationId)` The identifier for the hours of operation.
`void`	`setInstanceId(java.lang.String instanceId)` The identifier of the Amazon Connect instance.
`void`	`setMaxContacts(java.lang.Integer maxContacts)` The maximum number of contacts that can be in the queue before it is considered full.
`void`	`setName(java.lang.String name)` The name of the queue.
`void`	`setOutboundCallerConfig(OutboundCallerConfig outboundCallerConfig)` The outbound caller ID name, number, and outbound whisper flow.
`void`	`setQuickConnectIds(java.util.Collection<java.lang.String> quickConnectIds)` The quick connects available to agents who are working the queue.
`void`	`setTags(java.util.Map<java.lang.String,java.lang.String> tags)` The tags used to organize, track, or control access for this resource.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`CreateQueueRequest`	`withDescription(java.lang.String description)` The description of the queue.
`CreateQueueRequest`	`withHoursOfOperationId(java.lang.String hoursOfOperationId)` The identifier for the hours of operation.
`CreateQueueRequest`	`withInstanceId(java.lang.String instanceId)` The identifier of the Amazon Connect instance.
`CreateQueueRequest`	`withMaxContacts(java.lang.Integer maxContacts)` The maximum number of contacts that can be in the queue before it is considered full.
`CreateQueueRequest`	`withName(java.lang.String name)` The name of the queue.
`CreateQueueRequest`	`withOutboundCallerConfig(OutboundCallerConfig outboundCallerConfig)` The outbound caller ID name, number, and outbound whisper flow.
`CreateQueueRequest`	`withQuickConnectIds(java.util.Collection<java.lang.String> quickConnectIds)` The quick connects available to agents who are working the queue.
`CreateQueueRequest`	`withQuickConnectIds(java.lang.String... quickConnectIds)` The quick connects available to agents who are working the queue.
`CreateQueueRequest`	`withTags(java.util.Map<java.lang.String,java.lang.String> tags)` The tags used to organize, track, or control access for this resource.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateQueueRequest
```
public CreateQueueRequest()
```
- Method Detail
  - getInstanceId
```
public java.lang.String getInstanceId()
```
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
    
    Constraints:
    Length: 1 - 100
    
    Returns:
    
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
  - setInstanceId
```
public void setInstanceId(java.lang.String instanceId)
```
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
    
    Constraints:
    Length: 1 - 100
    
    Parameters:
    
    instanceId -
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
  - withInstanceId
```
public CreateQueueRequest withInstanceId(java.lang.String instanceId)
```
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 100
    
    Parameters:
    
    instanceId -
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getName
```
public java.lang.String getName()
```
    The name of the queue.
    
    Constraints:
    Length: 1 - 127
    
    Returns:
    
    The name of the queue.
  - setName
```
public void setName(java.lang.String name)
```
    The name of the queue.
    
    Constraints:
    Length: 1 - 127
    
    Parameters:
    
    name -
    The name of the queue.
  - withName
```
public CreateQueueRequest withName(java.lang.String name)
```
    The name of the queue.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 127
    
    Parameters:
    
    name -
    The name of the queue.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getDescription
```
public java.lang.String getDescription()
```
    The description of the queue.
    
    Constraints:
    Length: 1 - 250
    
    Returns:
    
    The description of the queue.
  - setDescription
```
public void setDescription(java.lang.String description)
```
    The description of the queue.
    
    Constraints:
    Length: 1 - 250
    
    Parameters:
    
    description -
    The description of the queue.
  - withDescription
```
public CreateQueueRequest withDescription(java.lang.String description)
```
    The description of the queue.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 250
    
    Parameters:
    
    description -
    The description of the queue.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getOutboundCallerConfig
```
public OutboundCallerConfig getOutboundCallerConfig()
```
    The outbound caller ID name, number, and outbound whisper flow.
    
    Returns:
    
    The outbound caller ID name, number, and outbound whisper flow.
  - setOutboundCallerConfig
```
public void setOutboundCallerConfig(OutboundCallerConfig outboundCallerConfig)
```
    The outbound caller ID name, number, and outbound whisper flow.
    
    Parameters:
    
    outboundCallerConfig -
    The outbound caller ID name, number, and outbound whisper flow.
  - withOutboundCallerConfig
```
public CreateQueueRequest withOutboundCallerConfig(OutboundCallerConfig outboundCallerConfig)
```
    The outbound caller ID name, number, and outbound whisper flow.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    outboundCallerConfig -
    The outbound caller ID name, number, and outbound whisper flow.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getHoursOfOperationId
```
public java.lang.String getHoursOfOperationId()
```
    The identifier for the hours of operation.
    
    Returns:
    
    The identifier for the hours of operation.
  - setHoursOfOperationId
```
public void setHoursOfOperationId(java.lang.String hoursOfOperationId)
```
    The identifier for the hours of operation.
    
    Parameters:
    
    hoursOfOperationId -
    The identifier for the hours of operation.
  - withHoursOfOperationId
```
public CreateQueueRequest withHoursOfOperationId(java.lang.String hoursOfOperationId)
```
    The identifier for the hours of operation.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    hoursOfOperationId -
    The identifier for the hours of operation.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getMaxContacts
```
public java.lang.Integer getMaxContacts()
```
    The maximum number of contacts that can be in the queue before it is considered full.
    
    Constraints:
    Range: 0 -
    
    Returns:
    
    The maximum number of contacts that can be in the queue before it is considered full.
  - setMaxContacts
```
public void setMaxContacts(java.lang.Integer maxContacts)
```
    The maximum number of contacts that can be in the queue before it is considered full.
    
    Constraints:
    Range: 0 -
    
    Parameters:
    
    maxContacts -
    The maximum number of contacts that can be in the queue before it is considered full.
  - withMaxContacts
```
public CreateQueueRequest withMaxContacts(java.lang.Integer maxContacts)
```
    The maximum number of contacts that can be in the queue before it is considered full.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 0 -
    
    Parameters:
    
    maxContacts -
    The maximum number of contacts that can be in the queue before it is considered full.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getQuickConnectIds
```
public java.util.List<java.lang.String> getQuickConnectIds()
```
    The quick connects available to agents who are working the queue.
    
    Returns:
    
    The quick connects available to agents who are working the queue.
  - setQuickConnectIds
```
public void setQuickConnectIds(java.util.Collection<java.lang.String> quickConnectIds)
```
    The quick connects available to agents who are working the queue.
    
    Parameters:
    
    quickConnectIds -
    The quick connects available to agents who are working the queue.
  - withQuickConnectIds
```
public CreateQueueRequest withQuickConnectIds(java.lang.String... quickConnectIds)
```
    The quick connects available to agents who are working the queue.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    quickConnectIds -
    The quick connects available to agents who are working the queue.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withQuickConnectIds
```
public CreateQueueRequest withQuickConnectIds(java.util.Collection<java.lang.String> quickConnectIds)
```
    The quick connects available to agents who are working the queue.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    quickConnectIds -
    The quick connects available to agents who are working the queue.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getTags
```
public java.util.Map<java.lang.String,java.lang.String> getTags()
```
    The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
    
    Returns:
    
    The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
  - setTags
```
public void setTags(java.util.Map<java.lang.String,java.lang.String> tags)
```
    The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
    
    Parameters:
    
    tags -
    The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
  - withTags
```
public CreateQueueRequest withTags(java.util.Map<java.lang.String,java.lang.String> tags)
```
    The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    tags -
    The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addTagsEntry
```
public CreateQueueRequest addTagsEntry(java.lang.String key,
                                       java.lang.String value)
```
    The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
    
    The method adds a new key-value pair into Tags parameter, and returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    key - The key of the entry to be added into Tags.
    
    value - The corresponding value of the entry to be added into Tags.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearTagsEntries
```
public CreateQueueRequest clearTagsEntries()
```
    Removes all the entries added into Tags.
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class CreateQueueRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateQueueRequest

Method Detail

getInstanceId

setInstanceId

withInstanceId

getName

setName

withName

getDescription

setDescription

withDescription

getOutboundCallerConfig

setOutboundCallerConfig

withOutboundCallerConfig

getHoursOfOperationId

setHoursOfOperationId

withHoursOfOperationId

getMaxContacts

setMaxContacts

withMaxContacts

getQuickConnectIds

setQuickConnectIds

withQuickConnectIds

withQuickConnectIds

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

toString

hashCode

equals