@Generated(value="com.amazonaws:awsjavasdkcodegenerator") public class GetMetricDataRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description 

GetMetricDataRequest() 
Modifier and Type  Method and Description 

GetMetricDataRequest 
clone()
Creates a shallow clone of this object for all fields except the handler context.

boolean 
equals(Object obj) 
Date 
getEndTime()
The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical
metrics data.

Filters 
getFilters()
The queues, up to 100, or channels, to use to filter the metrics returned.

List<String> 
getGroupings()
The grouping applied to the metrics returned.

List<HistoricalMetric> 
getHistoricalMetrics()
The metrics to retrieve.

String 
getInstanceId()
The identifier of the Amazon Connect instance.

Integer 
getMaxResults()
The maximimum number of results to return per page.

String 
getNextToken()
The token for the next set of results.

Date 
getStartTime()
The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of
historical metrics data.

int 
hashCode() 
void 
setEndTime(Date endTime)
The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical
metrics data.

void 
setFilters(Filters filters)
The queues, up to 100, or channels, to use to filter the metrics returned.

void 
setGroupings(Collection<String> groupings)
The grouping applied to the metrics returned.

void 
setHistoricalMetrics(Collection<HistoricalMetric> historicalMetrics)
The metrics to retrieve.

void 
setInstanceId(String instanceId)
The identifier of the Amazon Connect instance.

void 
setMaxResults(Integer maxResults)
The maximimum number of results to return per page.

void 
setNextToken(String nextToken)
The token for the next set of results.

void 
setStartTime(Date startTime)
The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of
historical metrics data.

String 
toString()
Returns a string representation of this object.

GetMetricDataRequest 
withEndTime(Date endTime)
The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical
metrics data.

GetMetricDataRequest 
withFilters(Filters filters)
The queues, up to 100, or channels, to use to filter the metrics returned.

GetMetricDataRequest 
withGroupings(Collection<String> groupings)
The grouping applied to the metrics returned.

GetMetricDataRequest 
withGroupings(Grouping... groupings)
The grouping applied to the metrics returned.

GetMetricDataRequest 
withGroupings(String... groupings)
The grouping applied to the metrics returned.

GetMetricDataRequest 
withHistoricalMetrics(Collection<HistoricalMetric> historicalMetrics)
The metrics to retrieve.

GetMetricDataRequest 
withHistoricalMetrics(HistoricalMetric... historicalMetrics)
The metrics to retrieve.

GetMetricDataRequest 
withInstanceId(String instanceId)
The identifier of the Amazon Connect instance.

GetMetricDataRequest 
withMaxResults(Integer maxResults)
The maximimum number of results to return per page.

GetMetricDataRequest 
withNextToken(String nextToken)
The token for the next set of results.

GetMetricDataRequest 
withStartTime(Date startTime)
The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of
historical metrics data.

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 setInstanceId(String instanceId)
The identifier of the Amazon Connect instance.
instanceId
 The identifier of the Amazon Connect instance.public String getInstanceId()
The identifier of the Amazon Connect instance.
public GetMetricDataRequest withInstanceId(String instanceId)
The identifier of the Amazon Connect instance.
instanceId
 The identifier of the Amazon Connect instance.public void setStartTime(Date startTime)
The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05, 10:10, 10:15.
The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available only for 24 hours.
startTime
 The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of
historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05, 10:10,
10:15.
The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available only for 24 hours.
public Date getStartTime()
The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05, 10:10, 10:15.
The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available only for 24 hours.
The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available only for 24 hours.
public GetMetricDataRequest withStartTime(Date startTime)
The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05, 10:10, 10:15.
The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available only for 24 hours.
startTime
 The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of
historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05, 10:10,
10:15.
The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available only for 24 hours.
public void setEndTime(Date endTime)
The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be later than the start time timestamp.
The time range between the start and end time must be less than 24 hours.
endTime
 The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of
historical metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05,
11:10, and must be later than the start time timestamp.
The time range between the start and end time must be less than 24 hours.
public Date getEndTime()
The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be later than the start time timestamp.
The time range between the start and end time must be less than 24 hours.
The time range between the start and end time must be less than 24 hours.
public GetMetricDataRequest withEndTime(Date endTime)
The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be later than the start time timestamp.
The time range between the start and end time must be less than 24 hours.
endTime
 The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of
historical metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05,
11:10, and must be later than the start time timestamp.
The time range between the start and end time must be less than 24 hours.
public void setFilters(Filters filters)
The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the
resources associated with the queues or channels included in the filter. You can include both queue IDs and queue
ARNs in the same request. The only supported channel is VOICE
.
filters
 The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only
for the resources associated with the queues or channels included in the filter. You can include both
queue IDs and queue ARNs in the same request. The only supported channel is VOICE
.public Filters getFilters()
The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the
resources associated with the queues or channels included in the filter. You can include both queue IDs and queue
ARNs in the same request. The only supported channel is VOICE
.
VOICE
.public GetMetricDataRequest withFilters(Filters filters)
The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the
resources associated with the queues or channels included in the filter. You can include both queue IDs and queue
ARNs in the same request. The only supported channel is VOICE
.
filters
 The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only
