software.amazon.awssdk.services.connect.model

Interface StartTaskContactRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, ConnectRequest.Builder, CopyableBuilder<StartTaskContactRequest.Builder,StartTaskContactRequest>, SdkBuilder<StartTaskContactRequest.Builder,StartTaskContactRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

StartTaskContactRequest

public static interface StartTaskContactRequest.Builder
extends ConnectRequest.Builder, SdkPojo, CopyableBuilder<StartTaskContactRequest.Builder,StartTaskContactRequest>

Method Summary

Modifier and Type	Method and Description
StartTaskContactRequest.Builder	attributes(Map<String,String> attributes) A custom key-value pair using an attribute map.
StartTaskContactRequest.Builder	clientToken(String clientToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
StartTaskContactRequest.Builder	contactFlowId(String contactFlowId) The identifier of the flow for initiating the tasks.
StartTaskContactRequest.Builder	description(String description) A description of the task that is shown to an agent in the Contact Control Panel (CCP).
StartTaskContactRequest.Builder	instanceId(String instanceId) The identifier of the Amazon Connect instance.
StartTaskContactRequest.Builder	name(String name) The name of a task that is shown to an agent in the Contact Control Panel (CCP).
StartTaskContactRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
StartTaskContactRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
StartTaskContactRequest.Builder	previousContactId(String previousContactId) The identifier of the previous chat, voice, or task contact.
StartTaskContactRequest.Builder	quickConnectId(String quickConnectId) The identifier for the quick connect.
StartTaskContactRequest.Builder	references(Map<String,Reference> references) A formatted URL that is shown to an agent in the Contact Control Panel (CCP).
StartTaskContactRequest.Builder	scheduledTime(Instant scheduledTime) The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow.
StartTaskContactRequest.Builder	taskTemplateId(String taskTemplateId) A unique identifier for the task template.

Methods inherited from interface software.amazon.awssdk.services.connect.model.ConnectRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

instanceId

StartTaskContactRequest.Builder instanceId(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.

previousContactId

StartTaskContactRequest.Builder previousContactId(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.

contactFlowId

StartTaskContactRequest.Builder contactFlowId(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

Parameters:

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:

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

attributes

StartTaskContactRequest.Builder attributes(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.

Parameters:

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:

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

name

StartTaskContactRequest.Builder name(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.

references

StartTaskContactRequest.Builder references(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.

description

StartTaskContactRequest.Builder description(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.

clientToken

StartTaskContactRequest.Builder clientToken(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.

scheduledTime

StartTaskContactRequest.Builder scheduledTime(Instant 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.

Parameters:

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:

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

taskTemplateId

StartTaskContactRequest.Builder taskTemplateId(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.

quickConnectId

StartTaskContactRequest.Builder quickConnectId(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.

overrideConfiguration

StartTaskContactRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

StartTaskContactRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder