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

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class MonitorContactRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable
```
Initiates silent monitoring of a contact. The Contact Control Panel (CCP) of the user specified by userId will be set to silent monitoring mode on the contact.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

MonitorContactRequest()

Constructors
Constructor and Description
`MonitorContactRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.util.List<java.lang.String>`	`getAllowedMonitorCapabilities()` Specify which monitoring actions the user is allowed to take.
`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.
`java.lang.String`	`getUserId()` The identifier of the user account.
`int`	`hashCode()`
`void`	`setAllowedMonitorCapabilities(java.util.Collection<java.lang.String> allowedMonitorCapabilities)` Specify which monitoring actions the user is allowed to take.
`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.
`void`	`setUserId(java.lang.String userId)` The identifier of the user account.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`MonitorContactRequest`	`withAllowedMonitorCapabilities(java.util.Collection<java.lang.String> allowedMonitorCapabilities)` Specify which monitoring actions the user is allowed to take.
`MonitorContactRequest`	`withAllowedMonitorCapabilities(java.lang.String... allowedMonitorCapabilities)` Specify which monitoring actions the user is allowed to take.
`MonitorContactRequest`	`withClientToken(java.lang.String clientToken)` A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`MonitorContactRequest`	`withContactId(java.lang.String contactId)` The identifier of the contact.
`MonitorContactRequest`	`withInstanceId(java.lang.String instanceId)` The identifier of the Amazon Connect instance.
`MonitorContactRequest`	`withUserId(java.lang.String userId)` The identifier of the user account.

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
  - MonitorContactRequest
```
public MonitorContactRequest()
```
- Method Detail
  - getInstanceId
```
public java.lang.String getInstanceId()
```
    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
    
    Constraints:
    Length: 1 - 100
    
    Returns:
    
    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  - setInstanceId
```
public void setInstanceId(java.lang.String instanceId)
```
    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
    
    Constraints:
    Length: 1 - 100
    
    Parameters:
    
    instanceId -
    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  - withInstanceId
```
public MonitorContactRequest withInstanceId(java.lang.String instanceId)
```
    The identifier of the Amazon Connect instance. You can find the instanceId in the 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 instanceId in the 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.
    
    Constraints:
    Length: 1 - 256
    
    Returns:
    
    The identifier of the contact.
  - setContactId
```
public void setContactId(java.lang.String contactId)
```
    The identifier of the contact.
    
    Constraints:
    Length: 1 - 256
    
    Parameters:
    
    contactId -
    The identifier of the contact.
  - withContactId
```
public MonitorContactRequest withContactId(java.lang.String contactId)
```
    The identifier of the contact.
    
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getUserId
```
public java.lang.String getUserId()
```
    The identifier of the user account.
    
    Constraints:
    Length: 1 - 256
    
    Returns:
    
    The identifier of the user account.
  - setUserId
```
public void setUserId(java.lang.String userId)
```
    The identifier of the user account.
    
    Constraints:
    Length: 1 - 256
    
    Parameters:
    
    userId -
    The identifier of the user account.
  - withUserId
```
public MonitorContactRequest withUserId(java.lang.String userId)
```
    The identifier of the user account.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 256
    
    Parameters:
    
    userId -
    The identifier of the user account.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getAllowedMonitorCapabilities
```
public java.util.List<java.lang.String> getAllowedMonitorCapabilities()
```
    Specify which monitoring actions the user is allowed to take. For example, whether the user is allowed to escalate from silent monitoring to barge.
    
    Returns:
    
    Specify which monitoring actions the user is allowed to take. For example, whether the user is allowed to escalate from silent monitoring to barge.
  - setAllowedMonitorCapabilities
```
public void setAllowedMonitorCapabilities(java.util.Collection<java.lang.String> allowedMonitorCapabilities)
```
    Specify which monitoring actions the user is allowed to take. For example, whether the user is allowed to escalate from silent monitoring to barge.
    
    Parameters:
    
    allowedMonitorCapabilities -
    Specify which monitoring actions the user is allowed to take. For example, whether the user is allowed to escalate from silent monitoring to barge.
  - withAllowedMonitorCapabilities
```
public MonitorContactRequest withAllowedMonitorCapabilities(java.lang.String... allowedMonitorCapabilities)
```
    Specify which monitoring actions the user is allowed to take. For example, whether the user is allowed to escalate from silent monitoring to barge.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    allowedMonitorCapabilities -
    Specify which monitoring actions the user is allowed to take. For example, whether the user is allowed to escalate from silent monitoring to barge.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withAllowedMonitorCapabilities
```
public MonitorContactRequest withAllowedMonitorCapabilities(java.util.Collection<java.lang.String> allowedMonitorCapabilities)
```
    Specify which monitoring actions the user is allowed to take. For example, whether the user is allowed to escalate from silent monitoring to barge.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    allowedMonitorCapabilities -
    Specify which monitoring actions the user is allowed to take. For example, whether the user is allowed to escalate from silent monitoring to barge.
    
    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 MonitorContactRequest 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 MonitorContactRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

MonitorContactRequest

Method Detail

getInstanceId

setInstanceId

withInstanceId

getContactId

setContactId

withContactId

getUserId

setUserId

withUserId

getAllowedMonitorCapabilities

setAllowedMonitorCapabilities

withAllowedMonitorCapabilities

withAllowedMonitorCapabilities

getClientToken

setClientToken

withClientToken

toString

hashCode

equals