Package software.amazon.awssdk.services.connect.model

Class MonitorContactRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<MonitorContactRequest.Builder,MonitorContactRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MonitorContactRequest.Builder

Method Summary

Modifier and Type	Method	Description
List<MonitorCapability>	allowedMonitorCapabilities()	Specify which monitoring actions the user is allowed to take.
List<String>	allowedMonitorCapabilitiesAsStrings()	Specify which monitoring actions the user is allowed to take.
static MonitorContactRequest.Builder	builder()
String	clientToken()	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String	contactId()	The identifier of the contact.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAllowedMonitorCapabilities()	For responses, this returns true if the service returned a value for the AllowedMonitorCapabilities property.
int	hashCode()
String	instanceId()	The identifier of the Amazon Connect instance.
List<SdkField<?>>	sdkFields()
static Class<? extends MonitorContactRequest.Builder>	serializableBuilderClass()
MonitorContactRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userId()	The identifier of the user account.

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.

contactId

public final String contactId()

The identifier of the contact.

Returns:

The identifier of the contact.

userId

public final String userId()

The identifier of the user account.

Returns:

The identifier of the user account.

allowedMonitorCapabilities

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

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 hasAllowedMonitorCapabilities() method.

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.

hasAllowedMonitorCapabilities

public final boolean hasAllowedMonitorCapabilities()

For responses, this returns true if the service returned a value for the AllowedMonitorCapabilities 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.

allowedMonitorCapabilitiesAsStrings

public final List<String> allowedMonitorCapabilitiesAsStrings()

Specify which monitoring actions the user is allowed to take. For example, whether the user is allowed to escalate from silent monitoring to barge.

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 hasAllowedMonitorCapabilities() method.

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.

clientToken

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

toBuilder

public MonitorContactRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MonitorContactRequest.Builder,MonitorContactRequest>

Specified by:

toBuilder in class ConnectRequest

builder

public static MonitorContactRequest.Builder builder()

serializableBuilderClass

public static Class<? extends MonitorContactRequest.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