Class StartTaskContactRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<StartTaskContactRequest.Builder,
StartTaskContactRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionA custom key-value pair using an attribute map.builder()
final String
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.final String
The identifier of the flow for initiating the tasks.final String
A description of the task that is shown to an agent in the Contact Control Panel (CCP).final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the Attributes property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the References property.final String
The identifier of the Amazon Connect instance.final String
name()
The name of a task that is shown to an agent in the Contact Control Panel (CCP).final String
The identifier of the previous chat, voice, or task contact.final String
The identifier for the quick connect.A formatted URL that is shown to an agent in the Contact Control Panel (CCP).final String
The contactId that is related to this contact.final Instant
The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow.static Class
<? extends StartTaskContactRequest.Builder> final String
A unique identifier for the task template.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- Returns:
- The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
-
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.- Returns:
- 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.
-
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
- Returns:
- 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
-
hasAttributes
public final boolean hasAttributes()For responses, this returns true if the service returned a value for the Attributes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAttributes()
method.- Returns:
- 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.
-
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()For responses, this returns true if the service returned a value for the References property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasReferences()
method.- Returns:
- 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.
-
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
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 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.
-
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:
- 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.
-
taskTemplateId
A unique identifier for the task template. For more information about task templates, see Create task templates in the Amazon Connect Administrator Guide.
- Returns:
- A unique identifier for the task template. For more information about task templates, see Create task templates in the Amazon Connect Administrator Guide.
-
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.- Returns:
- 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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<StartTaskContactRequest.Builder,
StartTaskContactRequest> - Specified by:
toBuilder
in classConnectRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-