com.amazonaws.services.lexmodelsv2.model

Class AnalyticsUtteranceFilter

java.lang.Object

com.amazonaws.services.lexmodelsv2.model.AnalyticsUtteranceFilter

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AnalyticsUtteranceFilter
extends Object
implements Serializable, Cloneable, StructuredPojo

Contains fields describing a condition by which to filter the utterances. The expression may be understood as name operator values. For example:

• LocaleId EQ Book – The locale is the string "en".

• UtteranceText CO help – The text of the utterance contains the string "help".

The operators that each filter supports are listed below:

• BotAlias – EQ.

• BotVersion – EQ.

• LocaleId – EQ.

• Modality – EQ.

• Channel – EQ.

• SessionId – EQ.

• OriginatingRequestId – EQ.

• UtteranceState – EQ.

• UtteranceText – EQ, CO.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
AnalyticsUtteranceFilter()

Method Summary

Modifier and Type	Method and Description
AnalyticsUtteranceFilter	clone()
boolean	equals(Object obj)
String	getName() The category by which to filter the utterances.
String	getOperator() The operation by which to filter the category.
List<String>	getValues() An array containing the values of the category by which to apply the operator to filter the results.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setName(String name) The category by which to filter the utterances.
void	setOperator(String operator) The operation by which to filter the category.
void	setValues(Collection<String> values) An array containing the values of the category by which to apply the operator to filter the results.
String	toString() Returns a string representation of this object.
AnalyticsUtteranceFilter	withName(AnalyticsUtteranceFilterName name) The category by which to filter the utterances.
AnalyticsUtteranceFilter	withName(String name) The category by which to filter the utterances.
AnalyticsUtteranceFilter	withOperator(AnalyticsFilterOperator operator) The operation by which to filter the category.
AnalyticsUtteranceFilter	withOperator(String operator) The operation by which to filter the category.
AnalyticsUtteranceFilter	withValues(Collection<String> values) An array containing the values of the category by which to apply the operator to filter the results.
AnalyticsUtteranceFilter	withValues(String... values) An array containing the values of the category by which to apply the operator to filter the results.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AnalyticsUtteranceFilter

public AnalyticsUtteranceFilter()

Method Detail

setName

public void setName(String name)

The category by which to filter the utterances. The descriptions for each option are as follows:

• BotAlias – The name of the bot alias.

• BotVersion – The version of the bot.

• LocaleId – The locale of the bot.

• Modality – The modality of the session with the bot (audio, DTMF, or text).

• Channel – The channel that the bot is integrated with.

• SessionId – The identifier of the session with the bot.

• OriginatingRequestId – The identifier of the first request in a session.

• UtteranceState – The state of the utterance.

• UtteranceText – The text in the utterance.

Parameters:

name - The category by which to filter the utterances. The descriptions for each option are as follows:

• BotAlias – The name of the bot alias.

• BotVersion – The version of the bot.

• LocaleId – The locale of the bot.

• Modality – The modality of the session with the bot (audio, DTMF, or text).

• Channel – The channel that the bot is integrated with.

• SessionId – The identifier of the session with the bot.

• OriginatingRequestId – The identifier of the first request in a session.

• UtteranceState – The state of the utterance.

• UtteranceText – The text in the utterance.

See Also:

AnalyticsUtteranceFilterName

getName

public String getName()

The category by which to filter the utterances. The descriptions for each option are as follows:

• BotAlias – The name of the bot alias.

• BotVersion – The version of the bot.

• LocaleId – The locale of the bot.

• Modality – The modality of the session with the bot (audio, DTMF, or text).

• Channel – The channel that the bot is integrated with.

• SessionId – The identifier of the session with the bot.

• OriginatingRequestId – The identifier of the first request in a session.

• UtteranceState – The state of the utterance.

• UtteranceText – The text in the utterance.

Returns:

The category by which to filter the utterances. The descriptions for each option are as follows:

• BotAlias – The name of the bot alias.

• BotVersion – The version of the bot.

• LocaleId – The locale of the bot.

• Modality – The modality of the session with the bot (audio, DTMF, or text).

• Channel – The channel that the bot is integrated with.

• SessionId – The identifier of the session with the bot.

• OriginatingRequestId – The identifier of the first request in a session.

• UtteranceState – The state of the utterance.

• UtteranceText – The text in the utterance.

See Also:

AnalyticsUtteranceFilterName

withName

