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

Class BotFilter

java.lang.Object

software.amazon.awssdk.services.lexmodelsv2.model.BotFilter

All Implemented Interfaces:

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

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

Filters the responses returned by the ListBots operation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BotFilter.Builder

Method Summary

Modifier and Type	Method	Description
static BotFilter.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.
BotFilterName	name()	The name of the field to filter the list of bots.
String	nameAsString()	The name of the field to filter the list of bots.
BotFilterOperator	operator()	The operator to use for the filter.
String	operatorAsString()	The operator to use for the filter.
List<SdkField<?>>	sdkFields()
static Class<? extends BotFilter.Builder>	serializableBuilderClass()
BotFilter.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<String>	values()	The value to use for filtering the list of bots.

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 BotFilterName name()

The name of the field to filter the list of bots.

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

Returns:

The name of the field to filter the list of bots.

See Also:

BotFilterName

nameAsString

public final String nameAsString()

The name of the field to filter the list of bots.

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

Returns:

The name of the field to filter the list of bots.

See Also:

BotFilterName

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()

The value to use for filtering the list of bots.

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:

The value to use for filtering the list of bots.

operator

public final BotFilterOperator operator()

The operator to use for the filter. Specify EQ when the ListBots operation should return only aliases that equal the specified value. Specify CO when the ListBots operation should return aliases that contain the specified value.

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

Returns:

The operator to use for the filter. Specify EQ when the ListBots operation should return only aliases that equal the specified value. Specify CO when the ListBots operation should return aliases that contain the specified value.

See Also:

BotFilterOperator

operatorAsString

public final String operatorAsString()

The operator to use for the filter. Specify EQ when the ListBots operation should return only aliases that equal the specified value. Specify CO when the ListBots operation should return aliases that contain the specified value.

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

Returns:

The operator to use for the filter. Specify EQ when the ListBots operation should return only aliases that equal the specified value. Specify CO when the ListBots operation should return aliases that contain the specified value.

See Also:

BotFilterOperator

toBuilder

public BotFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BotFilter.Builder,BotFilter>

builder

public static BotFilter.Builder builder()

serializableBuilderClass

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