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

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class TransferContactRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable
```
Transfers contacts from one agent or queue to another agent or queue at any point after a contact is created. You can transfer a contact to another queue by providing the flow which orchestrates the contact to the destination queue. This gives you more control over contact handling and helps you adhere to the service level agreement (SLA) guaranteed to your customers.

Note the following requirements:
- Transfer is supported for only TASK contacts.
- Do not use both QueueId and UserId in the same call.
- The following flow types are supported: Inbound flow, Transfer to agent flow, and Transfer to queue flow.
- The TransferContact API can be called only on active contacts.
- A contact cannot be transferred more than 11 times.
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

TransferContactRequest()

Constructors
Constructor and Description
`TransferContactRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getClientToken()` A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`java.lang.String`	`getContactFlowId()` The identifier of the flow.
`java.lang.String`	`getContactId()` The identifier of the contact in this instance of Amazon Connect.
`java.lang.String`	`getInstanceId()` The identifier of the Amazon Connect instance.
`java.lang.String`	`getQueueId()` The identifier for the queue.
`java.lang.String`	`getUserId()` The identifier for the user.
`int`	`hashCode()`
`void`	`setClientToken(java.lang.String clientToken)` A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`void`	`setContactFlowId(java.lang.String contactFlowId)` The identifier of the flow.
`void`	`setContactId(java.lang.String contactId)` The identifier of the contact in this instance of Amazon Connect.
`void`	`setInstanceId(java.lang.String instanceId)` The identifier of the Amazon Connect instance.
`void`	`setQueueId(java.lang.String queueId)` The identifier for the queue.
`void`	`setUserId(java.lang.String userId)` The identifier for the user.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`TransferContactRequest`	`withClientToken(java.lang.String clientToken)` A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`TransferContactRequest`	`withContactFlowId(java.lang.String contactFlowId)` The identifier of the flow.
`TransferContactRequest`	`withContactId(java.lang.String contactId)` The identifier of the contact in this instance of Amazon Connect.
`TransferContactRequest`	`withInstanceId(java.lang.String instanceId)` The identifier of the Amazon Connect instance.
`TransferContactRequest`	`withQueueId(java.lang.String queueId)` The identifier for the queue.
`TransferContactRequest`	`withUserId(java.lang.String userId)` The identifier for the user.

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
  - TransferContactRequest
```
public TransferContactRequest()
```
- 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 TransferContactRequest 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.
  - getContactId
```
public java.lang.String getContactId()
```
    The identifier of the contact in this instance of Amazon Connect.
    
    Constraints:
    Length: 1 - 256
    
    Returns:
    
    The identifier of the contact in this instance of Amazon Connect.
  - setContactId
```
public void setContactId(java.lang.String contactId)
```
    The identifier of the contact in this instance of Amazon Connect.
    
    Constraints:
    Length: 1 - 256
    
    Parameters:
    
    contactId -
    The identifier of the contact in this instance of Amazon Connect.
  - withContactId
```
public TransferContactRequest withContactId(java.lang.String contactId)
```
    The identifier of the contact in this instance of Amazon Connect.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 256
    
    Parameters:
    
    contactId -
    The identifier of the contact in this instance of Amazon Connect.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getQueueId
```
public java.lang.String getQueueId()
```
    The identifier for the queue.
    
    Returns:
    
    The identifier for the queue.
  - setQueueId
```
public void setQueueId(java.lang.String queueId)
```
    The identifier for the queue.
    
    Parameters:
    
    queueId -
    The identifier for the queue.
  - withQueueId
```
public TransferContactRequest withQueueId(java.lang.String queueId)
```
    The identifier for the queue.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    queueId -
    The identifier for the queue.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getUserId
```
public java.lang.String getUserId()
```
    The identifier for the user. This can be the ID or the ARN of the user.
    
    Constraints:
    Length: 1 - 256
    
    Returns:
    
    The identifier for the user. This can be the ID or the ARN of the user.
  - setUserId
```
public void setUserId(java.lang.String userId)
```
    The identifier for the user. This can be the ID or the ARN of the user.
    
    Constraints:
    Length: 1 - 256
    
    Parameters:
    
    userId -
    The identifier for the user. This can be the ID or the ARN of the user.
  - withUserId
```
public TransferContactRequest withUserId(java.lang.String userId)
```
    The identifier for the user. This can be the ID or the ARN of the user.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 256
    
    Parameters:
    
    userId -
    The identifier for the user. This can be the ID or the ARN of the user.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getContactFlowId
```
public java.lang.String getContactFlowId()
```
    The identifier of the flow.
    
    Constraints:
    Length: - 500
    
    Returns:
    
    The identifier of the flow.
  - setContactFlowId
```
public void setContactFlowId(java.lang.String contactFlowId)
```
    The identifier of the flow.
    
    Constraints:
    Length: - 500
    
    Parameters:
    
    contactFlowId -
    The identifier of the flow.
  - withContactFlowId
```
public TransferContactRequest withContactFlowId(java.lang.String contactFlowId)
```
    The identifier of the flow.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: - 500
    
    Parameters:
    
    contactFlowId -
    The identifier of the flow.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getClientToken
```
public java.lang.String getClientToken()
```
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
    
    Constraints:
    Length: - 500
    
    Returns:
    
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
  - setClientToken
```
public void setClientToken(java.lang.String clientToken)
```
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
    
    Constraints:
    Length: - 500
    
    Parameters:
    
    clientToken -
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
  - withClientToken
```
public TransferContactRequest withClientToken(java.lang.String clientToken)
```
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: - 500
    
    Parameters:
    
    clientToken -
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
    
    Returns:
    
    A reference to this updated 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 TransferContactRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

TransferContactRequest

Method Detail

getInstanceId

setInstanceId

withInstanceId

getContactId

setContactId

withContactId

getQueueId

setQueueId

withQueueId

getUserId

setUserId

withUserId

getContactFlowId

setContactFlowId

withContactFlowId

getClientToken

setClientToken

withClientToken

toString

hashCode

equals