public AnalyticsUtteranceFilter withName(String name)

The category by which to filter the utterances. The descriptions for each option are as follows:

• BotAlias – The name of the bot alias.

• BotVersion – The version of the bot.

• LocaleId – The locale of the bot.

• Modality – The modality of the session with the bot (audio, DTMF, or text).

• Channel – The channel that the bot is integrated with.

• SessionId – The identifier of the session with the bot.

• OriginatingRequestId – The identifier of the first request in a session.

• UtteranceState – The state of the utterance.

• UtteranceText – The text in the utterance.

Parameters:

name - The category by which to filter the utterances. The descriptions for each option are as follows:

• BotAlias – The name of the bot alias.

• BotVersion – The version of the bot.

• LocaleId – The locale of the bot.

• Modality – The modality of the session with the bot (audio, DTMF, or text).

• Channel – The channel that the bot is integrated with.

• SessionId – The identifier of the session with the bot.

• OriginatingRequestId – The identifier of the first request in a session.

• UtteranceState – The state of the utterance.

• UtteranceText – The text in the utterance.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AnalyticsUtteranceFilterName

withName

public AnalyticsUtteranceFilter withName(AnalyticsUtteranceFilterName name)

The category by which to filter the utterances. The descriptions for each option are as follows:

• BotAlias – The name of the bot alias.

• BotVersion – The version of the bot.

• LocaleId – The locale of the bot.

• Modality – The modality of the session with the bot (audio, DTMF, or text).

• Channel – The channel that the bot is integrated with.

• SessionId – The identifier of the session with the bot.

• OriginatingRequestId – The identifier of the first request in a session.

• UtteranceState – The state of the utterance.

• UtteranceText – The text in the utterance.

Parameters:

name - The category by which to filter the utterances. The descriptions for each option are as follows:

• BotAlias – The name of the bot alias.

• BotVersion – The version of the bot.

• LocaleId – The locale of the bot.

• Modality – The modality of the session with the bot (audio, DTMF, or text).

• Channel – The channel that the bot is integrated with.

• SessionId – The identifier of the session with the bot.

• OriginatingRequestId – The identifier of the first request in a session.

• UtteranceState – The state of the utterance.

• UtteranceText – The text in the utterance.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AnalyticsUtteranceFilterName

setOperator

public void setOperator(String operator)

The operation by which to filter the category. The following operations are possible:

• CO – Contains

• EQ – Equals

• GT – Greater than

• LT – Less than

The operators that each filter supports are listed below:

• BotAlias – EQ.

• BotVersion – EQ.

• LocaleId – EQ.

• Modality – EQ.

• Channel – EQ.

• SessionId – EQ.

• OriginatingRequestId – EQ.

• UtteranceState – EQ.

• UtteranceText – EQ, CO.

Parameters:

operator - The operation by which to filter the category. The following operations are possible:

• CO – Contains

• EQ – Equals

• GT – Greater than

• LT – Less than

The operators that each filter supports are listed below:

• BotAlias – EQ.

• BotVersion – EQ.

• LocaleId – EQ.

• Modality – EQ.

• Channel – EQ.

• SessionId – EQ.

• OriginatingRequestId – EQ.

• UtteranceState – EQ.

• UtteranceText – EQ, CO.

See Also:

AnalyticsFilterOperator

getOperator

public String getOperator()

The operation by which to filter the category. The following operations are possible:

• CO – Contains

• EQ – Equals

• GT – Greater than

• LT – Less than

The operators that each filter supports are listed below:

• BotAlias – EQ.

• BotVersion – EQ.

• LocaleId – EQ.

• Modality – EQ.

• Channel – EQ.

• SessionId – EQ.

• OriginatingRequestId – EQ.

• UtteranceState – EQ.

• UtteranceText – EQ, CO.

Returns:

The operation by which to filter the category. The following operations are possible:

• CO – Contains

• EQ – Equals

• GT – Greater than

• LT – Less than

The operators that each filter supports are listed below:

• BotAlias – EQ.

• BotVersion – EQ.

• LocaleId – EQ.

• Modality – EQ.

• Channel – EQ.

• SessionId – EQ.

• OriginatingRequestId – EQ.

• UtteranceState – EQ.

• UtteranceText – EQ, CO.

See Also:

AnalyticsFilterOperator

withOperator

public AnalyticsUtteranceFilter withOperator(String operator)

The operation by which to filter the category. The following operations are possible:

• CO – Contains

