software.amazon.awssdk.services.connect.model

Class StartTaskContactRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.connect.model.ConnectRequest

software.amazon.awssdk.services.connect.model.StartTaskContactRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartTaskContactRequest.Builder,StartTaskContactRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class StartTaskContactRequest
extends ConnectRequest
implements ToCopyableBuilder<StartTaskContactRequest.Builder,StartTaskContactRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartTaskContactRequest.Builder

Method Summary

Modifier and Type	Method and Description
Map<String,String>	attributes() A custom key-value pair using an attribute map.
static StartTaskContactRequest.Builder	builder()
String	clientToken() A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String	contactFlowId() The identifier of the contact flow for initiating the tasks.
String	description() A description of the task that is shown to an agent in the Contact Control Panel (CCP).
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAttributes() Returns true if the Attributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasReferences() Returns true if the References property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	instanceId() The identifier of the Amazon Connect instance.
String	name() The name of a task that is shown to an agent in the Contact Control Panel (CCP).
String	previousContactId() The identifier of the previous chat, voice, or task contact.
Map<String,Reference>	references() A formatted URL that is shown to an agent in the Contact Control Panel (CCP).
List<SdkField<?>>	sdkFields()
static Class<? extends StartTaskContactRequest.Builder>	serializableBuilderClass()
StartTaskContactRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

instanceId

public final String instanceId()

The identifier of the Amazon Connect instance.

Returns:

The identifier of the Amazon Connect instance.

previousContactId

public final String previousContactId()

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

Returns:

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

contactFlowId

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

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

hasAttributes

public final boolean hasAttributes()

Returns true if the Attributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

attributes

public final 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasAttributes() to see if a value was sent in this field.

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.

name

public final String name()

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

hasReferences

public final boolean hasReferences()

Returns true if the References property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

references

public final Map<String,Reference> references()

A formatted URL that is shown to an agent in the Contact Control Panel (CCP).

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasReferences() to see if a value was sent in this field.

Returns:

A formatted URL that is shown to an agent in the Contact Control Panel (CCP).

description

public final String description()

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

clientToken

public final String clientToken()

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.

toBuilder

public StartTaskContactRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartTaskContactRequest.Builder,StartTaskContactRequest>

Specified by:

toBuilder in class ConnectRequest

builder

public static StartTaskContactRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartTaskContactRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo