AnalyticsUtteranceFilter (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.lexmodelsv2.model.AnalyticsUtteranceFilter

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AnalyticsUtteranceFilter.Builder,AnalyticsUtteranceFilter>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class AnalyticsUtteranceFilter
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AnalyticsUtteranceFilter.Builder,AnalyticsUtteranceFilter>
```
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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface AnalyticsUtteranceFilter.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`AnalyticsUtteranceFilter.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static AnalyticsUtteranceFilter.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasValues()` For responses, this returns true if the service returned a value for the Values property.
`AnalyticsUtteranceFilterName`	`name()` The category by which to filter the utterances.
`String`	`nameAsString()` The category by which to filter the utterances.
`AnalyticsFilterOperator`	`operator()` The operation by which to filter the category.
`String`	`operatorAsString()` The operation by which to filter the category.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AnalyticsUtteranceFilter.Builder>`	`serializableBuilderClass()`
`AnalyticsUtteranceFilter.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`List<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
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - name
```
public final 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.
    If the service returns an enum value that is not available in the current SDK version, name will return AnalyticsUtteranceFilterName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nameAsString().
    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
  - nameAsString
```
public final String nameAsString()
```
    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.
    If the service returns an enum value that is not available in the current SDK version, name will return AnalyticsUtteranceFilterName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nameAsString().
    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
  - operator
```
public final 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.
    If the service returns an enum value that is not available in the current SDK version, operator will return AnalyticsFilterOperator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operatorAsString().
    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
  - operatorAsString
```
public final String operatorAsString()
```
    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.
    If the service returns an enum value that is not available in the current SDK version, operator will return AnalyticsFilterOperator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operatorAsString().
    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
  - hasValues
```
public final boolean hasValues()
```
    For responses, this returns true if the service returned a value for the Values 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.
  - values
```
public final List<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.
    
    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 hasValues() method.
    
    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.
  - toBuilder
```
public AnalyticsUtteranceFilter.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AnalyticsUtteranceFilter.Builder,AnalyticsUtteranceFilter>
  - builder
```
public static AnalyticsUtteranceFilter.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AnalyticsUtteranceFilter.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

Class AnalyticsUtteranceFilter

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

name

nameAsString

operator

operatorAsString

hasValues

values

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields