software.amazon.awssdk.services.transcribe.model

Class SentimentFilter

java.lang.Object

software.amazon.awssdk.services.transcribe.model.SentimentFilter

All Implemented Interfaces:

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

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

An object that enables you to specify a particular customer or agent sentiment. If at least 50 percent of the conversation turns (the back-and-forth between two speakers) in a specified time period match the specified sentiment, Amazon Transcribe will consider the sentiment a match.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SentimentFilter.Builder

Method Summary

Modifier and Type	Method and Description
AbsoluteTimeRange	absoluteTimeRange() The time range, measured in seconds, of the sentiment.
static SentimentFilter.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSentiments() For responses, this returns true if the service returned a value for the Sentiments property.
Boolean	negate() Set to TRUE to look for sentiments that weren't specified in the request.
ParticipantRole	participantRole() A value that determines whether the sentiment belongs to the customer or the agent.
String	participantRoleAsString() A value that determines whether the sentiment belongs to the customer or the agent.
RelativeTimeRange	relativeTimeRange() The time range, set in percentages, that correspond to proportion of the call.
List<SdkField<?>>	sdkFields()
List<SentimentValue>	sentiments() An array that enables you to specify sentiments for the customer or agent.
List<String>	sentimentsAsStrings() An array that enables you to specify sentiments for the customer or agent.
static Class<? extends SentimentFilter.Builder>	serializableBuilderClass()
SentimentFilter.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

sentiments

public final List<SentimentValue> sentiments()

An array that enables you to specify sentiments for the customer or agent. You can specify one or more values.

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

Returns:

An array that enables you to specify sentiments for the customer or agent. You can specify one or more values.

hasSentiments

public final boolean hasSentiments()

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

sentimentsAsStrings

public final List<String> sentimentsAsStrings()

An array that enables you to specify sentiments for the customer or agent. You can specify one or more values.

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

Returns:

An array that enables you to specify sentiments for the customer or agent. You can specify one or more values.

absoluteTimeRange

public final AbsoluteTimeRange absoluteTimeRange()

The time range, measured in seconds, of the sentiment.

Returns:

The time range, measured in seconds, of the sentiment.

relativeTimeRange

public final RelativeTimeRange relativeTimeRange()

The time range, set in percentages, that correspond to proportion of the call.

Returns:

The time range, set in percentages, that correspond to proportion of the call.

participantRole

public final ParticipantRole participantRole()

A value that determines whether the sentiment belongs to the customer or the agent.

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:

A value that determines whether the sentiment belongs to the customer or the agent.

See Also:

ParticipantRole

participantRoleAsString

public final String participantRoleAsString()

A value that determines whether the sentiment belongs to the customer or the agent.

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:

A value that determines whether the sentiment belongs to the customer or the agent.

See Also:

ParticipantRole

negate

public final Boolean negate()

Set to TRUE to look for sentiments that weren't specified in the request.

Returns:

Set to TRUE to look for sentiments that weren't specified in the request.

toBuilder

public SentimentFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SentimentFilter.Builder,SentimentFilter>

builder

public static SentimentFilter.Builder builder()

serializableBuilderClass

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