StartContactStreamingRequest (aws-android-sdk-connect 2.81.1 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.connect.model.StartContactStreamingRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class StartContactStreamingRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable
```
Initiates real-time message streaming for a new chat contact.

For more information about message streaming, see Enable real-time chat message streaming in the Amazon Connect Administrator Guide.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

StartContactStreamingRequest()

Constructors
Constructor and Description
`StartContactStreamingRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`ChatStreamingConfiguration`	`getChatStreamingConfiguration()` The streaming configuration, such as the Amazon SNS streaming endpoint.
`java.lang.String`	`getClientToken()` A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`java.lang.String`	`getContactId()` The identifier of the contact.
`java.lang.String`	`getInstanceId()` The identifier of the Amazon Connect instance.
`int`	`hashCode()`
`void`	`setChatStreamingConfiguration(ChatStreamingConfiguration chatStreamingConfiguration)` The streaming configuration, such as the Amazon SNS streaming endpoint.
`void`	`setClientToken(java.lang.String clientToken)` A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`void`	`setContactId(java.lang.String contactId)` The identifier of the contact.
`void`	`setInstanceId(java.lang.String instanceId)` The identifier of the Amazon Connect instance.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`StartContactStreamingRequest`	`withChatStreamingConfiguration(ChatStreamingConfiguration chatStreamingConfiguration)` The streaming configuration, such as the Amazon SNS streaming endpoint.
`StartContactStreamingRequest`	`withClientToken(java.lang.String clientToken)` A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`StartContactStreamingRequest`	`withContactId(java.lang.String contactId)` The identifier of the contact.
`StartContactStreamingRequest`	`withInstanceId(java.lang.String instanceId)` The identifier of the Amazon Connect instance.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - StartContactStreamingRequest
```
public StartContactStreamingRequest()
```
- Method Detail
  - getInstanceId
```
public java.lang.String getInstanceId()
```
    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
    
    Returns:
    
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
  - setInstanceId
```
public void setInstanceId(java.lang.String 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
    
    Parameters:
    
    instanceId -
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
  - withInstanceId
```
public StartContactStreamingRequest withInstanceId(java.lang.String 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
    
    Parameters:
    
    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 updated object so that method calls can be chained together.
  - getContactId
```
public java.lang.String getContactId()
```
    The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
    
    Constraints:
    Length: 1 - 256
    
    Returns:
    
    The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
  - setContactId
```
public void setContactId(java.lang.String contactId)
```
    The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
    
    Constraints:
    Length: 1 - 256
    
    Parameters:
    
    contactId -
    The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
  - withContactId
```
public StartContactStreamingRequest withContactId(java.lang.String contactId)
```
    The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 256
    
    Parameters:
    
    contactId -
    The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getChatStreamingConfiguration
```
public ChatStreamingConfiguration getChatStreamingConfiguration()
```
    The streaming configuration, such as the Amazon SNS streaming endpoint.
    
    Returns:
    
    The streaming configuration, such as the Amazon SNS streaming endpoint.
  - setChatStreamingConfiguration
```
public void setChatStreamingConfiguration(ChatStreamingConfiguration chatStreamingConfiguration)
```
    The streaming configuration, such as the Amazon SNS streaming endpoint.
    
    Parameters:
    
    chatStreamingConfiguration -
    The streaming configuration, such as the Amazon SNS streaming endpoint.
  - withChatStreamingConfiguration
```
public StartContactStreamingRequest withChatStreamingConfiguration(ChatStreamingConfiguration chatStreamingConfiguration)
```
    The streaming configuration, such as the Amazon SNS streaming endpoint.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    chatStreamingConfiguration -
    The streaming configuration, such as the Amazon SNS streaming endpoint.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getClientToken
```
public java.lang.String getClientToken()
```
    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
    
    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.
  - setClientToken
```
public void setClientToken(java.lang.String 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.
    
    Constraints:
    Length: - 500
    
    Parameters:
    
    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.
  - withClientToken
```
public StartContactStreamingRequest withClientToken(java.lang.String 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 reference to this object so that method calls can be chained together.
    Constraints:
    Length: - 500
    
    Parameters:
    
    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 reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class StartContactStreamingRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

StartContactStreamingRequest

Method Detail

getInstanceId

setInstanceId

withInstanceId

getContactId

setContactId

withContactId

getChatStreamingConfiguration

setChatStreamingConfiguration

withChatStreamingConfiguration

getClientToken

setClientToken

withClientToken

toString

hashCode

equals