com.amazonaws.services.lexmodelsv2.model

Class ListSessionMetricsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.lexmodelsv2.model.ListSessionMetricsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListSessionMetricsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListSessionMetricsRequest()

Method Summary

Modifier and Type	Method and Description
ListSessionMetricsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<AnalyticsBinBySpecification>	getBinBy() A list of objects, each of which contains specifications for organizing the results by time.
String	getBotId() The identifier for the bot for which you want to retrieve session metrics.
Date	getEndDateTime() The date and time that marks the end of the range of time for which you want to see session metrics.
List<AnalyticsSessionFilter>	getFilters() A list of objects, each of which describes a condition by which you want to filter the results.
List<AnalyticsSessionGroupBySpecification>	getGroupBy() A list of objects, each of which specifies how to group the results.
Integer	getMaxResults() The maximum number of results to return in each page of results.
List<AnalyticsSessionMetric>	getMetrics() A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
String	getNextToken() If the response from the ListSessionMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Date	getStartDateTime() The date and time that marks the beginning of the range of time for which you want to see session metrics.
int	hashCode()
void	setBinBy(Collection<AnalyticsBinBySpecification> binBy) A list of objects, each of which contains specifications for organizing the results by time.
void	setBotId(String botId) The identifier for the bot for which you want to retrieve session metrics.
void	setEndDateTime(Date endDateTime) The date and time that marks the end of the range of time for which you want to see session metrics.
void	setFilters(Collection<AnalyticsSessionFilter> filters) A list of objects, each of which describes a condition by which you want to filter the results.
void	setGroupBy(Collection<AnalyticsSessionGroupBySpecification> groupBy) A list of objects, each of which specifies how to group the results.
void	setMaxResults(Integer maxResults) The maximum number of results to return in each page of results.
void	setMetrics(Collection<AnalyticsSessionMetric> metrics) A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
void	setNextToken(String nextToken) If the response from the ListSessionMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.
void	setStartDateTime(Date startDateTime) The date and time that marks the beginning of the range of time for which you want to see session metrics.
String	toString() Returns a string representation of this object.
ListSessionMetricsRequest	withBinBy(AnalyticsBinBySpecification... binBy) A list of objects, each of which contains specifications for organizing the results by time.
ListSessionMetricsRequest	withBinBy(Collection<AnalyticsBinBySpecification> binBy) A list of objects, each of which contains specifications for organizing the results by time.
ListSessionMetricsRequest	withBotId(String botId) The identifier for the bot for which you want to retrieve session metrics.
ListSessionMetricsRequest	withEndDateTime(Date endDateTime) The date and time that marks the end of the range of time for which you want to see session metrics.
ListSessionMetricsRequest	withFilters(AnalyticsSessionFilter... filters) A list of objects, each of which describes a condition by which you want to filter the results.
ListSessionMetricsRequest	withFilters(Collection<AnalyticsSessionFilter> filters) A list of objects, each of which describes a condition by which you want to filter the results.
ListSessionMetricsRequest	withGroupBy(AnalyticsSessionGroupBySpecification... groupBy) A list of objects, each of which specifies how to group the results.
ListSessionMetricsRequest	withGroupBy(Collection<AnalyticsSessionGroupBySpecification> groupBy) A list of objects, each of which specifies how to group the results.
ListSessionMetricsRequest	withMaxResults(Integer maxResults) The maximum number of results to return in each page of results.
ListSessionMetricsRequest	withMetrics(AnalyticsSessionMetric... metrics) A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
ListSessionMetricsRequest	withMetrics(Collection<AnalyticsSessionMetric> metrics) A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
ListSessionMetricsRequest	withNextToken(String nextToken) If the response from the ListSessionMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.
ListSessionMetricsRequest	withStartDateTime(Date startDateTime) The date and time that marks the beginning of the range of time for which you want to see session metrics.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListSessionMetricsRequest

public ListSessionMetricsRequest()

Method Detail

setBotId

public void setBotId(String botId)

The identifier for the bot for which you want to retrieve session metrics.

Parameters:

botId - The identifier for the bot for which you want to retrieve session metrics.

getBotId

public String getBotId()

The identifier for the bot for which you want to retrieve session metrics.

Returns:

The identifier for the bot for which you want to retrieve session metrics.

withBotId

public ListSessionMetricsRequest withBotId(String botId)

The identifier for the bot for which you want to retrieve session metrics.

Parameters:

botId - The identifier for the bot for which you want to retrieve session metrics.

Returns:

Returns a reference to this object so that method calls can be chained together.

setStartDateTime

public void setStartDateTime(Date startDateTime)

The date and time that marks the beginning of the range of time for which you want to see session metrics.

Parameters:

startDateTime - The date and time that marks the beginning of the range of time for which you want to see session metrics.

getStartDateTime

public Date getStartDateTime()

The date and time that marks the beginning of the range of time for which you want to see session metrics.

Returns:

The date and time that marks the beginning of the range of time for which you want to see session metrics.

withStartDateTime

public ListSessionMetricsRequest withStartDateTime(Date startDateTime)

The date and time that marks the beginning of the range of time for which you want to see session metrics.

Parameters:

startDateTime - The date and time that marks the beginning of the range of time for which you want to see session metrics.

Returns:

Returns a reference to this object so that method calls can be chained together.

setEndDateTime

public void setEndDateTime(Date endDateTime)

The date and time that marks the end of the range of time for which you want to see session metrics.

Parameters:

endDateTime - The date and time that marks the end of the range of time for which you want to see session metrics.

getEndDateTime

public Date getEndDateTime()

The date and time that marks the end of the range of time for which you want to see session metrics.

Returns:

The date and time that marks the end of the range of time for which you want to see session metrics.

withEndDateTime

public ListSessionMetricsRequest withEndDateTime(Date endDateTime)

The date and time that marks the end of the range of time for which you want to see session metrics.

Parameters:

endDateTime - The date and time that marks the end of the range of time for which you want to see session metrics.

Returns:

Returns a reference to this object so that method calls can be chained together.

getMetrics

public List<AnalyticsSessionMetric> getMetrics()

A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.

Returns:

A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.

setMetrics

public void setMetrics(Collection<AnalyticsSessionMetric> metrics)

A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.

Parameters:

metrics - A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.

withMetrics

public ListSessionMetricsRequest withMetrics(AnalyticsSessionMetric... metrics)

A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.

NOTE: This method appends the values to the existing list (if any). Use setMetrics(java.util.Collection) or withMetrics(java.util.Collection) if you want to override the existing values.

Parameters:

metrics - A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.

Returns:

Returns a reference to this object so that method calls can be chained together.

withMetrics

public ListSessionMetricsRequest withMetrics(Collection<AnalyticsSessionMetric> metrics)

A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.

Parameters:

metrics - A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.

Returns:

Returns a reference to this object so that method calls can be chained together.

getBinBy

public List<AnalyticsBinBySpecification> getBinBy()

A list of objects, each of which contains specifications for organizing the results by time.

Returns:

A list of objects, each of which contains specifications for organizing the results by time.

setBinBy

public void setBinBy(Collection<AnalyticsBinBySpecification> binBy)

A list of objects, each of which contains specifications for organizing the results by time.

Parameters:

binBy - A list of objects, each of which contains specifications for organizing the results by time.

withBinBy

public ListSessionMetricsRequest withBinBy(AnalyticsBinBySpecification... binBy)

A list of objects, each of which contains specifications for organizing the results by time.

NOTE: This method appends the values to the existing list (if any). Use setBinBy(java.util.Collection) or withBinBy(java.util.Collection) if you want to override the existing values.

Parameters:

binBy - A list of objects, each of which contains specifications for organizing the results by time.

Returns:

Returns a reference to this object so that method calls can be chained together.

withBinBy

public ListSessionMetricsRequest withBinBy(Collection<AnalyticsBinBySpecification> binBy)

A list of objects, each of which contains specifications for organizing the results by time.

Parameters:

binBy - A list of objects, each of which contains specifications for organizing the results by time.

Returns:

Returns a reference to this object so that method calls can be chained together.

getGroupBy

public List<AnalyticsSessionGroupBySpecification> getGroupBy()

A list of objects, each of which specifies how to group the results. You can group by the following criteria:

• ConversationEndState – The final state of the conversation. The possible end states are detailed in Key definitions in the user guide.

• LocaleId – The unique identifier of the bot locale.

Returns:

A list of objects, each of which specifies how to group the results. You can group by the following criteria:

• ConversationEndState – The final state of the conversation. The possible end states are detailed in Key definitions in the user guide.

• LocaleId – The unique identifier of the bot locale.

setGroupBy

public void setGroupBy(Collection<AnalyticsSessionGroupBySpecification> groupBy)

A list of objects, each of which specifies how to group the results. You can group by the following criteria:

• ConversationEndState – The final state of the conversation. The possible end states are detailed in Key definitions in the user guide.

• LocaleId – The unique identifier of the bot locale.

Parameters:

groupBy - A list of objects, each of which specifies how to group the results. You can group by the following criteria:

• ConversationEndState – The final state of the conversation. The possible end states are detailed in Key definitions in the user guide.

• LocaleId – The unique identifier of the bot locale.

withGroupBy

public ListSessionMetricsRequest withGroupBy(AnalyticsSessionGroupBySpecification... groupBy)

A list of objects, each of which specifies how to group the results. You can group by the following criteria:

• ConversationEndState – The final state of the conversation. The possible end states are detailed in Key definitions in the user guide.

• LocaleId – The unique identifier of the bot locale.

NOTE: This method appends the values to the existing list (if any). Use setGroupBy(java.util.Collection) or withGroupBy(java.util.Collection) if you want to override the existing values.

Parameters:

groupBy - A list of objects, each of which specifies how to group the results. You can group by the following criteria:

• ConversationEndState – The final state of the conversation. The possible end states are detailed in Key definitions in the user guide.

• LocaleId – The unique identifier of the bot locale.

Returns:

Returns a reference to this object so that method calls can be chained together.

withGroupBy

public ListSessionMetricsRequest withGroupBy(Collection<AnalyticsSessionGroupBySpecification> groupBy)

A list of objects, each of which specifies how to group the results. You can group by the following criteria:

• ConversationEndState – The final state of the conversation. The possible end states are detailed in Key definitions in the user guide.

• LocaleId – The unique identifier of the bot locale.

Parameters:

groupBy - A list of objects, each of which specifies how to group the results. You can group by the following criteria:

• ConversationEndState – The final state of the conversation. The possible end states are detailed in Key definitions in the user guide.

• LocaleId – The unique identifier of the bot locale.

Returns:

Returns a reference to this object so that method calls can be chained together.

getFilters

public List<AnalyticsSessionFilter> getFilters()

A list of objects, each of which describes a condition by which you want to filter the results.

Returns:

A list of objects, each of which describes a condition by which you want to filter the results.

setFilters

public void setFilters(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.

withFilters

public ListSessionMetricsRequest withFilters(AnalyticsSessionFilter... filters)

A list of objects, each of which describes a condition by which you want to filter the results.

NOTE: This method appends the values to the existing list (if any). Use setFilters(java.util.Collection) or withFilters(java.util.Collection) if you want to override the existing values.

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.

withFilters

public ListSessionMetricsRequest withFilters(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.

setMaxResults

public void setMaxResults(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.

getMaxResults

public Integer getMaxResults()

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.

withMaxResults

public ListSessionMetricsRequest withMaxResults(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.

setNextToken

public void setNextToken(String nextToken)

If the response from the ListSessionMetrics 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 ListSessionMetrics request to return the next page of results. For a complete set of results, call the ListSessionMetrics operation until the nextToken returned in the response is null.

Parameters:

nextToken - If the response from the ListSessionMetrics 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 ListSessionMetrics request to return the next page of results. For a complete set of results, call the ListSessionMetrics operation until the nextToken returned in the response is null.

getNextToken

public String getNextToken()

If the response from the ListSessionMetrics 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 ListSessionMetrics request to return the next page of results. For a complete set of results, call the ListSessionMetrics operation until the nextToken returned in the response is null.

Returns:

If the response from the ListSessionMetrics 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 ListSessionMetrics request to return the next page of results. For a complete set of results, call the ListSessionMetrics operation until the nextToken returned in the response is null.

withNextToken

public ListSessionMetricsRequest withNextToken(String nextToken)

If the response from the ListSessionMetrics 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 ListSessionMetrics request to return the next page of results. For a complete set of results, call the ListSessionMetrics operation until the nextToken returned in the response is null.

Parameters:

nextToken - If the response from the ListSessionMetrics 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 ListSessionMetrics request to return the next page of results. For a complete set of results, call the ListSessionMetrics 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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ListSessionMetricsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()