com.amazonaws.services.connect.model

Class StartChatContactRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.connect.model.StartChatContactRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StartChatContactRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
StartChatContactRequest()

Method Summary

Modifier and Type	Method and Description
StartChatContactRequest	addAttributesEntry(String key, String value) Add a single Attributes entry
StartChatContactRequest	clearAttributesEntries() Removes all the entries added into Attributes.
StartChatContactRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Map<String,String>	getAttributes() A custom key-value pair using an attribute map.
Integer	getChatDurationInMinutes() The total duration of the newly started chat session.
String	getClientToken() A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String	getContactFlowId() The identifier of the contact flow for initiating the chat.
ChatMessage	getInitialMessage() The initial message to be sent to the newly created chat.
String	getInstanceId() The identifier of the Amazon Connect instance.
ParticipantDetails	getParticipantDetails() Information identifying the participant.
List<String>	getSupportedMessagingContentTypes() The supported chat message content types.
int	hashCode()
void	setAttributes(Map<String,String> attributes) A custom key-value pair using an attribute map.
void	setChatDurationInMinutes(Integer chatDurationInMinutes) The total duration of the newly started chat session.
void	setClientToken(String clientToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
void	setContactFlowId(String contactFlowId) The identifier of the contact flow for initiating the chat.
void	setInitialMessage(ChatMessage initialMessage) The initial message to be sent to the newly created chat.
void	setInstanceId(String instanceId) The identifier of the Amazon Connect instance.
void	setParticipantDetails(ParticipantDetails participantDetails) Information identifying the participant.
void	setSupportedMessagingContentTypes(Collection<String> supportedMessagingContentTypes) The supported chat message content types.
String	toString() Returns a string representation of this object.
StartChatContactRequest	withAttributes(Map<String,String> attributes) A custom key-value pair using an attribute map.
StartChatContactRequest	withChatDurationInMinutes(Integer chatDurationInMinutes) The total duration of the newly started chat session.
StartChatContactRequest	withClientToken(String clientToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
StartChatContactRequest	withContactFlowId(String contactFlowId) The identifier of the contact flow for initiating the chat.
StartChatContactRequest	withInitialMessage(ChatMessage initialMessage) The initial message to be sent to the newly created chat.
StartChatContactRequest	withInstanceId(String instanceId) The identifier of the Amazon Connect instance.
StartChatContactRequest	withParticipantDetails(ParticipantDetails participantDetails) Information identifying the participant.
StartChatContactRequest	withSupportedMessagingContentTypes(Collection<String> supportedMessagingContentTypes) The supported chat message content types.
StartChatContactRequest	withSupportedMessagingContentTypes(String... supportedMessagingContentTypes) The supported chat message content types.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StartChatContactRequest

public StartChatContactRequest()

Method Detail

setInstanceId

public void setInstanceId(String instanceId)

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Parameters:

instanceId - The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

getInstanceId

public String getInstanceId()

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Returns:

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

withInstanceId

public StartChatContactRequest withInstanceId(String instanceId)

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Parameters:

instanceId - The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

setContactFlowId

public void setContactFlowId(String contactFlowId)

The identifier of the contact flow for initiating the chat. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the contact flow. On the contact flow page, under the name of the contact flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/ 846ec553-a005-41c0-8341-xxxxxxxxxxxx

Parameters:

contactFlowId - The identifier of the contact flow for initiating the chat. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the contact flow. On the contact flow page, under the name of the contact flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/ 846ec553-a005-41c0-8341-xxxxxxxxxxxx

getContactFlowId

public String getContactFlowId()

The identifier of the contact flow for initiating the chat. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the contact flow. On the contact flow page, under the name of the contact flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/ 846ec553-a005-41c0-8341-xxxxxxxxxxxx

Returns:

The identifier of the contact flow for initiating the chat. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the contact flow. On the contact flow page, under the name of the contact flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/ 846ec553-a005-41c0-8341-xxxxxxxxxxxx

withContactFlowId

public StartChatContactRequest withContactFlowId(String contactFlowId)

The identifier of the contact flow for initiating the chat. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the contact flow. On the contact flow page, under the name of the contact flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/ 846ec553-a005-41c0-8341-xxxxxxxxxxxx

Parameters:

contactFlowId - The identifier of the contact flow for initiating the chat. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the contact flow. On the contact flow page, under the name of the contact flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/ 846ec553-a005-41c0-8341-xxxxxxxxxxxx

Returns:

Returns a reference to this object so that method calls can be chained together.

getAttributes

public Map<String,String> getAttributes()

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in contact flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

Returns:

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in contact flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

setAttributes

public void setAttributes(Map<String,String> attributes)

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in contact flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

Parameters:

attributes - A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in contact flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

withAttributes

public StartChatContactRequest withAttributes(Map<String,String> attributes)

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in contact flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

Parameters:

attributes - A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in contact flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

Returns:

Returns a reference to this object so that method calls can be chained together.

addAttributesEntry

public StartChatContactRequest addAttributesEntry(String key,
                                                  String value)

Add a single Attributes entry

See Also:

withAttributes(java.util.Map<java.lang.String, java.lang.String>)

clearAttributesEntries

public StartChatContactRequest clearAttributesEntries()

Removes all the entries added into Attributes.

Returns:

Returns a reference to this object so that method calls can be chained together.

setParticipantDetails

public void setParticipantDetails(ParticipantDetails participantDetails)

Information identifying the participant.

Parameters:

participantDetails - Information identifying the participant.

getParticipantDetails

public ParticipantDetails getParticipantDetails()

Information identifying the participant.

Returns:

Information identifying the participant.

withParticipantDetails

public StartChatContactRequest withParticipantDetails(ParticipantDetails participantDetails)

Information identifying the participant.

Parameters:

participantDetails - Information identifying the participant.

Returns:

Returns a reference to this object so that method calls can be chained together.

setInitialMessage

public void setInitialMessage(ChatMessage initialMessage)

The initial message to be sent to the newly created chat.

Parameters:

initialMessage - The initial message to be sent to the newly created chat.

getInitialMessage

public ChatMessage getInitialMessage()

The initial message to be sent to the newly created chat.

Returns:

The initial message to be sent to the newly created chat.

withInitialMessage

public StartChatContactRequest withInitialMessage(ChatMessage initialMessage)

The initial message to be sent to the newly created chat.

Parameters:

initialMessage - The initial message to be sent to the newly created chat.

Returns:

Returns a reference to this object so that method calls can be chained together.

setClientToken

public void setClientToken(String clientToken)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Parameters:

clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

getClientToken

public String getClientToken()

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Returns:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

withClientToken

public StartChatContactRequest withClientToken(String clientToken)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Parameters:

clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Returns:

Returns a reference to this object so that method calls can be chained together.

setChatDurationInMinutes

public void setChatDurationInMinutes(Integer chatDurationInMinutes)

The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minumum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).

Parameters:

chatDurationInMinutes - The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minumum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).