• EQ – Equals

• GT – Greater than

• LT – Less than

The operators that each filter supports are listed below:

• BotAlias – EQ.

• BotVersion – EQ.

• LocaleId – EQ.

• Modality – EQ.

• Channel – EQ.

• SessionId – EQ.

• OriginatingRequestId – EQ.

• UtteranceState – EQ.

• UtteranceText – EQ, CO.

Parameters:

operator - The operation by which to filter the category. The following operations are possible:

• CO – Contains

• EQ – Equals

• GT – Greater than

• LT – Less than

The operators that each filter supports are listed below:

• BotAlias – EQ.

• BotVersion – EQ.

• LocaleId – EQ.

• Modality – EQ.

• Channel – EQ.

• SessionId – EQ.

• OriginatingRequestId – EQ.

• UtteranceState – EQ.

• UtteranceText – EQ, CO.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AnalyticsFilterOperator

withOperator

public AnalyticsUtteranceFilter withOperator(AnalyticsFilterOperator operator)

The operation by which to filter the category. The following operations are possible:

• CO – Contains

• EQ – Equals

• GT – Greater than

• LT – Less than

The operators that each filter supports are listed below:

• BotAlias – EQ.

• BotVersion – EQ.

• LocaleId – EQ.

• Modality – EQ.

• Channel – EQ.

• SessionId – EQ.

• OriginatingRequestId – EQ.

• UtteranceState – EQ.

• UtteranceText – EQ, CO.

Parameters:

operator - The operation by which to filter the category. The following operations are possible:

• CO – Contains

• EQ – Equals

• GT – Greater than

• LT – Less than

The operators that each filter supports are listed below:

• BotAlias – EQ.

• BotVersion – EQ.

• LocaleId – EQ.

• Modality – EQ.

• Channel – EQ.

• SessionId – EQ.

• OriginatingRequestId – EQ.

• UtteranceState – EQ.

• UtteranceText – EQ, CO.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AnalyticsFilterOperator

getValues

public List<String> getValues()

An array containing the values of the category by which to apply the operator to filter the results. You can provide multiple values if the operator is EQ or CO. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if the name, operator, and values fields are Modality, EQ, and [Speech, Text], the operation filters for results where the modality was either Speech or Text.

Returns:

An array containing the values of the category by which to apply the operator to filter the results. You can provide multiple values if the operator is EQ or CO. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if the name, operator, and values fields are Modality, EQ, and [Speech, Text], the operation filters for results where the modality was either Speech or Text.

setValues

public void setValues(Collection<String> values)

An array containing the values of the category by which to apply the operator to filter the results. You can provide multiple values if the operator is EQ or CO. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if the name, operator, and values fields are Modality, EQ, and [Speech, Text], the operation filters for results where the modality was either Speech or Text.

Parameters:

values - An array containing the values of the category by which to apply the operator to filter the results. You can provide multiple values if the operator is EQ or CO. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if the name , operator, and values fields are Modality, EQ, and [Speech, Text], the operation filters for results where the modality was either Speech or Text.

withValues

public AnalyticsUtteranceFilter withValues(String... values)

An array containing the values of the category by which to apply the operator to filter the results. You can provide multiple values if the operator is EQ or CO. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if the name, operator, and values fields are Modality, EQ, and [Speech, Text], the operation filters for results where the modality was either Speech or Text.

NOTE: This method appends the values to the existing list (if any). Use setValues(java.util.Collection) or withValues(java.util.Collection) if you want to override the existing values.

Parameters:

values - An array containing the values of the category by which to apply the operator to filter the results. You can provide multiple values if the operator is EQ or CO. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if the name , operator, and values fields are Modality, EQ, and [Speech, Text], the operation filters for results where the modality was either Speech or Text.

Returns:

Returns a reference to this object so that method calls can be chained together.

withValues

public AnalyticsUtteranceFilter withValues(Collection<String> values)

An array containing the values of the category by which to apply the operator to filter the results. You can provide multiple values if the operator is EQ or CO. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if the name, operator, and values fields are Modality, EQ, and [Speech, Text], the operation filters for results where the modality was either Speech or Text.

Parameters:

values - An array containing the values of the category by which to apply the operator to filter the results. You can provide multiple values if the operator is EQ or CO. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if the name , operator, and values fields are Modality, EQ, and [Speech, Text], the operation filters for results where the modality was either Speech or Text.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public AnalyticsUtteranceFilter clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo