Class ListAggregatedUtterancesRequest
- 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.ListAggregatedUtterancesRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<ListAggregatedUtterancesRequest.Builder,ListAggregatedUtterancesRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListAggregatedUtterancesRequest extends LexModelsV2Request implements ToCopyableBuilder<ListAggregatedUtterancesRequest.Builder,ListAggregatedUtterancesRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceListAggregatedUtterancesRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description UtteranceAggregationDurationaggregationDuration()The time window for aggregating the utterance information.StringbotAliasId()The identifier of the bot alias associated with this request.StringbotId()The unique identifier of the bot associated with this request.StringbotVersion()The identifier of the bot version associated with this request.static ListAggregatedUtterancesRequest.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)List<AggregatedUtterancesFilter>filters()Provides the specification of a filter used to limit the utterances in the response to only those that match the filter specification.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasFilters()For responses, this returns true if the service returned a value for the Filters property.inthashCode()StringlocaleId()The identifier of the language and locale where the utterances were collected.IntegermaxResults()The maximum number of utterances to return in each page of results.StringnextToken()If the response from theListAggregatedUtterancesoperation contains more results that specified in themaxResultsparameter, a token is returned in the response.List<SdkField<?>>sdkFields()static Class<? extends ListAggregatedUtterancesRequest.Builder>serializableBuilderClass()AggregatedUtterancesSortBysortBy()Specifies sorting parameters for the list of utterances.ListAggregatedUtterancesRequest.BuildertoBuilder()StringtoString()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 unique identifier of the bot associated with this request.
- Returns:
- The unique identifier of the bot associated with this request.
-
botAliasId
public final String botAliasId()
The identifier of the bot alias associated with this request. If you specify the bot alias, you can't specify the bot version.
- Returns:
- The identifier of the bot alias associated with this request. If you specify the bot alias, you can't specify the bot version.
-
botVersion
public final String botVersion()
The identifier of the bot version associated with this request. If you specify the bot version, you can't specify the bot alias.
- Returns:
- The identifier of the bot version associated with this request. If you specify the bot version, you can't specify the bot alias.
-
localeId
public final String localeId()
The identifier of the language and locale where the utterances were collected. For more information, see Supported languages.
- Returns:
- The identifier of the language and locale where the utterances were collected. For more information, see Supported languages.
-
aggregationDuration
public final UtteranceAggregationDuration aggregationDuration()
The time window for aggregating the utterance information. You can specify a time between one hour and two weeks.
- Returns:
- The time window for aggregating the utterance information. You can specify a time between one hour and two weeks.
-
sortBy
public final AggregatedUtterancesSortBy sortBy()
Specifies sorting parameters for the list of utterances. You can sort by the hit count, the missed count, or the number of distinct sessions the utterance appeared in.
- Returns:
- Specifies sorting parameters for the list of utterances. You can sort by the hit count, the missed count, or the number of distinct sessions the utterance appeared in.
-
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
public final List<AggregatedUtterancesFilter> filters()
Provides the specification of a filter used to limit the utterances in the response to only those that match the filter specification. You can only specify one filter and one string 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 of a filter used to limit the utterances in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.
-
maxResults
public final Integer maxResults()
The maximum number of utterances to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned. If you don't specify the
maxResultsparameter, 1,000 results are returned.- Returns:
- The maximum number of utterances to return in each page of results. If there are fewer results than the
maximum page size, only the actual number of results are returned. If you don't specify the
maxResultsparameter, 1,000 results are returned.
-
nextToken
public final String nextToken()
If the response from the
ListAggregatedUtterancesoperation contains more results that specified in themaxResultsparameter, a token is returned in the response. Use that token in thenextTokenparameter to return the next page of results.- Returns:
- If the response from the
ListAggregatedUtterancesoperation contains more results that specified in themaxResultsparameter, a token is returned in the response. Use that token in thenextTokenparameter to return the next page of results.
-
toBuilder
public ListAggregatedUtterancesRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ListAggregatedUtterancesRequest.Builder,ListAggregatedUtterancesRequest>- Specified by:
toBuilderin classLexModelsV2Request
-
builder
public static ListAggregatedUtterancesRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends ListAggregatedUtterancesRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-