for the resources associated with the queues or channels included in the filter. You can include both
queue IDs and queue ARNs in the same request. The only supported channel is VOICE
.public List<String> getGroupings()
The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.
The only supported grouping is QUEUE
.
If no grouping is specified, a summary of metrics for all queues is returned.
The only supported grouping is QUEUE
.
If no grouping is specified, a summary of metrics for all queues is returned.
Grouping
public void setGroupings(Collection<String> groupings)
The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.
The only supported grouping is QUEUE
.
If no grouping is specified, a summary of metrics for all queues is returned.
groupings
 The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics
returned are grouped by queue. The values returned apply to the metrics for each queue rather than
aggregated for all queues.
The only supported grouping is QUEUE
.
If no grouping is specified, a summary of metrics for all queues is returned.
Grouping
public GetMetricDataRequest withGroupings(String... groupings)
The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.
The only supported grouping is QUEUE
.
If no grouping is specified, a summary of metrics for all queues is returned.
NOTE: This method appends the values to the existing list (if any). Use
setGroupings(java.util.Collection)
or withGroupings(java.util.Collection)
if you want to
override the existing values.
groupings
 The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics
returned are grouped by queue. The values returned apply to the metrics for each queue rather than
aggregated for all queues.
The only supported grouping is QUEUE
.
If no grouping is specified, a summary of metrics for all queues is returned.
Grouping
public GetMetricDataRequest withGroupings(Collection<String> groupings)
The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.
The only supported grouping is QUEUE
.
If no grouping is specified, a summary of metrics for all queues is returned.
groupings
 The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics
returned are grouped by queue. The values returned apply to the metrics for each queue rather than
aggregated for all queues.
The only supported grouping is QUEUE
.
If no grouping is specified, a summary of metrics for all queues is returned.
Grouping
public GetMetricDataRequest withGroupings(Grouping... groupings)
The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.
The only supported grouping is QUEUE
.
If no grouping is specified, a summary of metrics for all queues is returned.
groupings
 The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics
returned are grouped by queue. The values returned apply to the metrics for each queue rather than
aggregated for all queues.
The only supported grouping is QUEUE
.
If no grouping is specified, a summary of metrics for all queues is returned.
Grouping
public List<HistoricalMetric> getHistoricalMetrics()
The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available:
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: PERCENT
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: MAX
Unit: PERCENT
Statistic: AVG
Threshold: Only "Less than" comparisons are supported, with the following service level thresholds: 15, 20, 25, 30, 45, 60, 90, 120, 180, 240, 300, 600
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: PERCENT
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: MAX
Unit: PERCENT
Statistic: AVG
Threshold: Only "Less than" comparisons are supported, with the following service level thresholds: 15, 20, 25, 30, 45, 60, 90, 120, 180, 240, 300, 600
public void setHistoricalMetrics(Collection<HistoricalMetric> historicalMetrics)
The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available:
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: PERCENT
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: MAX
Unit: PERCENT
Statistic: AVG
Threshold: Only "Less than" comparisons are supported, with the following service level thresholds: 15, 20, 25, 30, 45, 60, 90, 120, 180, 240, 300, 600
historicalMetrics
 The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical
metrics are available:
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: PERCENT
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: MAX
Unit: PERCENT
Statistic: AVG
Threshold: Only "Less than" comparisons are supported, with the following service level thresholds: 15, 20, 25, 30, 45, 60, 90, 120, 180, 240, 300, 600
public GetMetricDataRequest withHistoricalMetrics(HistoricalMetric... historicalMetrics)
The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available:
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: PERCENT
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: MAX
Unit: PERCENT
Statistic: AVG
Threshold: Only "Less than" comparisons are supported, with the following service level thresholds: 15, 20, 25, 30, 45, 60, 90, 120, 180, 240, 300, 600
NOTE: This method appends the values to the existing list (if any). Use
setHistoricalMetrics(java.util.Collection)
or withHistoricalMetrics(java.util.Collection)
if
you want to override the existing values.
historicalMetrics
 The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical
metrics are available:
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: PERCENT
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: MAX
Unit: PERCENT
Statistic: AVG
Threshold: Only "Less than" comparisons are supported, with the following service level thresholds: 15, 20, 25, 30, 45, 60, 90, 120, 180, 240, 300, 600
public GetMetricDataRequest withHistoricalMetrics(Collection<HistoricalMetric> historicalMetrics)
The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available:
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: PERCENT
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: MAX
Unit: PERCENT
Statistic: AVG
Threshold: Only "Less than" comparisons are supported, with the following service level thresholds: 15, 20, 25, 30, 45, 60, 90, 120, 180, 240, 300, 600
historicalMetrics
 The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical
metrics are available:
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: PERCENT
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: MAX
Unit: PERCENT
Statistic: AVG
Threshold: Only "Less than" comparisons are supported, with the following service level thresholds: 15, 20, 25, 30, 45, 60, 90, 120, 180, 240, 300, 600
public void setNextToken(String nextToken)
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
nextToken
 The token for the next set of results. Use the value returned in the previous response in the next request
to retrieve the next set of results.public String getNextToken()
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
public GetMetricDataRequest withNextToken(String nextToken)
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
nextToken
 The token for the next set of results. Use the value returned in the previous response in the next request
to retrieve the next set of results.public void setMaxResults(Integer maxResults)
The maximimum number of results to return per page.
maxResults
 The maximimum number of results to return per page.public Integer getMaxResults()
The maximimum number of results to return per page.
public GetMetricDataRequest withMaxResults(Integer maxResults)
The maximimum number of results to return per page.
maxResults
 The maximimum number of results to return per page.public String toString()
toString
in class Object
Object.toString()
public GetMetricDataRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.