/* * Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.connect.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; /** *
* Gets historical metric data from the specified Amazon Connect instance. *
** For a description of each historical metric, see Historical Metrics Definitions in the Amazon Connect Administrator * Guide. *
*/ public class GetMetricDataRequest extends AmazonWebServiceRequest implements Serializable { /** ** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the * instance. *
*
* Constraints:
* Length: 1 - 100
*/
private String instanceId;
/**
*
* 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. *
*/ private java.util.Date startTime; /** ** 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. *
*/ private java.util.Date endTime; /** ** 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. VOICE, CHAT, and TASK channels * are supported. *
*
* To filter by Queues
, enter the queue ID/ARN, not the name of
* the queue.
*
* 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. *
** If no grouping is specified, a summary of metrics for all queues is * returned. *
*/ private java.util.List* The metrics to retrieve. Specify the name, unit, and statistic for each * metric. The following historical metrics are available. For a description * of each metric, see Historical Metrics Definitions in the Amazon Connect * Administrator Guide. *
** This API does not support a contacts incoming metric (there's no * CONTACTS_INCOMING metric missing from the documented list). *
** 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 *
** You can include up to 20 SERVICE_LEVEL metrics in a request. *
** Unit: PERCENT *
** Statistic: AVG *
*
* Threshold: For ThresholdValue
, enter any whole number from 1
* to 604800 (inclusive), in seconds. For Comparison
, you must
* enter LT
(for "Less than").
*
* 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. *
*/ private String nextToken; /** ** The maximum number of results to return per page. *
*
* Constraints:
* Range: 1 - 100
*/
private Integer maxResults;
/**
*
* The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the * instance. *
*
* Constraints:
* Length: 1 - 100
*
* @return
* The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of * the instance. *
*/ public String getInstanceId() { return instanceId; } /** ** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the * instance. *
*
* Constraints:
* Length: 1 - 100
*
* @param instanceId
* The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of * the instance. *
*/ public void setInstanceId(String instanceId) { this.instanceId = instanceId; } /** ** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the * instance. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: 1 - 100
*
* @param instanceId
* The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of * the instance. *
* @return A reference to this updated object so that method calls can be * chained together. */ public GetMetricDataRequest withInstanceId(String instanceId) { this.instanceId = instanceId; return this; } /** ** 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. *
* * @return* 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 java.util.Date getStartTime() { return 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. *
* * @param 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 setStartTime(java.util.Date startTime) { this.startTime = 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. *
** Returns a reference to this object so that method calls can be chained * together. * * @param 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. *
* @return A reference to this updated object so that method calls can be * chained together. */ public GetMetricDataRequest withStartTime(java.util.Date startTime) { this.startTime = startTime; return this; } /** ** 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. *
* * @return* 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 java.util.Date getEndTime() { return 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. *
* * @param 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 setEndTime(java.util.Date endTime) { this.endTime = 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. *
** Returns a reference to this object so that method calls can be chained * together. * * @param 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. *
* @return A reference to this updated object so that method calls can be * chained together. */ public GetMetricDataRequest withEndTime(java.util.Date endTime) { this.endTime = endTime; return this; } /** ** 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. VOICE, CHAT, and TASK channels * are supported. *
*
* To filter by Queues
, enter the queue ID/ARN, not the name of
* the queue.
*
* 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. VOICE, CHAT, and TASK channels are supported. *
*
* To filter by Queues
, enter the queue ID/ARN, not the
* name of the queue.
*
* 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. VOICE, CHAT, and TASK channels * are supported. *
*
* To filter by Queues
, enter the queue ID/ARN, not the name of
* the queue.
*
* 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. VOICE, CHAT, and TASK channels are * supported. *
*
* To filter by Queues
, enter the queue ID/ARN, not
* the name of the queue.
*
* 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. VOICE, CHAT, and TASK channels * are supported. *
*
* To filter by Queues
, enter the queue ID/ARN, not the name of
* the queue.
*
* Returns a reference to this object so that method calls can be chained * together. * * @param 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. VOICE, CHAT, and TASK channels are * supported. *
*
* To filter by Queues
, enter the queue ID/ARN, not
* the name of the queue.
*
* 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. *
** If no grouping is specified, a summary of metrics for all queues is * returned. *
* * @return* 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. *
** If no grouping is specified, a summary of metrics for all queues * is returned. *
*/ public java.util.List* 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. *
** If no grouping is specified, a summary of metrics for all queues is * returned. *
* * @param 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. *
** If no grouping is specified, a summary of metrics for all * queues is returned. *
*/ public void setGroupings(java.util.Collection* 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. *
** If no grouping is specified, a summary of metrics for all queues is * returned. *
** Returns a reference to this object so that method calls can be chained * together. * * @param 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. *
** If no grouping is specified, a summary of metrics for all * queues is returned. *
* @return A reference to this updated object so that method calls can be * chained together. */ public GetMetricDataRequest withGroupings(String... groupings) { if (getGroupings() == null) { this.groupings = new java.util.ArrayList* 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. *
** If no grouping is specified, a summary of metrics for all queues is * returned. *
** Returns a reference to this object so that method calls can be chained * together. * * @param 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. *
** If no grouping is specified, a summary of metrics for all * queues is returned. *
* @return A reference to this updated object so that method calls can be * chained together. */ public GetMetricDataRequest withGroupings(java.util.Collection* The metrics to retrieve. Specify the name, unit, and statistic for each * metric. The following historical metrics are available. For a description * of each metric, see Historical Metrics Definitions in the Amazon Connect * Administrator Guide. *
** This API does not support a contacts incoming metric (there's no * CONTACTS_INCOMING metric missing from the documented list). *
** 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 *
** You can include up to 20 SERVICE_LEVEL metrics in a request. *
** Unit: PERCENT *
** Statistic: AVG *
*
* Threshold: For ThresholdValue
, enter any whole number from 1
* to 604800 (inclusive), in seconds. For Comparison
, you must
* enter LT
(for "Less than").
*
* The metrics to retrieve. Specify the name, unit, and statistic * for each metric. The following historical metrics are available. * For a description of each metric, see Historical Metrics Definitions in the Amazon Connect * Administrator Guide. *
** This API does not support a contacts incoming metric (there's no * CONTACTS_INCOMING metric missing from the documented list). *
** 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 *
** You can include up to 20 SERVICE_LEVEL metrics in a request. *
** Unit: PERCENT *
** Statistic: AVG *
*
* Threshold: For ThresholdValue
, enter any whole
* number from 1 to 604800 (inclusive), in seconds. For
* Comparison
, you must enter LT
(for
* "Less than").
*
* The metrics to retrieve. Specify the name, unit, and statistic for each * metric. The following historical metrics are available. For a description * of each metric, see Historical Metrics Definitions in the Amazon Connect * Administrator Guide. *
** This API does not support a contacts incoming metric (there's no * CONTACTS_INCOMING metric missing from the documented list). *
** 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 *
** You can include up to 20 SERVICE_LEVEL metrics in a request. *
** Unit: PERCENT *
** Statistic: AVG *
*
* Threshold: For ThresholdValue
, enter any whole number from 1
* to 604800 (inclusive), in seconds. For Comparison
, you must
* enter LT
(for "Less than").
*
* The metrics to retrieve. Specify the name, unit, and statistic * for each metric. The following historical metrics are * available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect * Administrator Guide. *
** This API does not support a contacts incoming metric (there's * no CONTACTS_INCOMING metric missing from the documented list). *
** 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 *
** You can include up to 20 SERVICE_LEVEL metrics in a request. *
** Unit: PERCENT *
** Statistic: AVG *
*
* Threshold: For ThresholdValue
, enter any whole
* number from 1 to 604800 (inclusive), in seconds. For
* Comparison
, you must enter LT
(for
* "Less than").
*
* The metrics to retrieve. Specify the name, unit, and statistic for each * metric. The following historical metrics are available. For a description * of each metric, see Historical Metrics Definitions in the Amazon Connect * Administrator Guide. *
** This API does not support a contacts incoming metric (there's no * CONTACTS_INCOMING metric missing from the documented list). *
** 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 *
** You can include up to 20 SERVICE_LEVEL metrics in a request. *
** Unit: PERCENT *
** Statistic: AVG *
*
* Threshold: For ThresholdValue
, enter any whole number from 1
* to 604800 (inclusive), in seconds. For Comparison
, you must
* enter LT
(for "Less than").
*
* Returns a reference to this object so that method calls can be chained * together. * * @param historicalMetrics
* The metrics to retrieve. Specify the name, unit, and statistic * for each metric. The following historical metrics are * available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect * Administrator Guide. *
** This API does not support a contacts incoming metric (there's * no CONTACTS_INCOMING metric missing from the documented list). *
** 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 *
** You can include up to 20 SERVICE_LEVEL metrics in a request. *
** Unit: PERCENT *
** Statistic: AVG *
*
* Threshold: For ThresholdValue
, enter any whole
* number from 1 to 604800 (inclusive), in seconds. For
* Comparison
, you must enter LT
(for
* "Less than").
*
* The metrics to retrieve. Specify the name, unit, and statistic for each * metric. The following historical metrics are available. For a description * of each metric, see Historical Metrics Definitions in the Amazon Connect * Administrator Guide. *
** This API does not support a contacts incoming metric (there's no * CONTACTS_INCOMING metric missing from the documented list). *
** 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 *
** You can include up to 20 SERVICE_LEVEL metrics in a request. *
** Unit: PERCENT *
** Statistic: AVG *
*
* Threshold: For ThresholdValue
, enter any whole number from 1
* to 604800 (inclusive), in seconds. For Comparison
, you must
* enter LT
(for "Less than").
*
* Returns a reference to this object so that method calls can be chained * together. * * @param historicalMetrics
* The metrics to retrieve. Specify the name, unit, and statistic * for each metric. The following historical metrics are * available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect * Administrator Guide. *
** This API does not support a contacts incoming metric (there's * no CONTACTS_INCOMING metric missing from the documented list). *
** 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 *
** You can include up to 20 SERVICE_LEVEL metrics in a request. *
** Unit: PERCENT *
** Statistic: AVG *
*
* Threshold: For ThresholdValue
, enter any whole
* number from 1 to 604800 (inclusive), in seconds. For
* Comparison
, you must enter LT
(for
* "Less than").
*
* 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. *
* * @return* 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() { return 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. *
* * @param 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 setNextToken(String nextToken) { this.nextToken = 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. *
** Returns a reference to this object so that method calls can be chained * together. * * @param 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. *
* @return A reference to this updated object so that method calls can be * chained together. */ public GetMetricDataRequest withNextToken(String nextToken) { this.nextToken = nextToken; return this; } /** ** The maximum number of results to return per page. *
*
* Constraints:
* Range: 1 - 100
*
* @return
* The maximum number of results to return per page. *
*/ public Integer getMaxResults() { return maxResults; } /** ** The maximum number of results to return per page. *
*
* Constraints:
* Range: 1 - 100
*
* @param maxResults
* The maximum number of results to return per page. *
*/ public void setMaxResults(Integer maxResults) { this.maxResults = maxResults; } /** ** The maximum number of results to return per page. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Range: 1 - 100
*
* @param maxResults
* The maximum number of results to return per page. *
* @return A reference to this updated object so that method calls can be * chained together. */ public GetMetricDataRequest withMaxResults(Integer maxResults) { this.maxResults = maxResults; return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getInstanceId() != null) sb.append("InstanceId: " + getInstanceId() + ","); if (getStartTime() != null) sb.append("StartTime: " + getStartTime() + ","); if (getEndTime() != null) sb.append("EndTime: " + getEndTime() + ","); if (getFilters() != null) sb.append("Filters: " + getFilters() + ","); if (getGroupings() != null) sb.append("Groupings: " + getGroupings() + ","); if (getHistoricalMetrics() != null) sb.append("HistoricalMetrics: " + getHistoricalMetrics() + ","); if (getNextToken() != null) sb.append("NextToken: " + getNextToken() + ","); if (getMaxResults() != null) sb.append("MaxResults: " + getMaxResults()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getInstanceId() == null) ? 0 : getInstanceId().hashCode()); hashCode = prime * hashCode + ((getStartTime() == null) ? 0 : getStartTime().hashCode()); hashCode = prime * hashCode + ((getEndTime() == null) ? 0 : getEndTime().hashCode()); hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode()); hashCode = prime * hashCode + ((getGroupings() == null) ? 0 : getGroupings().hashCode()); hashCode = prime * hashCode + ((getHistoricalMetrics() == null) ? 0 : getHistoricalMetrics().hashCode()); hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode()); hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof GetMetricDataRequest == false) return false; GetMetricDataRequest other = (GetMetricDataRequest) obj; if (other.getInstanceId() == null ^ this.getInstanceId() == null) return false; if (other.getInstanceId() != null && other.getInstanceId().equals(this.getInstanceId()) == false) return false; if (other.getStartTime() == null ^ this.getStartTime() == null) return false; if (other.getStartTime() != null && other.getStartTime().equals(this.getStartTime()) == false) return false; if (other.getEndTime() == null ^ this.getEndTime() == null) return false; if (other.getEndTime() != null && other.getEndTime().equals(this.getEndTime()) == false) return false; if (other.getFilters() == null ^ this.getFilters() == null) return false; if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == false) return false; if (other.getGroupings() == null ^ this.getGroupings() == null) return false; if (other.getGroupings() != null && other.getGroupings().equals(this.getGroupings()) == false) return false; if (other.getHistoricalMetrics() == null ^ this.getHistoricalMetrics() == null) return false; if (other.getHistoricalMetrics() != null && other.getHistoricalMetrics().equals(this.getHistoricalMetrics()) == false) return false; if (other.getNextToken() == null ^ this.getNextToken() == null) return false; if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false) return false; if (other.getMaxResults() == null ^ this.getMaxResults() == null) return false; if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false) return false; return true; } }