com.amazonaws.services.connect.model

Class StartTaskContactRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.connect.model.StartTaskContactRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StartTaskContactRequest
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
StartTaskContactRequest()

Method Summary

Modifier and Type	Method and Description
StartTaskContactRequest	addAttributesEntry(String key, String value) Add a single Attributes entry
StartTaskContactRequest	addReferencesEntry(String key, Reference value) Add a single References entry
StartTaskContactRequest	clearAttributesEntries() Removes all the entries added into Attributes.
StartTaskContactRequest	clearReferencesEntries() Removes all the entries added into References.
StartTaskContactRequest	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.
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 tasks.
String	getDescription() A description of the task that is shown to an agent in the Contact Control Panel (CCP).
String	getInstanceId() The identifier of the Amazon Connect instance.
String	getName() The name of a task that is shown to an agent in the Contact Control Panel (CCP).
String	getPreviousContactId() The identifier of the previous chat, voice, or task contact.
String	getQuickConnectId() The identifier for the quick connect.
Map<String,Reference>	getReferences() A formatted URL that is shown to an agent in the Contact Control Panel (CCP).
Date	getScheduledTime() The timestamp, in Unix Epoch seconds format, at which to start running the inbound contact flow.
String	getTaskTemplateId() A unique identifier for the task template.
int	hashCode()
void	setAttributes(Map<String,String> attributes) A custom key-value pair using an attribute map.
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 tasks.
void	setDescription(String description) A description of the task that is shown to an agent in the Contact Control Panel (CCP).
void	setInstanceId(String instanceId) The identifier of the Amazon Connect instance.
void	setName(String name) The name of a task that is shown to an agent in the Contact Control Panel (CCP).
void	setPreviousContactId(String previousContactId) The identifier of the previous chat, voice, or task contact.
void	setQuickConnectId(String quickConnectId) The identifier for the quick connect.
void	setReferences(Map<String,Reference> references) A formatted URL that is shown to an agent in the Contact Control Panel (CCP).
void	setScheduledTime(Date scheduledTime) The timestamp, in Unix Epoch seconds format, at which to start running the inbound contact flow.
void	setTaskTemplateId(String taskTemplateId) A unique identifier for the task template.
String	toString() Returns a string representation of this object.
StartTaskContactRequest	withAttributes(Map<String,String> attributes) A custom key-value pair using an attribute map.
StartTaskContactRequest	withClientToken(String clientToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
StartTaskContactRequest	withContactFlowId(String contactFlowId) The identifier of the contact flow for initiating the tasks.
StartTaskContactRequest	withDescription(String description) A description of the task that is shown to an agent in the Contact Control Panel (CCP).
StartTaskContactRequest	withInstanceId(String instanceId) The identifier of the Amazon Connect instance.
StartTaskContactRequest	withName(String name) The name of a task that is shown to an agent in the Contact Control Panel (CCP).
StartTaskContactRequest	withPreviousContactId(String previousContactId) The identifier of the previous chat, voice, or task contact.
StartTaskContactRequest	withQuickConnectId(String quickConnectId) The identifier for the quick connect.
StartTaskContactRequest	withReferences(Map<String,Reference> references) A formatted URL that is shown to an agent in the Contact Control Panel (CCP).
StartTaskContactRequest	withScheduledTime(Date scheduledTime) The timestamp, in Unix Epoch seconds format, at which to start running the inbound contact flow.
StartTaskContactRequest	withTaskTemplateId(String taskTemplateId) A unique identifier for the task template.

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

StartTaskContactRequest

public StartTaskContactRequest()

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

setPreviousContactId

public void setPreviousContactId(String previousContactId)

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

Parameters:

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

getPreviousContactId

public String getPreviousContactId()

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

Returns:

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

withPreviousContactId

public StartTaskContactRequest withPreviousContactId(String previousContactId)

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

Parameters:

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

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

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

getContactFlowId

public 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

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

withContactFlowId

public StartTaskContactRequest withContactFlowId(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

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:

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, 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(Map<String,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(Map<String,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.

Returns:

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

addAttributesEntry

public StartTaskContactRequest addAttributesEntry(String key,
                                                  String value)

Add a single Attributes entry

See Also:

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

clearAttributesEntries

public StartTaskContactRequest clearAttributesEntries()

Removes all the entries added into Attributes.

Returns:

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

setName

public void setName(String name)

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

Parameters:

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

getName

public String getName()

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

Returns:

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

withName

public StartTaskContactRequest withName(String name)

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

Parameters:

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

Returns:

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

getReferences

public Map<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(Map<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(Map<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).

Returns:

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

addReferencesEntry

public StartTaskContactRequest addReferencesEntry(String key,
                                                  Reference value)

Add a single References entry

See Also:

withReferences(java.util.Map<java.lang.String, com.amazonaws.services.connect.model.Reference>)

clearReferencesEntries

public StartTaskContactRequest clearReferencesEntries()

Removes all the entries added into References.

Returns:

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

setDescription

public void setDescription(String description)

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

Parameters:

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

getDescription

public String getDescription()

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

Returns:

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

withDescription

public StartTaskContactRequest withDescription(String description)

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

Parameters:

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

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

setScheduledTime

public void setScheduledTime(Date scheduledTime)

The timestamp, in Unix Epoch seconds format, at which to start running the inbound contact flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.

Parameters:

scheduledTime - The timestamp, in Unix Epoch seconds format, at which to start running the inbound contact flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.

getScheduledTime

public Date getScheduledTime()

The timestamp, in Unix Epoch seconds format, at which to start running the inbound contact flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.

Returns:

The timestamp, in Unix Epoch seconds format, at which to start running the inbound contact flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.

withScheduledTime

public StartTaskContactRequest withScheduledTime(Date scheduledTime)

The timestamp, in Unix Epoch seconds format, at which to start running the inbound contact flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.

Parameters:

scheduledTime - The timestamp, in Unix Epoch seconds format, at which to start running the inbound contact flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.

Returns:

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

setTaskTemplateId

public void setTaskTemplateId(String taskTemplateId)

A unique identifier for the task template.

Parameters:

taskTemplateId - A unique identifier for the task template.

getTaskTemplateId

public String getTaskTemplateId()

A unique identifier for the task template.

Returns:

A unique identifier for the task template.

withTaskTemplateId

public StartTaskContactRequest withTaskTemplateId(String taskTemplateId)

A unique identifier for the task template.

Parameters:

taskTemplateId - A unique identifier for the task template.

Returns:

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

setQuickConnectId

public void setQuickConnectId(String quickConnectId)

The identifier for the quick connect.

Parameters:

quickConnectId - The identifier for the quick connect.

getQuickConnectId

public String getQuickConnectId()

The identifier for the quick connect.

Returns:

The identifier for the quick connect.

withQuickConnectId

public StartTaskContactRequest withQuickConnectId(String quickConnectId)

The identifier for the quick connect.

Parameters:

quickConnectId - The identifier for the quick connect.

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 StartTaskContactRequest 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()