@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class StartTaskContactRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
StartTaskContactRequest() |
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 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).
|
String |
getRelatedContactId()
The contactId that is related to this contact.
|
Date |
getScheduledTime()
The timestamp, in Unix Epoch seconds format, at which to start running the inbound 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 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 |
setRelatedContactId(String relatedContactId)
The contactId that is related to this contact.
|
void |
setScheduledTime(Date scheduledTime)
The timestamp, in Unix Epoch seconds format, at which to start running the inbound 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 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 |
withRelatedContactId(String relatedContactId)
The contactId that is related to this contact.
|
StartTaskContactRequest |
withScheduledTime(Date scheduledTime)
The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow.
|
StartTaskContactRequest |
withTaskTemplateId(String taskTemplateId)
A unique identifier for the task template.
|
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
public void setInstanceId(String instanceId)
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
instanceId
- The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.public String getInstanceId()
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(String instanceId)
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
instanceId
- The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.public void setPreviousContactId(String previousContactId)
The identifier of the previous chat, voice, or task contact. Any updates to user-defined attributes to task
contacts linked using the same PreviousContactID
will affect every contact in the chain. There can
be a maximum of 12 linked task contacts in a chain.
previousContactId
- The identifier of the previous chat, voice, or task contact. Any updates to user-defined attributes to
task contacts linked using the same PreviousContactID
will affect every contact in the chain.
There can be a maximum of 12 linked task contacts in a chain.public String getPreviousContactId()
The identifier of the previous chat, voice, or task contact. Any updates to user-defined attributes to task
contacts linked using the same PreviousContactID
will affect every contact in the chain. There can
be a maximum of 12 linked task contacts in a chain.
PreviousContactID
will affect every contact in the
chain. There can be a maximum of 12 linked task contacts in a chain.public StartTaskContactRequest withPreviousContactId(String previousContactId)
The identifier of the previous chat, voice, or task contact. Any updates to user-defined attributes to task
contacts linked using the same PreviousContactID
will affect every contact in the chain. There can
be a maximum of 12 linked task contacts in a chain.
previousContactId
- The identifier of the previous chat, voice, or task contact. Any updates to user-defined attributes to
task contacts linked using the same PreviousContactID
will affect every contact in the chain.
There can be a maximum of 12 linked task contacts in a chain.public void setContactFlowId(String contactFlowId)
The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect admin website, 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
contactFlowId
- The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect admin
website, 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 String getContactFlowId()
The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect admin website, 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
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/ 846ec553-a005-41c0-8341-xxxxxxxxxxxx
public StartTaskContactRequest withContactFlowId(String contactFlowId)
The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect admin website, 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
contactFlowId
- The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect admin
website, 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 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 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.
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(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 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(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 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 addAttributesEntry(String key, String value)
public StartTaskContactRequest clearAttributesEntries()
public void setName(String name)
The name of a task that is shown to an agent in the Contact Control Panel (CCP).
name
- The name of a task that is shown to an agent in the Contact Control Panel (CCP).public String getName()
The name of a task that is shown to an agent in the Contact Control Panel (CCP).
public StartTaskContactRequest withName(String name)
The name of a task that is shown to an agent in the Contact Control Panel (CCP).
name
- The name of a task that is shown to an agent in the Contact Control Panel (CCP).public Map<String,Reference> getReferences()
A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following
reference types at the time of creation: URL
| NUMBER
| STRING
|
DATE
| EMAIL
. ATTACHMENT
is not a supported reference type during task
creation.
URL
| NUMBER
|
STRING
| DATE
| EMAIL
. ATTACHMENT
is not a supported
reference type during task creation.public void setReferences(Map<String,Reference> references)
A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following
reference types at the time of creation: URL
| NUMBER
| STRING
|
DATE
| EMAIL
. ATTACHMENT
is not a supported reference type during task
creation.
references
- A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following
reference types at the time of creation: URL
| NUMBER
| STRING
|
DATE
| EMAIL
. ATTACHMENT
is not a supported reference type during
task creation.public StartTaskContactRequest withReferences(Map<String,Reference> references)
A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following
reference types at the time of creation: URL
| NUMBER
| STRING
|
DATE
| EMAIL
. ATTACHMENT
is not a supported reference type during task
creation.
references
- A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following
reference types at the time of creation: URL
| NUMBER
| STRING
|
DATE
| EMAIL
. ATTACHMENT
is not a supported reference type during
task creation.public StartTaskContactRequest addReferencesEntry(String key, Reference value)
public StartTaskContactRequest clearReferencesEntries()
public void setDescription(String description)
A description of the task that is shown to an agent in the Contact Control Panel (CCP).
description
- A description of the task that is shown to an agent in the Contact Control Panel (CCP).public String getDescription()
A description of the task that is shown to an agent in the Contact Control Panel (CCP).
public StartTaskContactRequest withDescription(String description)
A description of the task that is shown to an agent in the Contact Control Panel (CCP).
description
- A description of the task that is shown to an agent in the Contact Control Panel (CCP).public void setClientToken(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.
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 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.
public StartTaskContactRequest withClientToken(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.
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 void setScheduledTime(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 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.
public StartTaskContactRequest withScheduledTime(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 void setTaskTemplateId(String taskTemplateId)
A unique identifier for the task template. For more information about task templates, see Create task templates in the Amazon Connect Administrator Guide.
taskTemplateId
- A unique identifier for the task template. For more information about task templates, see Create task templates
in the Amazon Connect Administrator Guide.public String getTaskTemplateId()
A unique identifier for the task template. For more information about task templates, see Create task templates in the Amazon Connect Administrator Guide.
public StartTaskContactRequest withTaskTemplateId(String taskTemplateId)
A unique identifier for the task template. For more information about task templates, see Create task templates in the Amazon Connect Administrator Guide.
taskTemplateId
- A unique identifier for the task template. For more information about task templates, see Create task templates
in the Amazon Connect Administrator Guide.public void setQuickConnectId(String quickConnectId)
The identifier for the quick connect. Tasks that are created by using QuickConnectId
will use the
flow that is defined on agent or queue quick connect. For more information about quick connects, see Create quick connects.
quickConnectId
- The identifier for the quick connect. Tasks that are created by using QuickConnectId
will use
the flow that is defined on agent or queue quick connect. For more information about quick connects, see
Create quick
connects.public String getQuickConnectId()
The identifier for the quick connect. Tasks that are created by using QuickConnectId
will use the
flow that is defined on agent or queue quick connect. For more information about quick connects, see Create quick connects.
QuickConnectId
will
use the flow that is defined on agent or queue quick connect. For more information about quick connects,
see Create quick
connects.public StartTaskContactRequest withQuickConnectId(String quickConnectId)
The identifier for the quick connect. Tasks that are created by using QuickConnectId
will use the
flow that is defined on agent or queue quick connect. For more information about quick connects, see Create quick connects.
quickConnectId
- The identifier for the quick connect. Tasks that are created by using QuickConnectId
will use
the flow that is defined on agent or queue quick connect. For more information about quick connects, see
Create quick
connects.public void setRelatedContactId(String relatedContactId)
The contactId that is related to this contact.
Linking tasks together by using RelatedContactID
copies over contact attributes from the related
task contact to the new task contact. All updates to user-defined attributes in the new task contact are limited
to the individual contact ID, unlike what happens when tasks are linked by using PreviousContactID
.
There are no limits to the number of contacts that can be linked by using RelatedContactId
.
relatedContactId
- The contactId that is related to this
contact. Linking tasks together by using RelatedContactID
copies over contact attributes from
the related task contact to the new task contact. All updates to user-defined attributes in the new task
contact are limited to the individual contact ID, unlike what happens when tasks are linked by using
PreviousContactID
. There are no limits to the number of contacts that can be linked by using
RelatedContactId
.public String getRelatedContactId()
The contactId that is related to this contact.
Linking tasks together by using RelatedContactID
copies over contact attributes from the related
task contact to the new task contact. All updates to user-defined attributes in the new task contact are limited
to the individual contact ID, unlike what happens when tasks are linked by using PreviousContactID
.
There are no limits to the number of contacts that can be linked by using RelatedContactId
.
RelatedContactID
copies over contact attributes
from the related task contact to the new task contact. All updates to user-defined attributes in the new
task contact are limited to the individual contact ID, unlike what happens when tasks are linked by using
PreviousContactID
. There are no limits to the number of contacts that can be linked by using
RelatedContactId
.public StartTaskContactRequest withRelatedContactId(String relatedContactId)
The contactId that is related to this contact.
Linking tasks together by using RelatedContactID
copies over contact attributes from the related
task contact to the new task contact. All updates to user-defined attributes in the new task contact are limited
to the individual contact ID, unlike what happens when tasks are linked by using PreviousContactID
.
There are no limits to the number of contacts that can be linked by using RelatedContactId
.
relatedContactId
- The contactId that is related to this
contact. Linking tasks together by using RelatedContactID
copies over contact attributes from
the related task contact to the new task contact. All updates to user-defined attributes in the new task
contact are limited to the individual contact ID, unlike what happens when tasks are linked by using
PreviousContactID
. There are no limits to the number of contacts that can be linked by using
RelatedContactId
.public String toString()
toString
in class Object
Object.toString()
public StartTaskContactRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()