StartChatContactRequest (AWS Java SDK :: Services

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

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<StartChatContactRequest.Builder,StartChatContactRequest>

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface StartChatContactRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`StartChatContactRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Map<String,String>`	`attributes()` A custom key-value pair using an attribute map.
`static StartChatContactRequest.Builder`	`builder()`
`Integer`	`chatDurationInMinutes()` The total duration of the newly started chat session.
`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 chat.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAttributes()` For responses, this returns true if the service returned a value for the Attributes property.
`int`	`hashCode()`
`boolean`	`hasSupportedMessagingContentTypes()` For responses, this returns true if the service returned a value for the SupportedMessagingContentTypes property.
`ChatMessage`	`initialMessage()` The initial message to be sent to the newly created chat.
`String`	`instanceId()` The identifier of the Amazon Connect instance.
`ParticipantDetails`	`participantDetails()` Information identifying the participant.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends StartChatContactRequest.Builder>`	`serializableBuilderClass()`
`List<String>`	`supportedMessagingContentTypes()` The supported chat message content types.
`StartChatContactRequest.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. You can find the instanceId in the ARN of the instance.
    
    Returns:
    
    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  - contactFlowId
```
public final String contactFlowId()
```
    The identifier of the contact flow for initiating the chat. 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 chat. 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()
```
    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 the isEmpty() 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
```
public final Map<String,String> attributes()
```
    A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They 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.
    
    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. They 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.
  - participantDetails
```
public final ParticipantDetails participantDetails()
```
    Information identifying the participant.
    
    Returns:
    
    Information identifying the participant.
  - initialMessage
```
public final ChatMessage initialMessage()
```
    The initial message to be sent to the newly created chat.
    
    Returns:
    
    The initial message to be sent to the newly created chat.
  - 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.
  - chatDurationInMinutes
```
public final Integer chatDurationInMinutes()
```
    The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minumum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).
    
    Returns:
    
    The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minumum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).
  - hasSupportedMessagingContentTypes
```
public final boolean hasSupportedMessagingContentTypes()
```
    For responses, this returns true if the service returned a value for the SupportedMessagingContentTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.
  - supportedMessagingContentTypes
```
public final List<String> supportedMessagingContentTypes()
```
    The supported chat message content types. Content types can be text/plain or both text/plain and text/markdown.
    
    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 hasSupportedMessagingContentTypes() method.
    
    Returns:
    
    The supported chat message content types. Content types can be text/plain or both text/plain and text/markdown.
  - toBuilder
```
public StartChatContactRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<StartChatContactRequest.Builder,StartChatContactRequest>
    
    Specified by:
    
    toBuilder in class ConnectRequest
  - builder
```
public static StartChatContactRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends StartChatContactRequest.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

Class StartChatContactRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

instanceId

contactFlowId

hasAttributes

attributes

participantDetails

initialMessage

clientToken

chatDurationInMinutes

hasSupportedMessagingContentTypes

supportedMessagingContentTypes

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields