Interface ListSessionAnalyticsDataRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<ListSessionAnalyticsDataRequest.Builder,ListSessionAnalyticsDataRequest>,LexModelsV2Request.Builder,SdkBuilder<ListSessionAnalyticsDataRequest.Builder,ListSessionAnalyticsDataRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- ListSessionAnalyticsDataRequest
public static interface ListSessionAnalyticsDataRequest.Builder extends LexModelsV2Request.Builder, SdkPojo, CopyableBuilder<ListSessionAnalyticsDataRequest.Builder,ListSessionAnalyticsDataRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description ListSessionAnalyticsDataRequest.BuilderbotId(String botId)The identifier for the bot for which you want to retrieve session analytics.ListSessionAnalyticsDataRequest.BuilderendDateTime(Instant endDateTime)The date and time that marks the end of the range of time for which you want to see session analytics.ListSessionAnalyticsDataRequest.Builderfilters(Collection<AnalyticsSessionFilter> filters)A list of objects, each of which describes a condition by which you want to filter the results.ListSessionAnalyticsDataRequest.Builderfilters(Consumer<AnalyticsSessionFilter.Builder>... filters)A list of objects, each of which describes a condition by which you want to filter the results.ListSessionAnalyticsDataRequest.Builderfilters(AnalyticsSessionFilter... filters)A list of objects, each of which describes a condition by which you want to filter the results.ListSessionAnalyticsDataRequest.BuildermaxResults(Integer maxResults)The maximum number of results to return in each page of results.ListSessionAnalyticsDataRequest.BuildernextToken(String nextToken)If the response from the ListSessionAnalyticsData operation contains more results than specified in the maxResults parameter, a token is returned in the response.ListSessionAnalyticsDataRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)ListSessionAnalyticsDataRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)default ListSessionAnalyticsDataRequest.BuildersortBy(Consumer<SessionDataSortBy.Builder> sortBy)An object specifying the measure and method by which to sort the session analytics data.ListSessionAnalyticsDataRequest.BuildersortBy(SessionDataSortBy sortBy)An object specifying the measure and method by which to sort the session analytics data.ListSessionAnalyticsDataRequest.BuilderstartDateTime(Instant startDateTime)The date and time that marks the beginning of the range of time for which you want to see session analytics.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.lexmodelsv2.model.LexModelsV2Request.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
botId
ListSessionAnalyticsDataRequest.Builder botId(String botId)
The identifier for the bot for which you want to retrieve session analytics.
- Parameters:
botId- The identifier for the bot for which you want to retrieve session analytics.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
startDateTime
ListSessionAnalyticsDataRequest.Builder startDateTime(Instant startDateTime)
The date and time that marks the beginning of the range of time for which you want to see session analytics.
- Parameters:
startDateTime- The date and time that marks the beginning of the range of time for which you want to see session analytics.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
endDateTime
ListSessionAnalyticsDataRequest.Builder endDateTime(Instant endDateTime)
The date and time that marks the end of the range of time for which you want to see session analytics.
- Parameters:
endDateTime- The date and time that marks the end of the range of time for which you want to see session analytics.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sortBy
ListSessionAnalyticsDataRequest.Builder sortBy(SessionDataSortBy sortBy)
An object specifying the measure and method by which to sort the session analytics data.
- Parameters:
sortBy- An object specifying the measure and method by which to sort the session analytics data.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sortBy
default ListSessionAnalyticsDataRequest.Builder sortBy(Consumer<SessionDataSortBy.Builder> sortBy)
An object specifying the measure and method by which to sort the session analytics data.
This is a convenience method that creates an instance of theSessionDataSortBy.Builderavoiding the need to create one manually viaSessionDataSortBy.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tosortBy(SessionDataSortBy).- Parameters:
sortBy- a consumer that will call methods onSessionDataSortBy.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
sortBy(SessionDataSortBy)
-
filters
ListSessionAnalyticsDataRequest.Builder filters(Collection<AnalyticsSessionFilter> filters)
A list of objects, each of which describes a condition by which you want to filter the results.
- Parameters:
filters- A list of objects, each of which describes a condition by which you want to filter the results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
ListSessionAnalyticsDataRequest.Builder filters(AnalyticsSessionFilter... filters)
A list of objects, each of which describes a condition by which you want to filter the results.
- Parameters:
filters- A list of objects, each of which describes a condition by which you want to filter the results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
ListSessionAnalyticsDataRequest.Builder filters(Consumer<AnalyticsSessionFilter.Builder>... filters)
A list of objects, each of which describes a condition by which you want to filter the results.
This is a convenience method that creates an instance of theAnalyticsSessionFilter.Builderavoiding the need to create one manually viaAnalyticsSessionFilter.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#filters(List.) - Parameters:
filters- a consumer that will call methods onAnalyticsSessionFilter.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#filters(java.util.Collection)
-
maxResults
ListSessionAnalyticsDataRequest.Builder maxResults(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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
ListSessionAnalyticsDataRequest.Builder nextToken(String nextToken)
If the response from the ListSessionAnalyticsData 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 ListSessionAnalyticsData request to return the next page of results. For a complete set of results, call the ListSessionAnalyticsData operation until the nextToken returned in the response is null.
- Parameters:
nextToken- If the response from the ListSessionAnalyticsData 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 ListSessionAnalyticsData request to return the next page of results. For a complete set of results, call the ListSessionAnalyticsData operation until the nextToken returned in the response is null.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
ListSessionAnalyticsDataRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
ListSessionAnalyticsDataRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-