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

Class TranscriptCriteria

java.lang.Object

software.amazon.awssdk.services.connect.model.TranscriptCriteria

All Implemented Interfaces:

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

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

A structure that defines search criteria base on words or phrases, participants in the Contact Lens conversational analytics transcript.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TranscriptCriteria.Builder

Method Summary

Modifier and Type	Method	Description
static TranscriptCriteria.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSearchText()	For responses, this returns true if the service returned a value for the SearchText property.
SearchContactsMatchType	matchType()	The match type combining search criteria using multiple search texts in a transcript criteria.
String	matchTypeAsString()	The match type combining search criteria using multiple search texts in a transcript criteria.
ParticipantRole	participantRole()	The participant role in a transcript
String	participantRoleAsString()	The participant role in a transcript
List<SdkField<?>>	sdkFields()
List<String>	searchText()	The words or phrases used to search within a transcript.
static Class<? extends TranscriptCriteria.Builder>	serializableBuilderClass()
TranscriptCriteria.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

participantRole

public final ParticipantRole participantRole()

The participant role in a transcript

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

Returns:

The participant role in a transcript

See Also:

ParticipantRole

participantRoleAsString

public final String participantRoleAsString()

The participant role in a transcript

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

Returns:

The participant role in a transcript

See Also:

ParticipantRole

hasSearchText

public final boolean hasSearchText()

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

searchText

public final List<String> searchText()

The words or phrases used to search within a transcript.

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

Returns:

The words or phrases used to search within a transcript.

matchType

public final SearchContactsMatchType matchType()

The match type combining search criteria using multiple search texts in a transcript criteria.

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

Returns:

The match type combining search criteria using multiple search texts in a transcript criteria.

See Also:

SearchContactsMatchType

matchTypeAsString

public final String matchTypeAsString()

The match type combining search criteria using multiple search texts in a transcript criteria.

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

Returns:

The match type combining search criteria using multiple search texts in a transcript criteria.

See Also:

SearchContactsMatchType

toBuilder

public TranscriptCriteria.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TranscriptCriteria.Builder,TranscriptCriteria>

builder

public static TranscriptCriteria.Builder builder()

serializableBuilderClass

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