getChatDurationInMinutes

public Integer getChatDurationInMinutes()

The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minumum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).

Returns:

The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minumum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).

withChatDurationInMinutes

public StartChatContactRequest withChatDurationInMinutes(Integer chatDurationInMinutes)

The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minumum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).

Parameters:

chatDurationInMinutes - The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minumum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).

Returns:

Returns a reference to this object so that method calls can be chained together.

getSupportedMessagingContentTypes

public List<String> getSupportedMessagingContentTypes()

The supported chat message content types. Content types can be text/plain or both text/plain and text/markdown.

Returns:

The supported chat message content types. Content types can be text/plain or both text/plain and text/markdown.

setSupportedMessagingContentTypes

public void setSupportedMessagingContentTypes(Collection<String> supportedMessagingContentTypes)

The supported chat message content types. Content types can be text/plain or both text/plain and text/markdown.

Parameters:

supportedMessagingContentTypes - The supported chat message content types. Content types can be text/plain or both text/plain and text/markdown.

withSupportedMessagingContentTypes

public StartChatContactRequest withSupportedMessagingContentTypes(String... supportedMessagingContentTypes)

The supported chat message content types. Content types can be text/plain or both text/plain and text/markdown.

NOTE: This method appends the values to the existing list (if any). Use setSupportedMessagingContentTypes(java.util.Collection) or withSupportedMessagingContentTypes(java.util.Collection) if you want to override the existing values.

Parameters:

supportedMessagingContentTypes - The supported chat message content types. Content types can be text/plain or both text/plain and text/markdown.

Returns:

Returns a reference to this object so that method calls can be chained together.

withSupportedMessagingContentTypes

public StartChatContactRequest withSupportedMessagingContentTypes(Collection<String> supportedMessagingContentTypes)

The supported chat message content types. Content types can be text/plain or both text/plain and text/markdown.

Parameters:

supportedMessagingContentTypes - The supported chat message content types. Content types can be text/plain or both text/plain and text/markdown.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public StartChatContactRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()