Class ListUtteranceAnalyticsDataRequest
- 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.ListUtteranceAnalyticsDataRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<ListUtteranceAnalyticsDataRequest.Builder,ListUtteranceAnalyticsDataRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListUtteranceAnalyticsDataRequest extends LexModelsV2Request implements ToCopyableBuilder<ListUtteranceAnalyticsDataRequest.Builder,ListUtteranceAnalyticsDataRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceListUtteranceAnalyticsDataRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringbotId()The identifier for the bot for which you want to retrieve utterance analytics.static ListUtteranceAnalyticsDataRequest.Builderbuilder()InstantendDateTime()The date and time that marks the end of the range of time for which you want to see utterance analytics.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)List<AnalyticsUtteranceFilter>filters()A list of objects, each of which describes a condition by which you want to filter the results.<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()IntegermaxResults()The maximum number of results to return in each page of results.StringnextToken()If the response from the ListUtteranceAnalyticsData operation contains more results than specified in the maxResults parameter, a token is returned in the response.List<SdkField<?>>sdkFields()static Class<? extends ListUtteranceAnalyticsDataRequest.Builder>serializableBuilderClass()UtteranceDataSortBysortBy()An object specifying the measure and method by which to sort the utterance analytics data.InstantstartDateTime()The date and time that marks the beginning of the range of time for which you want to see utterance analytics.ListUtteranceAnalyticsDataRequest.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 identifier for the bot for which you want to retrieve utterance analytics.
- Returns:
- The identifier for the bot for which you want to retrieve utterance analytics.
-
startDateTime
public final Instant startDateTime()
The date and time that marks the beginning of the range of time for which you want to see utterance analytics.
- Returns:
- The date and time that marks the beginning of the range of time for which you want to see utterance analytics.
-
endDateTime
public final Instant endDateTime()
The date and time that marks the end of the range of time for which you want to see utterance analytics.
- Returns:
- The date and time that marks the end of the range of time for which you want to see utterance analytics.
-
sortBy
public final UtteranceDataSortBy sortBy()
An object specifying the measure and method by which to sort the utterance analytics data.
- Returns:
- An object specifying the measure and method by which to sort the utterance analytics data.
-
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<AnalyticsUtteranceFilter> filters()
A list of objects, each of which describes a condition by which you want to filter the results.
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:
- A list of objects, each of which describes a condition by which you want to filter the results.
-
maxResults
public final Integer maxResults()
The maximum number of results 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.
- Returns:
- The maximum number of results 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.
-
nextToken
public final String nextToken()
If the response from the ListUtteranceAnalyticsData operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListUtteranceAnalyticsData request to return the next page of results. For a complete set of results, call the ListUtteranceAnalyticsData operation until the nextToken returned in the response is null.
- Returns:
- If the response from the ListUtteranceAnalyticsData operation contains more results than specified in the
maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListUtteranceAnalyticsData request to return the next page of results. For a complete set of results, call the ListUtteranceAnalyticsData operation until the nextToken returned in the response is null.
-
toBuilder
public ListUtteranceAnalyticsDataRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ListUtteranceAnalyticsDataRequest.Builder,ListUtteranceAnalyticsDataRequest>- Specified by:
toBuilderin classLexModelsV2Request
-
builder
public static ListUtteranceAnalyticsDataRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends ListUtteranceAnalyticsDataRequest.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
-
-