Package software.amazon.awssdk.services.lexmodelsv2.model

Class AnalyticsPathFilter

java.lang.Object

software.amazon.awssdk.services.lexmodelsv2.model.AnalyticsPathFilter

All Implemented Interfaces:

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

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

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

• LocaleId EQ en – The locale is "en".

• BotVersion EQ 2 – The bot version is equal to two.

The operators that each filter supports are listed below:

• BotAlias – EQ.

• BotVersion – EQ.

• LocaleId – EQ.

• Modality – EQ.

• Channel – EQ.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AnalyticsPathFilter.Builder

Method Summary

Modifier and Type	Method	Description
static AnalyticsPathFilter.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final boolean	hasValues()	For responses, this returns true if the service returned a value for the Values property.
final AnalyticsCommonFilterName	name()	The category by which to filter the intent paths.
final String	nameAsString()	The category by which to filter the intent paths.
final AnalyticsFilterOperator	operator()	The operation by which to filter the category.
final String	operatorAsString()	The operation by which to filter the category.
final List<SdkField<?>>	sdkFields()
static Class<? extends AnalyticsPathFilter.Builder>	serializableBuilderClass()
AnalyticsPathFilter.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.
final 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

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Details

name

public final AnalyticsCommonFilterName name()

The category by which to filter the intent paths. 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.

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

Returns:

The category by which to filter the intent paths. 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.

See Also:

• AnalyticsCommonFilterName

nameAsString

public final String nameAsString()

The category by which to filter the intent paths. 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.

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

Returns:

The category by which to filter the intent paths. 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.

See Also:

• AnalyticsCommonFilterName

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.

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.

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.

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.

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 AnalyticsPathFilter.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<AnalyticsPathFilter.Builder,AnalyticsPathFilter>

Returns:

a builder for type T

builder

public static AnalyticsPathFilter.Builder builder()

serializableBuilderClass

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

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.