Class ContactSearchSummary
- java.lang.Object
-
- software.amazon.awssdk.services.connect.model.ContactSearchSummary
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ContactSearchSummary.Builder,ContactSearchSummary>
@Generated("software.amazon.awssdk:codegen") public final class ContactSearchSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ContactSearchSummary.Builder,ContactSearchSummary>
Information of returned contact.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ContactSearchSummary.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ContactSearchSummaryAgentInfo
agentInfo()
Information about the agent who accepted the contact.String
arn()
The Amazon Resource Name (ARN) of the contact.static ContactSearchSummary.Builder
builder()
Channel
channel()
How the contact reached your contact center.String
channelAsString()
How the contact reached your contact center.Instant
disconnectTimestamp()
The timestamp when the customer endpoint disconnected from Amazon Connect.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
String
id()
The identifier of the contact summary.String
initialContactId()
If this contact is related to other contacts, this is the ID of the initial contact.ContactInitiationMethod
initiationMethod()
Indicates how the contact was initiated.String
initiationMethodAsString()
Indicates how the contact was initiated.Instant
initiationTimestamp()
The date and time this contact was initiated, in UTC time.String
previousContactId()
If this contact is not the first contact, this is the ID of the previous contact.ContactSearchSummaryQueueInfo
queueInfo()
If this contact was queued, this contains information about the queue.Instant
scheduledTimestamp()
The timestamp, in Unix epoch time format, at which to start running the inbound flow.Map<String,SdkField<?>>
sdkFieldNameToField()
List<SdkField<?>>
sdkFields()
static Class<? extends ContactSearchSummary.Builder>
serializableBuilderClass()
ContactSearchSummary.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
-
arn
public final String arn()
The Amazon Resource Name (ARN) of the contact.
- Returns:
- The Amazon Resource Name (ARN) of the contact.
-
id
public final String id()
The identifier of the contact summary.
- Returns:
- The identifier of the contact summary.
-
initialContactId
public final String initialContactId()
If this contact is related to other contacts, this is the ID of the initial contact.
- Returns:
- If this contact is related to other contacts, this is the ID of the initial contact.
-
previousContactId
public final String previousContactId()
If this contact is not the first contact, this is the ID of the previous contact.
- Returns:
- If this contact is not the first contact, this is the ID of the previous contact.
-
initiationMethod
public final ContactInitiationMethod initiationMethod()
Indicates how the contact was initiated.
If the service returns an enum value that is not available in the current SDK version,
initiationMethod
will returnContactInitiationMethod.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominitiationMethodAsString()
.- Returns:
- Indicates how the contact was initiated.
- See Also:
ContactInitiationMethod
-
initiationMethodAsString
public final String initiationMethodAsString()
Indicates how the contact was initiated.
If the service returns an enum value that is not available in the current SDK version,
initiationMethod
will returnContactInitiationMethod.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominitiationMethodAsString()
.- Returns:
- Indicates how the contact was initiated.
- See Also:
ContactInitiationMethod
-
channel
public final Channel channel()
How the contact reached your contact center.
If the service returns an enum value that is not available in the current SDK version,
channel
will returnChannel.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromchannelAsString()
.- Returns:
- How the contact reached your contact center.
- See Also:
Channel
-
channelAsString
public final String channelAsString()
How the contact reached your contact center.
If the service returns an enum value that is not available in the current SDK version,
channel
will returnChannel.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromchannelAsString()
.- Returns:
- How the contact reached your contact center.
- See Also:
Channel
-
queueInfo
public final ContactSearchSummaryQueueInfo queueInfo()
If this contact was queued, this contains information about the queue.
- Returns:
- If this contact was queued, this contains information about the queue.
-
agentInfo
public final ContactSearchSummaryAgentInfo agentInfo()
Information about the agent who accepted the contact.
- Returns:
- Information about the agent who accepted the contact.
-
initiationTimestamp
public final Instant initiationTimestamp()
The date and time this contact was initiated, in UTC time. For
INBOUND
, this is when the contact arrived. ForOUTBOUND
, this is when the agent began dialing. ForCALLBACK
, this is when the callback contact was created. ForTRANSFER
andQUEUE_TRANSFER
, this is when the transfer was initiated. For API, this is when the request arrived. ForEXTERNAL_OUTBOUND
, this is when the agent started dialing the external participant. ForMONITOR
, this is when the supervisor started listening to a contact.- Returns:
- The date and time this contact was initiated, in UTC time. For
INBOUND
, this is when the contact arrived. ForOUTBOUND
, this is when the agent began dialing. ForCALLBACK
, this is when the callback contact was created. ForTRANSFER
andQUEUE_TRANSFER
, this is when the transfer was initiated. For API, this is when the request arrived. ForEXTERNAL_OUTBOUND
, this is when the agent started dialing the external participant. ForMONITOR
, this is when the supervisor started listening to a contact.
-
disconnectTimestamp
public final Instant disconnectTimestamp()
The timestamp when the customer endpoint disconnected from Amazon Connect.
- Returns:
- The timestamp when the customer endpoint disconnected from Amazon Connect.
-
scheduledTimestamp
public final Instant scheduledTimestamp()
The timestamp, in Unix epoch time format, at which to start running the inbound flow.
- Returns:
- The timestamp, in Unix epoch time format, at which to start running the inbound flow.
-
toBuilder
public ContactSearchSummary.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ContactSearchSummary.Builder,ContactSearchSummary>
-
builder
public static ContactSearchSummary.Builder builder()
-
serializableBuilderClass
public static Class<? extends ContactSearchSummary.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
-
-