@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ListIntentStageMetricsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
ListIntentStageMetricsRequest() |
Modifier and Type | Method and Description |
---|---|
ListIntentStageMetricsRequest |
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 intent stage metrics.
|
Date |
getEndDateTime()
The date and time that marks the end of the range of time for which you want to see intent stage metrics.
|
List<AnalyticsIntentStageFilter> |
getFilters()
A list of objects, each of which describes a condition by which you want to filter the results.
|
List<AnalyticsIntentStageGroupBySpecification> |
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<AnalyticsIntentStageMetric> |
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 ListIntentStageMetrics 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 intent stage 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 intent stage metrics.
|
void |
setEndDateTime(Date endDateTime)
The date and time that marks the end of the range of time for which you want to see intent stage metrics.
|
void |
setFilters(Collection<AnalyticsIntentStageFilter> filters)
A list of objects, each of which describes a condition by which you want to filter the results.
|
void |
setGroupBy(Collection<AnalyticsIntentStageGroupBySpecification> 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<AnalyticsIntentStageMetric> 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 ListIntentStageMetrics 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 intent stage metrics.
|
String |
toString()
Returns a string representation of this object.
|
ListIntentStageMetricsRequest |
withBinBy(AnalyticsBinBySpecification... binBy)
A list of objects, each of which contains specifications for organizing the results by time.
|
ListIntentStageMetricsRequest |
withBinBy(Collection<AnalyticsBinBySpecification> binBy)
A list of objects, each of which contains specifications for organizing the results by time.
|
ListIntentStageMetricsRequest |
withBotId(String botId)
The identifier for the bot for which you want to retrieve intent stage metrics.
|
ListIntentStageMetricsRequest |
withEndDateTime(Date endDateTime)
The date and time that marks the end of the range of time for which you want to see intent stage metrics.
|
ListIntentStageMetricsRequest |
withFilters(AnalyticsIntentStageFilter... filters)
A list of objects, each of which describes a condition by which you want to filter the results.
|
ListIntentStageMetricsRequest |
withFilters(Collection<AnalyticsIntentStageFilter> filters)
A list of objects, each of which describes a condition by which you want to filter the results.
|
ListIntentStageMetricsRequest |
withGroupBy(AnalyticsIntentStageGroupBySpecification... groupBy)
A list of objects, each of which specifies how to group the results.
|
ListIntentStageMetricsRequest |
withGroupBy(Collection<AnalyticsIntentStageGroupBySpecification> groupBy)
A list of objects, each of which specifies how to group the results.
|
ListIntentStageMetricsRequest |
withMaxResults(Integer maxResults)
The maximum number of results to return in each page of results.
|
ListIntentStageMetricsRequest |
withMetrics(AnalyticsIntentStageMetric... 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.
|
ListIntentStageMetricsRequest |
withMetrics(Collection<AnalyticsIntentStageMetric> 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.
|
ListIntentStageMetricsRequest |
withNextToken(String nextToken)
If the response from the ListIntentStageMetrics operation contains more results than specified in the maxResults
parameter, a token is returned in the response.
|
ListIntentStageMetricsRequest |
withStartDateTime(Date startDateTime)
The date and time that marks the beginning of the range of time for which you want to see intent stage metrics.
|
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
public void setBotId(String botId)
The identifier for the bot for which you want to retrieve intent stage metrics.
botId
- The identifier for the bot for which you want to retrieve intent stage metrics.public String getBotId()
The identifier for the bot for which you want to retrieve intent stage metrics.
public ListIntentStageMetricsRequest withBotId(String botId)
The identifier for the bot for which you want to retrieve intent stage metrics.
botId
- The identifier for the bot for which you want to retrieve intent stage metrics.public void setStartDateTime(Date startDateTime)
The date and time that marks the beginning of the range of time for which you want to see intent stage metrics.
startDateTime
- The date and time that marks the beginning of the range of time for which you want to see intent stage
metrics.public Date getStartDateTime()
The date and time that marks the beginning of the range of time for which you want to see intent stage metrics.
public ListIntentStageMetricsRequest withStartDateTime(Date startDateTime)
The date and time that marks the beginning of the range of time for which you want to see intent stage metrics.
startDateTime
- The date and time that marks the beginning of the range of time for which you want to see intent stage
metrics.public void setEndDateTime(Date endDateTime)
The date and time that marks the end of the range of time for which you want to see intent stage metrics.
endDateTime
- The date and time that marks the end of the range of time for which you want to see intent stage metrics.public Date getEndDateTime()
The date and time that marks the end of the range of time for which you want to see intent stage metrics.
public ListIntentStageMetricsRequest withEndDateTime(Date endDateTime)
The date and time that marks the end of the range of time for which you want to see intent stage metrics.
endDateTime
- The date and time that marks the end of the range of time for which you want to see intent stage metrics.public List<AnalyticsIntentStageMetric> 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.
public void setMetrics(Collection<AnalyticsIntentStageMetric> 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.
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.public ListIntentStageMetricsRequest withMetrics(AnalyticsIntentStageMetric... 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.
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.public ListIntentStageMetricsRequest withMetrics(Collection<AnalyticsIntentStageMetric> 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.
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.public List<AnalyticsBinBySpecification> getBinBy()
A list of objects, each of which contains specifications for organizing the results by time.
public void setBinBy(Collection<AnalyticsBinBySpecification> binBy)
A list of objects, each of which contains specifications for organizing the results by time.
binBy
- A list of objects, each of which contains specifications for organizing the results by time.public ListIntentStageMetricsRequest 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.
binBy
- A list of objects, each of which contains specifications for organizing the results by time.public ListIntentStageMetricsRequest withBinBy(Collection<AnalyticsBinBySpecification> binBy)
A list of objects, each of which contains specifications for organizing the results by time.
binBy
- A list of objects, each of which contains specifications for organizing the results by time.public List<AnalyticsIntentStageGroupBySpecification> getGroupBy()
A list of objects, each of which specifies how to group the results. You can group by the following criteria:
IntentStageName
– The name of the intent stage.
SwitchedToIntent
– The intent to which the conversation was switched (if any).
IntentStageName
– The name of the intent stage.
SwitchedToIntent
– The intent to which the conversation was switched (if any).
public void setGroupBy(Collection<AnalyticsIntentStageGroupBySpecification> groupBy)
A list of objects, each of which specifies how to group the results. You can group by the following criteria:
IntentStageName
– The name of the intent stage.
SwitchedToIntent
– The intent to which the conversation was switched (if any).
groupBy
- A list of objects, each of which specifies how to group the results. You can group by the following
criteria:
IntentStageName
– The name of the intent stage.
SwitchedToIntent
– The intent to which the conversation was switched (if any).
public ListIntentStageMetricsRequest withGroupBy(AnalyticsIntentStageGroupBySpecification... groupBy)
A list of objects, each of which specifies how to group the results. You can group by the following criteria:
IntentStageName
– The name of the intent stage.
SwitchedToIntent
– The intent to which the conversation was switched (if any).
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.
groupBy
- A list of objects, each of which specifies how to group the results. You can group by the following
criteria:
IntentStageName
– The name of the intent stage.
SwitchedToIntent
– The intent to which the conversation was switched (if any).
public ListIntentStageMetricsRequest withGroupBy(Collection<AnalyticsIntentStageGroupBySpecification> groupBy)
A list of objects, each of which specifies how to group the results. You can group by the following criteria:
IntentStageName
– The name of the intent stage.
SwitchedToIntent
– The intent to which the conversation was switched (if any).
groupBy
- A list of objects, each of which specifies how to group the results. You can group by the following
criteria:
IntentStageName
– The name of the intent stage.
SwitchedToIntent
– The intent to which the conversation was switched (if any).
public List<AnalyticsIntentStageFilter> getFilters()
A list of objects, each of which describes a condition by which you want to filter the results.
public void setFilters(Collection<AnalyticsIntentStageFilter> filters)
A list of objects, each of which describes a condition by which you want to filter the results.
filters
- A list of objects, each of which describes a condition by which you want to filter the results.public ListIntentStageMetricsRequest withFilters(AnalyticsIntentStageFilter... 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.
filters
- A list of objects, each of which describes a condition by which you want to filter the results.public ListIntentStageMetricsRequest withFilters(Collection<AnalyticsIntentStageFilter> filters)
A list of objects, each of which describes a condition by which you want to filter the results.
filters
- A list of objects, each of which describes a condition by which you want to filter the results.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.
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.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.
public ListIntentStageMetricsRequest 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.
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.public void setNextToken(String nextToken)
If the response from the ListIntentStageMetrics 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 ListIntentStageMetrics request to return the next page of results. For a complete set of results, call the ListIntentStageMetrics operation until the nextToken returned in the response is null.
nextToken
- If the response from the ListIntentStageMetrics 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 ListIntentStageMetrics request to return the next page of results. For a complete set of results, call the ListIntentStageMetrics operation until the nextToken returned in the response is null.
public String getNextToken()
If the response from the ListIntentStageMetrics 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 ListIntentStageMetrics request to return the next page of results. For a complete set of results, call the ListIntentStageMetrics operation until the nextToken returned in the response is null.
Use the returned token in the nextToken parameter of a ListIntentStageMetrics request to return the next page of results. For a complete set of results, call the ListIntentStageMetrics operation until the nextToken returned in the response is null.
public ListIntentStageMetricsRequest withNextToken(String nextToken)
If the response from the ListIntentStageMetrics 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 ListIntentStageMetrics request to return the next page of results. For a complete set of results, call the ListIntentStageMetrics operation until the nextToken returned in the response is null.
nextToken
- If the response from the ListIntentStageMetrics 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 ListIntentStageMetrics request to return the next page of results. For a complete set of results, call the ListIntentStageMetrics operation until the nextToken returned in the response is null.
public String toString()
toString
in class Object
Object.toString()
public ListIntentStageMetricsRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()