/* * Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.connect.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; /** *
* 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. *
** 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
*/
private String instanceId;
/**
*
* The identifier of the contact in this instance of Amazon Connect. *
*
* Constraints:
* Length: 1 - 256
*/
private String contactId;
/**
*
* The identifier for the queue. *
*/ private String queueId; /** ** The identifier for the user. *
*
* Constraints:
* Length: 1 - 256
*/
private String userId;
/**
*
* The identifier of the flow. *
*
* Constraints:
* Length: - 500
*/
private String contactFlowId;
/**
*
* 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
*/
private String clientToken;
/**
*
* 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
*
* @return
* The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of * the instance. *
*/ public String getInstanceId() { return 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
*
* @param instanceId
* The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of * the instance. *
*/ public void setInstanceId(String instanceId) { this.instanceId = 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
*
* @param instanceId
* The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of * the instance. *
* @return A reference to this updated object so that method calls can be * chained together. */ public TransferContactRequest withInstanceId(String instanceId) { this.instanceId = instanceId; return this; } /** ** The identifier of the contact in this instance of Amazon Connect. *
*
* Constraints:
* Length: 1 - 256
*
* @return
* The identifier of the contact in this instance of Amazon Connect. *
*/ public String getContactId() { return contactId; } /** ** The identifier of the contact in this instance of Amazon Connect. *
*
* Constraints:
* Length: 1 - 256
*
* @param contactId
* The identifier of the contact in this instance of Amazon * Connect. *
*/ public void setContactId(String contactId) { this.contactId = 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
*
* @param contactId
* The identifier of the contact in this instance of Amazon * Connect. *
* @return A reference to this updated object so that method calls can be * chained together. */ public TransferContactRequest withContactId(String contactId) { this.contactId = contactId; return this; } /** ** The identifier for the queue. *
* * @return* The identifier for the queue. *
*/ public String getQueueId() { return queueId; } /** ** The identifier for the queue. *
* * @param queueId* The identifier for the queue. *
*/ public void setQueueId(String queueId) { this.queueId = queueId; } /** ** The identifier for the queue. *
** Returns a reference to this object so that method calls can be chained * together. * * @param queueId
* The identifier for the queue. *
* @return A reference to this updated object so that method calls can be * chained together. */ public TransferContactRequest withQueueId(String queueId) { this.queueId = queueId; return this; } /** ** The identifier for the user. *
*
* Constraints:
* Length: 1 - 256
*
* @return
* The identifier for the user. *
*/ public String getUserId() { return userId; } /** ** The identifier for the user. *
*
* Constraints:
* Length: 1 - 256
*
* @param userId
* The identifier for the user. *
*/ public void setUserId(String userId) { this.userId = userId; } /** ** The identifier for the user. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: 1 - 256
*
* @param userId
* The identifier for the user. *
* @return A reference to this updated object so that method calls can be * chained together. */ public TransferContactRequest withUserId(String userId) { this.userId = userId; return this; } /** ** The identifier of the flow. *
*
* Constraints:
* Length: - 500
*
* @return
* The identifier of the flow. *
*/ public String getContactFlowId() { return contactFlowId; } /** ** The identifier of the flow. *
*
* Constraints:
* Length: - 500
*
* @param contactFlowId
* The identifier of the flow. *
*/ public void setContactFlowId(String contactFlowId) { this.contactFlowId = contactFlowId; } /** ** The identifier of the flow. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: - 500
*
* @param contactFlowId
* The identifier of the flow. *
* @return A reference to this updated object so that method calls can be * chained together. */ public TransferContactRequest withContactFlowId(String contactFlowId) { this.contactFlowId = contactFlowId; return this; } /** ** 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
*
* @return
* 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. *
*/ public String getClientToken() { return 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
*
* @param 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. *
*/ public void setClientToken(String clientToken) { this.clientToken = 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
*
* @param 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. *
* @return A reference to this updated object so that method calls can be * chained together. */ public TransferContactRequest withClientToken(String clientToken) { this.clientToken = clientToken; return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getInstanceId() != null) sb.append("InstanceId: " + getInstanceId() + ","); if (getContactId() != null) sb.append("ContactId: " + getContactId() + ","); if (getQueueId() != null) sb.append("QueueId: " + getQueueId() + ","); if (getUserId() != null) sb.append("UserId: " + getUserId() + ","); if (getContactFlowId() != null) sb.append("ContactFlowId: " + getContactFlowId() + ","); if (getClientToken() != null) sb.append("ClientToken: " + getClientToken()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getInstanceId() == null) ? 0 : getInstanceId().hashCode()); hashCode = prime * hashCode + ((getContactId() == null) ? 0 : getContactId().hashCode()); hashCode = prime * hashCode + ((getQueueId() == null) ? 0 : getQueueId().hashCode()); hashCode = prime * hashCode + ((getUserId() == null) ? 0 : getUserId().hashCode()); hashCode = prime * hashCode + ((getContactFlowId() == null) ? 0 : getContactFlowId().hashCode()); hashCode = prime * hashCode + ((getClientToken() == null) ? 0 : getClientToken().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof TransferContactRequest == false) return false; TransferContactRequest other = (TransferContactRequest) obj; if (other.getInstanceId() == null ^ this.getInstanceId() == null) return false; if (other.getInstanceId() != null && other.getInstanceId().equals(this.getInstanceId()) == false) return false; if (other.getContactId() == null ^ this.getContactId() == null) return false; if (other.getContactId() != null && other.getContactId().equals(this.getContactId()) == false) return false; if (other.getQueueId() == null ^ this.getQueueId() == null) return false; if (other.getQueueId() != null && other.getQueueId().equals(this.getQueueId()) == false) return false; if (other.getUserId() == null ^ this.getUserId() == null) return false; if (other.getUserId() != null && other.getUserId().equals(this.getUserId()) == false) return false; if (other.getContactFlowId() == null ^ this.getContactFlowId() == null) return false; if (other.getContactFlowId() != null && other.getContactFlowId().equals(this.getContactFlowId()) == false) return false; if (other.getClientToken() == null ^ this.getClientToken() == null) return false; if (other.getClientToken() != null && other.getClientToken().equals(this.getClientToken()) == false) return false; return true; } }