com.amazonaws.services.connect.model

Class StartTaskContactRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.connect.model.StartTaskContactRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class StartTaskContactRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Initiates a contact flow to start a new task.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StartTaskContactRequest()

Method Summary

Modifier and Type	Method and Description
StartTaskContactRequest	addAttributesEntry(java.lang.String key, java.lang.String value) A custom key-value pair using an attribute map.
StartTaskContactRequest	addReferencesEntry(java.lang.String key, Reference value) A formatted URL that is shown to an agent in the Contact Control Panel (CCP).
StartTaskContactRequest	clearAttributesEntries() Removes all the entries added into Attributes.
StartTaskContactRequest	clearReferencesEntries() Removes all the entries added into References.
boolean	equals(java.lang.Object obj)
java.util.Map<java.lang.String,java.lang.String>	getAttributes() A custom key-value pair using an attribute map.
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 contact flow for initiating the tasks.
java.lang.String	getDescription() A description of the task that is shown to an agent in the Contact Control Panel (CCP).
java.lang.String	getInstanceId() The identifier of the Amazon Connect instance.
java.lang.String	getName() The name of a task that is shown to an agent in the Contact Control Panel (CCP).
java.lang.String	getPreviousContactId() The identifier of the previous chat, voice, or task contact.
java.util.Map<java.lang.String,Reference>	getReferences() A formatted URL that is shown to an agent in the Contact Control Panel (CCP).
int	hashCode()
void	setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes) A custom key-value pair using an attribute map.
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 contact flow for initiating the tasks.
void	setDescription(java.lang.String description) A description of the task that is shown to an agent in the Contact Control Panel (CCP).
void	setInstanceId(java.lang.String instanceId) The identifier of the Amazon Connect instance.
void	setName(java.lang.String name) The name of a task that is shown to an agent in the Contact Control Panel (CCP).
void	setPreviousContactId(java.lang.String previousContactId) The identifier of the previous chat, voice, or task contact.
void	setReferences(java.util.Map<java.lang.String,Reference> references) A formatted URL that is shown to an agent in the Contact Control Panel (CCP).
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
StartTaskContactRequest	withAttributes(java.util.Map<java.lang.String,java.lang.String> attributes) A custom key-value pair using an attribute map.
StartTaskContactRequest	withClientToken(java.lang.String clientToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
StartTaskContactRequest	withContactFlowId(java.lang.String contactFlowId) The identifier of the contact flow for initiating the tasks.
StartTaskContactRequest	withDescription(java.lang.String description) A description of the task that is shown to an agent in the Contact Control Panel (CCP).
StartTaskContactRequest	withInstanceId(java.lang.String instanceId) The identifier of the Amazon Connect instance.
StartTaskContactRequest	withName(java.lang.String name) The name of a task that is shown to an agent in the Contact Control Panel (CCP).
StartTaskContactRequest	withPreviousContactId(java.lang.String previousContactId) The identifier of the previous chat, voice, or task contact.
StartTaskContactRequest	withReferences(java.util.Map<java.lang.String,Reference> references) A formatted URL that is shown to an agent in the Contact Control Panel (CCP).

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StartTaskContactRequest

public StartTaskContactRequest()

Method Detail

getInstanceId

public java.lang.String getInstanceId()

The identifier of the Amazon Connect instance.

Constraints:
Length: 1 - 100

Returns:

The identifier of the Amazon Connect instance.

setInstanceId

public void setInstanceId(java.lang.String instanceId)

The identifier of the Amazon Connect instance.

Constraints:
Length: 1 - 100

Parameters:

instanceId -

The identifier of the Amazon Connect instance.

withInstanceId

public StartTaskContactRequest withInstanceId(java.lang.String instanceId)

The identifier of the Amazon Connect 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.

Returns:

A reference to this updated object so that method calls can be chained together.

getPreviousContactId

public java.lang.String getPreviousContactId()

The identifier of the previous chat, voice, or task contact.

Constraints:
Length: 1 - 256

Returns:

The identifier of the previous chat, voice, or task contact.

setPreviousContactId

public void setPreviousContactId(java.lang.String previousContactId)

The identifier of the previous chat, voice, or task contact.

Constraints:
Length: 1 - 256

Parameters:

previousContactId -

The identifier of the previous chat, voice, or task contact.

withPreviousContactId

public StartTaskContactRequest withPreviousContactId(java.lang.String previousContactId)

The identifier of the previous chat, voice, or task contact.

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

Constraints:
Length: 1 - 256

Parameters:

previousContactId -

The identifier of the previous chat, voice, or task contact.

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 contact flow for initiating the tasks. 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

Constraints:
Length: - 500

Returns:

The identifier of the contact flow for initiating the tasks. 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

setContactFlowId

public void setContactFlowId(java.lang.String contactFlowId)

The identifier of the contact flow for initiating the tasks. 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

Constraints:
Length: - 500

Parameters:

contactFlowId -

The identifier of the contact flow for initiating the tasks. 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 StartTaskContactRequest withContactFlowId(java.lang.String contactFlowId)

The identifier of the contact flow for initiating the tasks. 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 a reference to this object so that method calls can be chained together.

Constraints:
Length: - 500

Parameters:

contactFlowId -

The identifier of the contact flow for initiating the tasks. 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:

A reference to this updated object so that method calls can be chained together.

getAttributes

public java.util.Map<java.lang.String,java.lang.String> getAttributes()

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and 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, and 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(java.util.Map<java.lang.String,java.lang.String> attributes)

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and 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, and 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 StartTaskContactRequest withAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and 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 reference to this object so that method calls can be chained together.

Parameters:

attributes -

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and 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 reference to this updated object so that method calls can be chained together.

addAttributesEntry

public StartTaskContactRequest addAttributesEntry(java.lang.String key,
                                                  java.lang.String value)

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and 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.

The method adds a new key-value pair into Attributes parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into Attributes.

value - The corresponding value of the entry to be added into Attributes.

Returns:

A reference to this updated object so that method calls can be chained together.

clearAttributesEntries

public StartTaskContactRequest clearAttributesEntries()

Removes all the entries added into Attributes.

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

getName

public java.lang.String getName()

The name of a task that is shown to an agent in the Contact Control Panel (CCP).

Constraints:
Length: 0 - 512

Returns:

The name of a task that is shown to an agent in the Contact Control Panel (CCP).

setName

public void setName(java.lang.String name)

The name of a task that is shown to an agent in the Contact Control Panel (CCP).

Constraints:
Length: 0 - 512

Parameters:

name -

The name of a task that is shown to an agent in the Contact Control Panel (CCP).

withName

public StartTaskContactRequest withName(java.lang.String name)

The name of a task that is shown to an agent in the Contact Control Panel (CCP).

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

Constraints:
Length: 0 - 512

Parameters:

name -

The name of a task that is shown to an agent in the Contact Control Panel (CCP).

Returns:

A reference to this updated object so that method calls can be chained together.

getReferences

public java.util.Map<java.lang.String,Reference> getReferences()

A formatted URL that is shown to an agent in the Contact Control Panel (CCP).

Returns:

A formatted URL that is shown to an agent in the Contact Control Panel (CCP).

setReferences

public void setReferences(java.util.Map<java.lang.String,Reference> references)

A formatted URL that is shown to an agent in the Contact Control Panel (CCP).

Parameters:

references -

A formatted URL that is shown to an agent in the Contact Control Panel (CCP).

withReferences

public StartTaskContactRequest withReferences(java.util.Map<java.lang.String,Reference> references)

A formatted URL that is shown to an agent in the Contact Control Panel (CCP).

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

Parameters:

references -

A formatted URL that is shown to an agent in the Contact Control Panel (CCP).

Returns:

A reference to this updated object so that method calls can be chained together.

addReferencesEntry

public StartTaskContactRequest addReferencesEntry(java.lang.String key,
                                                  Reference value)

A formatted URL that is shown to an agent in the Contact Control Panel (CCP).

The method adds a new key-value pair into References parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into References.

value - The corresponding value of the entry to be added into References.

Returns:

A reference to this updated object so that method calls can be chained together.

clearReferencesEntries

public StartTaskContactRequest clearReferencesEntries()

Removes all the entries added into References.

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

getDescription

public java.lang.String getDescription()

A description of the task that is shown to an agent in the Contact Control Panel (CCP).

Constraints:
Length: 0 - 4096

Returns:

A description of the task that is shown to an agent in the Contact Control Panel (CCP).

setDescription

public void setDescription(java.lang.String description)

A description of the task that is shown to an agent in the Contact Control Panel (CCP).

Constraints:
Length: 0 - 4096

Parameters:

description -

A description of the task that is shown to an agent in the Contact Control Panel (CCP).

withDescription

public StartTaskContactRequest withDescription(java.lang.String description)

A description of the task that is shown to an agent in the Contact Control Panel (CCP).

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

Constraints:
Length: 0 - 4096

Parameters:

description -

A description of the task that is shown to an agent in the Contact Control Panel (CCP).

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.

Constraints:
Length: - 500

Returns:

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

setClientToken

public void setClientToken(java.lang.String clientToken)

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

Constraints:
Length: - 500

Parameters:

clientToken -

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

withClientToken

public StartTaskContactRequest withClientToken(java.lang.String clientToken)

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

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.

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