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

Class AgentContactReference

java.lang.Object

software.amazon.awssdk.services.connect.model.AgentContactReference

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AgentContactReference.Builder,AgentContactReference>

@Generated("software.amazon.awssdk:codegen")
public final class AgentContactReference
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AgentContactReference.Builder,AgentContactReference>

Information about the contact associated to the user.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AgentContactReference.Builder

Method Summary

Modifier and Type	Method	Description
ContactState	agentContactState()	The state of the contact.
String	agentContactStateAsString()	The state of the contact.
static AgentContactReference.Builder	builder()
Channel	channel()	The channel of the contact.
String	channelAsString()	The channel of the contact.
Instant	connectedToAgentTimestamp()	The time at which the contact was connected to an agent.
String	contactId()	The identifier of the contact in this instance of Amazon Connect.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
ContactInitiationMethod	initiationMethod()	How the contact was initiated.
String	initiationMethodAsString()	How the contact was initiated.
QueueReference	queue()	Returns the value of the Queue property for this object.
List<SdkField<?>>	sdkFields()
static Class<? extends AgentContactReference.Builder>	serializableBuilderClass()
Instant	stateStartTimestamp()	The epoch timestamp when the contact state started.
AgentContactReference.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

contactId

public final String contactId()

The identifier of the contact in this instance of Amazon Connect.

Returns:

The identifier of the contact in this instance of Amazon Connect.

channel

public final Channel channel()

The channel of the contact.

If the service returns an enum value that is not available in the current SDK version, channel will return Channel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from channelAsString().

Returns:

The channel of the contact.

See Also:

Channel

channelAsString

public final String channelAsString()

The channel of the contact.

If the service returns an enum value that is not available in the current SDK version, channel will return Channel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from channelAsString().

Returns:

The channel of the contact.

See Also:

Channel

initiationMethod

public final ContactInitiationMethod initiationMethod()

How the contact was initiated.

If the service returns an enum value that is not available in the current SDK version, initiationMethod will return ContactInitiationMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from initiationMethodAsString().

Returns:

How the contact was initiated.

See Also:

ContactInitiationMethod

initiationMethodAsString

public final String initiationMethodAsString()

How the contact was initiated.

If the service returns an enum value that is not available in the current SDK version, initiationMethod will return ContactInitiationMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from initiationMethodAsString().

Returns:

How the contact was initiated.

See Also:

ContactInitiationMethod

agentContactState

public final ContactState agentContactState()

The state of the contact.

When AgentContactState is set to CONNECTED_ONHOLD, StateStartTimestamp is not changed. Instead, StateStartTimestamp reflects the time the contact was CONNECTED to the agent.

If the service returns an enum value that is not available in the current SDK version, agentContactState will return ContactState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from agentContactStateAsString().

Returns:

The state of the contact.

When AgentContactState is set to CONNECTED_ONHOLD, StateStartTimestamp is not changed. Instead, StateStartTimestamp reflects the time the contact was CONNECTED to the agent.

See Also:

ContactState

agentContactStateAsString

public final String agentContactStateAsString()

The state of the contact.

When AgentContactState is set to CONNECTED_ONHOLD, StateStartTimestamp is not changed. Instead, StateStartTimestamp reflects the time the contact was CONNECTED to the agent.

If the service returns an enum value that is not available in the current SDK version, agentContactState will return ContactState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from agentContactStateAsString().

Returns:

The state of the contact.

When AgentContactState is set to CONNECTED_ONHOLD, StateStartTimestamp is not changed. Instead, StateStartTimestamp reflects the time the contact was CONNECTED to the agent.

See Also:

ContactState

stateStartTimestamp

public final Instant stateStartTimestamp()

The epoch timestamp when the contact state started.

Returns:

The epoch timestamp when the contact state started.

connectedToAgentTimestamp

public final Instant connectedToAgentTimestamp()

The time at which the contact was connected to an agent.

Returns:

The time at which the contact was connected to an agent.

queue

public final QueueReference queue()

Returns the value of the Queue property for this object.

Returns:

The value of the Queue property for this object.

toBuilder

public AgentContactReference.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AgentContactReference.Builder,AgentContactReference>

builder

public static AgentContactReference.Builder builder()

serializableBuilderClass

public static Class<? extends AgentContactReference.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo