public class StartTaskContactRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable
Initiates a flow to start a new task.
| Constructor and Description |
|---|
StartTaskContactRequest() |
| 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 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.lang.String |
getQuickConnectId()
The identifier for the quick connect.
|
java.util.Map<java.lang.String,Reference> |
getReferences()
A formatted URL that is shown to an agent in the Contact Control Panel
(CCP).
|
java.lang.String |
getRelatedContactId()
The contactId that is related to this contact.
|
java.util.Date |
getScheduledTime()
The timestamp, in Unix Epoch seconds format, at which to start running
the inbound flow.
|
java.lang.String |
getTaskTemplateId()
A unique identifier for the task template.
|
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 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 |
setQuickConnectId(java.lang.String quickConnectId)
The identifier for the quick connect.
|
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).
|
void |
setRelatedContactId(java.lang.String relatedContactId)
The contactId that is related to this contact.
|
void |
setScheduledTime(java.util.Date scheduledTime)
The timestamp, in Unix Epoch seconds format, at which to start running
the inbound flow.
|
void |
setTaskTemplateId(java.lang.String taskTemplateId)
A unique identifier for the task template.
|
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 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 |
withQuickConnectId(java.lang.String quickConnectId)
The identifier for the quick connect.
|
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).
|
StartTaskContactRequest |
withRelatedContactId(java.lang.String relatedContactId)
The contactId that is related to this contact.
|
StartTaskContactRequest |
withScheduledTime(java.util.Date scheduledTime)
The timestamp, in Unix Epoch seconds format, at which to start running
the inbound flow.
|
StartTaskContactRequest |
withTaskTemplateId(java.lang.String taskTemplateId)
A unique identifier for the task template.
|
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollectorpublic 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
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(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
instanceId - The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
public StartTaskContactRequest 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
instanceId - The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
public java.lang.String getPreviousContactId()
The identifier of the previous chat, voice, or task contact.
Constraints:
Length: 1 - 256
The identifier of the previous chat, voice, or task contact.
public void setPreviousContactId(java.lang.String previousContactId)
The identifier of the previous chat, voice, or task contact.
Constraints:
Length: 1 - 256
previousContactId - The identifier of the previous chat, voice, or task contact.
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
previousContactId - The identifier of the previous chat, voice, or task contact.
public java.lang.String getContactFlowId()
The identifier of the 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 flow. On the flow page, under the name of the 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
The identifier of the 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 flow. On the flow page, under the name of the 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
public void setContactFlowId(java.lang.String contactFlowId)
The identifier of the 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 flow. On the flow page, under the name of the 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
contactFlowId - The identifier of the 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 flow. On the flow page, under the name of the 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
public StartTaskContactRequest withContactFlowId(java.lang.String contactFlowId)
The identifier of the 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 flow. On the flow page, under the name of the 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
contactFlowId - The identifier of the 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 flow. On the flow page, under the name of the 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
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 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.
A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in 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.
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 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.
attributes - A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in 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.
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 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.
attributes - A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in 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.
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 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.
key - The key of the entry to be added into Attributes.value - The corresponding value of the entry to be added into
Attributes.public StartTaskContactRequest clearAttributesEntries()
Returns a reference to this object so that method calls can be chained together.
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
The name of a task that is shown to an agent in the Contact Control Panel (CCP).
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
name - The name of a task that is shown to an agent in the Contact Control Panel (CCP).
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
name - The name of a task that is shown to an agent in the Contact Control Panel (CCP).
public java.util.Map<java.lang.String,Reference> getReferences()
A formatted URL that is shown to an agent in the Contact Control Panel (CCP).
A formatted URL that is shown to an agent in the Contact Control Panel (CCP).
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).
references - A formatted URL that is shown to an agent in the Contact Control Panel (CCP).
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.
references - A formatted URL that is shown to an agent in the Contact Control Panel (CCP).
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.
key - The key of the entry to be added into References.value - The corresponding value of the entry to be added into
References.public StartTaskContactRequest clearReferencesEntries()
Returns a reference to this object so that method calls can be chained together.
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
A description of the task that is shown to an agent in the Contact Control Panel (CCP).
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
description - A description of the task that is shown to an agent in the Contact Control Panel (CCP).
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
description - A description of the task that is shown to an agent in the Contact Control Panel (CCP).
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
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(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
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 StartTaskContactRequest 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
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 java.util.Date getScheduledTime()
The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.
The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.
public void setScheduledTime(java.util.Date scheduledTime)
The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.
scheduledTime - The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.
public StartTaskContactRequest withScheduledTime(java.util.Date scheduledTime)
The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.
Returns a reference to this object so that method calls can be chained together.
scheduledTime - The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.
public java.lang.String getTaskTemplateId()
A unique identifier for the task template.
Constraints:
Length: 1 - 500
A unique identifier for the task template.
public void setTaskTemplateId(java.lang.String taskTemplateId)
A unique identifier for the task template.
Constraints:
Length: 1 - 500
taskTemplateId - A unique identifier for the task template.
public StartTaskContactRequest withTaskTemplateId(java.lang.String taskTemplateId)
A unique identifier for the task template.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 500
taskTemplateId - A unique identifier for the task template.
public java.lang.String getQuickConnectId()
The identifier for the quick connect.
The identifier for the quick connect.
public void setQuickConnectId(java.lang.String quickConnectId)
The identifier for the quick connect.
quickConnectId - The identifier for the quick connect.
public StartTaskContactRequest withQuickConnectId(java.lang.String quickConnectId)
The identifier for the quick connect.
Returns a reference to this object so that method calls can be chained together.
quickConnectId - The identifier for the quick connect.
public java.lang.String getRelatedContactId()
The contactId that is related to this contact.
Constraints:
Length: 1 - 256
The contactId that is related to this contact.
public void setRelatedContactId(java.lang.String relatedContactId)
The contactId that is related to this contact.
Constraints:
Length: 1 - 256
relatedContactId - The contactId that is related to this contact.
public StartTaskContactRequest withRelatedContactId(java.lang.String relatedContactId)
The contactId that is related to this contact.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 256
relatedContactId - The contactId that is related to this contact.
public java.lang.String toString()
toString in class java.lang.ObjectObject.toString()public int hashCode()
hashCode in class java.lang.Objectpublic boolean equals(java.lang.Object obj)
equals in class java.lang.Object