/* * 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; /** *
* Adds a new participant into an on-going chat contact. For more information, * see Customize chat flow experiences by integrating custom participants. *
*/ public class CreateParticipantRequest extends AmazonWebServiceRequest implements Serializable { /** ** 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. Only * contacts in the CHAT channel are supported. *
*
* Constraints:
* Length: 1 - 256
*/
private String contactId;
/**
*
* 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;
/**
*
* Information identifying the participant. *
*
* The only Valid value for ParticipantRole
is
* CUSTOM_BOT
.
*
* DisplayName
is Required.
*
* 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 CreateParticipantRequest withInstanceId(String instanceId) { this.instanceId = instanceId; return this; } /** ** The identifier of the contact in this instance of Amazon Connect. Only * contacts in the CHAT channel are supported. *
*
* Constraints:
* Length: 1 - 256
*
* @return
* The identifier of the contact in this instance of Amazon Connect. * Only contacts in the CHAT channel are supported. *
*/ public String getContactId() { return contactId; } /** ** The identifier of the contact in this instance of Amazon Connect. Only * contacts in the CHAT channel are supported. *
*
* Constraints:
* Length: 1 - 256
*
* @param contactId
* The identifier of the contact in this instance of Amazon * Connect. Only contacts in the CHAT channel are supported. *
*/ public void setContactId(String contactId) { this.contactId = contactId; } /** ** The identifier of the contact in this instance of Amazon Connect. Only * contacts in the CHAT channel are supported. *
** 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. Only contacts in the CHAT channel are supported. *
* @return A reference to this updated object so that method calls can be * chained together. */ public CreateParticipantRequest withContactId(String contactId) { this.contactId = contactId; 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 CreateParticipantRequest withClientToken(String clientToken) { this.clientToken = clientToken; return this; } /** ** Information identifying the participant. *
*
* The only Valid value for ParticipantRole
is
* CUSTOM_BOT
.
*
* DisplayName
is Required.
*
* Information identifying the participant. *
*
* The only Valid value for ParticipantRole
is
* CUSTOM_BOT
.
*
* DisplayName
is Required.
*
* Information identifying the participant. *
*
* The only Valid value for ParticipantRole
is
* CUSTOM_BOT
.
*
* DisplayName
is Required.
*
* Information identifying the participant. *
*
* The only Valid value for ParticipantRole
is
* CUSTOM_BOT
.
*
* DisplayName
is Required.
*
* Information identifying the participant. *
*
* The only Valid value for ParticipantRole
is
* CUSTOM_BOT
.
*
* DisplayName
is Required.
*
* Returns a reference to this object so that method calls can be chained * together. * * @param participantDetails
* Information identifying the participant. *
*
* The only Valid value for ParticipantRole
is
* CUSTOM_BOT
.
*
* DisplayName
is Required.
*