/* * Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.connect.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; /** *
* Initiates a flow to start a new task. *
*/ public class StartTaskContactRequest extends AmazonWebServiceRequest implements Serializable { /** ** 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
*/
private String instanceId;
/**
*
* The identifier of the previous chat, voice, or task contact. *
*
* Constraints:
* Length: 1 - 256
*/
private String previousContactId;
/**
*
* 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
*/
private String contactFlowId;
/**
*
* 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. *
*/ private java.util.Map* The name of a task that is shown to an agent in the Contact Control Panel * (CCP). *
*
* Constraints:
* Length: 0 - 512
*/
private String name;
/**
*
* A formatted URL that is shown to an agent in the Contact Control Panel * (CCP). *
*/ private java.util.Map* A description of the task that is shown to an agent in the Contact * Control Panel (CCP). *
*
* Constraints:
* Length: 0 - 4096
*/
private String description;
/**
*
* 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
*/
private String clientToken;
/**
*
* 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. *
*/ private java.util.Date scheduledTime; /** ** A unique identifier for the task template. *
*
* Constraints:
* Length: 1 - 500
*/
private String taskTemplateId;
/**
*
* The identifier for the quick connect. *
*/ private String quickConnectId; /** ** The contactId that is related to this contact. *
*
* Constraints:
* Length: 1 - 256
*/
private String relatedContactId;
/**
*
* 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
*
* @return
* 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() { return 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
*
* @param 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 setInstanceId(String instanceId) { this.instanceId = 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
*
* @param instanceId
* The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of * the instance. *
* @return A reference to this updated object so that method calls can be * chained together. */ public StartTaskContactRequest withInstanceId(String instanceId) { this.instanceId = instanceId; return this; } /** ** The identifier of the previous chat, voice, or task contact. *
*
* Constraints:
* Length: 1 - 256
*
* @return
* The identifier of the previous chat, voice, or task contact. *
*/ public String getPreviousContactId() { return previousContactId; } /** ** The identifier of the previous chat, voice, or task contact. *
*
* Constraints:
* Length: 1 - 256
*
* @param previousContactId
* The identifier of the previous chat, voice, or task contact. *
*/ public void setPreviousContactId(String previousContactId) { this.previousContactId = 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
*
* @param previousContactId
* The identifier of the previous chat, voice, or task contact. *
* @return A reference to this updated object so that method calls can be * chained together. */ public StartTaskContactRequest withPreviousContactId(String previousContactId) { this.previousContactId = previousContactId; return this; } /** ** 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
*
* @return
* 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 String getContactFlowId() { return 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
*
* @param 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 void setContactFlowId(String contactFlowId) { this.contactFlowId = 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
*
* @param 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 *
* @return A reference to this updated object so that method calls can be * chained together. */ public StartTaskContactRequest withContactFlowId(String contactFlowId) { this.contactFlowId = contactFlowId; return this; } /** ** 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. *
* * @return* 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 java.util.Map* 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. *
* * @param 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 void setAttributes(java.util.Map* 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. * * @param 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. *
* @return A reference to this updated object so that method calls can be * chained together. */ public StartTaskContactRequest withAttributes(java.util.Map* 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.
*
* @param key The key of the entry to be added into Attributes.
* @param value The corresponding value of the entry to be added into
* Attributes.
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public StartTaskContactRequest addAttributesEntry(String key, String value) {
if (null == this.attributes) {
this.attributes = new java.util.HashMap
* Returns a reference to this object so that method calls can be chained
* together.
*/
public StartTaskContactRequest clearAttributesEntries() {
this.attributes = null;
return this;
}
/**
*
* The name of a task that is shown to an agent in the Contact Control Panel
* (CCP).
*
* Constraints:
* The name of a task that is shown to an agent in the Contact
* Control Panel (CCP).
*
* The name of a task that is shown to an agent in the Contact Control Panel
* (CCP).
*
* Constraints:
* The name of a task that is shown to an agent in the Contact
* Control Panel (CCP).
*
* 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:
* The name of a task 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).
*
* 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).
*
* 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).
*
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param references
* 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).
*
* 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.
*
* @param key The key of the entry to be added into References.
* @param value The corresponding value of the entry to be added into
* References.
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public StartTaskContactRequest addReferencesEntry(String key, Reference value) {
if (null == this.references) {
this.references = new java.util.HashMap
* Returns a reference to this object so that method calls can be chained
* together.
*/
public StartTaskContactRequest clearReferencesEntries() {
this.references = null;
return this;
}
/**
*
* A description of the task that is shown to an agent in the Contact
* Control Panel (CCP).
*
* Constraints:
* A description of the task that is shown to an agent in the
* Contact Control Panel (CCP).
*
* A description of the task that is shown to an agent in the Contact
* Control Panel (CCP).
*
* Constraints:
* A description of the task that is shown to an agent in the
* Contact Control Panel (CCP).
*
* 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:
* A description of the task that is shown to an agent in the
* Contact Control Panel (CCP).
*
* 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:
* 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.
*
* 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:
* 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.
*
* 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:
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* @param 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.
*
* A unique identifier for the task template.
*
* Constraints:
* A unique identifier for the task template.
*
* A unique identifier for the task template.
*
* Constraints:
* A unique identifier for the task template.
*
* A unique identifier for the task template.
*
* Returns a reference to this object so that method calls can be chained
* together.
*
* Constraints:
* A unique identifier for the task template.
*
* The identifier for the quick connect.
*
* The identifier for the quick connect.
*
* The identifier for the quick connect.
*
* The identifier for the quick connect.
*
* The identifier for the quick connect.
*
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param quickConnectId
* The identifier for the quick connect.
*
* The contactId that is related to this contact.
*
* Constraints:
* The contactId that is related to this contact.
*
* The contactId that is related to this contact.
*
* Constraints:
* The contactId that is related to this contact.
*
* The contactId that is related to this contact.
*
* Returns a reference to this object so that method calls can be chained
* together.
*
* Constraints:
* The contactId that is related to this contact.
*
* Length: 0 - 512
*
* @return
* Length: 0 - 512
*
* @param name
* Length: 0 - 512
*
* @param name
* Length: 0 - 4096
*
* @return
* Length: 0 - 4096
*
* @param description
* Length: 0 - 4096
*
* @param description
* Length: - 500
*
* @return
* Length: - 500
*
* @param clientToken
* Length: - 500
*
* @param clientToken
* Length: 1 - 500
*
* @return
* Length: 1 - 500
*
* @param taskTemplateId
* Length: 1 - 500
*
* @param taskTemplateId
* Length: 1 - 256
*
* @return
* Length: 1 - 256
*
* @param relatedContactId
* Length: 1 - 256
*
* @param relatedContactId