com.amazonaws.services.connect.model

Class CreateParticipantRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.connect.model.CreateParticipantRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class CreateParticipantRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable

Adds a new participant into an on-going chat contact. For more information, see Customize chat flow experiences by integrating custom participants.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreateParticipantRequest()

Method Summary

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	getContactId() The identifier of the contact in this instance of Amazon Connect.
java.lang.String	getInstanceId() The identifier of the Amazon Connect instance.
ParticipantDetailsToAdd	getParticipantDetails() Information identifying the participant.
int	hashCode()
void	setClientToken(java.lang.String clientToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
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	setParticipantDetails(ParticipantDetailsToAdd participantDetails) Information identifying the participant.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateParticipantRequest	withClientToken(java.lang.String clientToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
CreateParticipantRequest	withContactId(java.lang.String contactId) The identifier of the contact in this instance of Amazon Connect.
CreateParticipantRequest	withInstanceId(java.lang.String instanceId) The identifier of the Amazon Connect instance.
CreateParticipantRequest	withParticipantDetails(ParticipantDetailsToAdd participantDetails) Information identifying the participant.

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

CreateParticipantRequest

public CreateParticipantRequest()

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 CreateParticipantRequest 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. Only contacts in the CHAT channel are supported.

Constraints:
Length: 1 - 256

Returns:

The identifier of the contact in this instance of Amazon Connect. Only contacts in the CHAT channel are supported.

setContactId

public void setContactId(java.lang.String contactId)

The identifier of the contact in this instance of Amazon Connect. Only contacts in the CHAT channel are supported.

Constraints:
Length: 1 - 256

Parameters:

contactId -

The identifier of the contact in this instance of Amazon Connect. Only contacts in the CHAT channel are supported.

withContactId

public CreateParticipantRequest withContactId(java.lang.String 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

Parameters:

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 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 CreateParticipantRequest 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.

getParticipantDetails

public ParticipantDetailsToAdd getParticipantDetails()

Information identifying the participant.

The only Valid value for ParticipantRole is CUSTOM_BOT.

DisplayName is Required.

Returns:

Information identifying the participant.

The only Valid value for ParticipantRole is CUSTOM_BOT.

DisplayName is Required.

setParticipantDetails

public void setParticipantDetails(ParticipantDetailsToAdd participantDetails)

Information identifying the participant.

The only Valid value for ParticipantRole is CUSTOM_BOT.

DisplayName is Required.

Parameters:

participantDetails -

Information identifying the participant.

The only Valid value for ParticipantRole is CUSTOM_BOT.

DisplayName is Required.

withParticipantDetails

public CreateParticipantRequest withParticipantDetails(ParticipantDetailsToAdd participantDetails)

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.

Parameters:

participantDetails -

Information identifying the participant.

The only Valid value for ParticipantRole is CUSTOM_BOT.

DisplayName is Required.

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