Class ListBotLocalesRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListBotLocalesRequest.Builder,
ListBotLocalesRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
botId()
The identifier of the bot to list locales for.final String
The version of the bot to list locales for.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final List
<BotLocaleFilter> filters()
Provides the specification for a filter used to limit the response to only those locales that match the filter specification.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the Filters property.final int
hashCode()
final Integer
The maximum number of aliases to return in each page of results.final String
If the response from theListBotLocales
operation contains more results than specified in themaxResults
parameter, a token is returned in the response.static Class
<? extends ListBotLocalesRequest.Builder> final BotLocaleSortBy
sortBy()
Specifies sorting parameters for the list of locales.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.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
botId
The identifier of the bot to list locales for.
- Returns:
- The identifier of the bot to list locales for.
-
botVersion
The version of the bot to list locales for.
- Returns:
- The version of the bot to list locales for.
-
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 theisEmpty()
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
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
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
If the response from the
ListBotLocales
operation contains more results than specified in themaxResults
parameter, a token is returned in the response. Use that token as thenextToken
parameter to return the next page of results.- Returns:
- If the response from the
ListBotLocales
operation contains more results than specified in themaxResults
parameter, a token is returned in the response. Use that token as thenextToken
parameter to return the next page of results.
-
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 interfaceToCopyableBuilder<ListBotLocalesRequest.Builder,
ListBotLocalesRequest> - Specified by:
toBuilder
in classLexModelsV2Request
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-