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

Class ListBotLocalesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.lexmodelsv2.model.LexModelsV2Request

software.amazon.awssdk.services.lexmodelsv2.model.ListBotLocalesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListBotLocalesRequest.Builder,ListBotLocalesRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ListBotLocalesRequest
extends LexModelsV2Request
implements ToCopyableBuilder<ListBotLocalesRequest.Builder,ListBotLocalesRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListBotLocalesRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	botId()	The identifier of the bot to list locales for.
String	botVersion()	The version of the bot to list locales for.
static ListBotLocalesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<BotLocaleFilter>	filters()	Provides the specification for a filter used to limit the response to only those locales that match the filter specification.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFilters()	For responses, this returns true if the service returned a value for the Filters property.
int	hashCode()
Integer	maxResults()	The maximum number of aliases to return in each page of results.
String	nextToken()	If the response from the ListBotLocales operation contains more results than specified in the maxResults parameter, a token is returned in the response.
List<SdkField<?>>	sdkFields()
static Class<? extends ListBotLocalesRequest.Builder>	serializableBuilderClass()
BotLocaleSortBy	sortBy()	Specifies sorting parameters for the list of locales.
ListBotLocalesRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

botId

public final String botId()

The identifier of the bot to list locales for.

Returns:

The identifier of the bot to list locales for.

botVersion

public final String botVersion()

The version of the bot to list locales for.

Returns:

The version of the bot to list locales for.

sortBy

public final BotLocaleSortBy sortBy()

Specifies sorting parameters for the list of locales. You can sort by locale name in ascending or descending order.

Returns:

Specifies sorting parameters for the list of locales. You can sort by locale name in ascending or descending order.

hasFilters

public final boolean hasFilters()

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

filters

public final List<BotLocaleFilter> filters()

Provides the specification for a filter used to limit the response to only those locales that match the filter specification. You can only specify one filter and one value to filter on.

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

Returns:

Provides the specification for a filter used to limit the response to only those locales that match the filter specification. You can only specify one filter and one value to filter on.

maxResults

public final Integer maxResults()

The maximum number of aliases to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

Returns:

The maximum number of aliases to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

nextToken

public final String nextToken()

If the response from the ListBotLocales operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token as the nextToken parameter to return the next page of results.

Returns:

If the response from the ListBotLocales operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token as the nextToken parameter to return the next page of results.

toBuilder

public ListBotLocalesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListBotLocalesRequest.Builder,ListBotLocalesRequest>

Specified by:

toBuilder in class LexModelsV2Request

builder

public static ListBotLocalesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListBotLocalesRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo