public class GetCurrentMetricDataRequest extends AmazonWebServiceRequest implements java.io.Serializable
Gets the real-time metric data from the specified Amazon Connect instance.
For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
Constructor and Description |
---|
GetCurrentMetricDataRequest() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
java.util.List<CurrentMetric> |
getCurrentMetrics()
The metrics to retrieve.
|
Filters |
getFilters()
The queues, up to 100, or channels, to use to filter the metrics
returned.
|
java.util.List<java.lang.String> |
getGroupings()
The grouping applied to the metrics returned.
|
java.lang.String |
getInstanceId()
The identifier of the Amazon Connect instance.
|
java.lang.Integer |
getMaxResults()
The maximimum number of results to return per page.
|
java.lang.String |
getNextToken()
The token for the next set of results.
|
int |
hashCode() |
void |
setCurrentMetrics(java.util.Collection<CurrentMetric> currentMetrics)
The metrics to retrieve.
|
void |
setFilters(Filters filters)
The queues, up to 100, or channels, to use to filter the metrics
returned.
|
void |
setGroupings(java.util.Collection<java.lang.String> groupings)
The grouping applied to the metrics returned.
|
void |
setInstanceId(java.lang.String instanceId)
The identifier of the Amazon Connect instance.
|
void |
setMaxResults(java.lang.Integer maxResults)
The maximimum number of results to return per page.
|
void |
setNextToken(java.lang.String nextToken)
The token for the next set of results.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
GetCurrentMetricDataRequest |
withCurrentMetrics(java.util.Collection<CurrentMetric> currentMetrics)
The metrics to retrieve.
|
GetCurrentMetricDataRequest |
withCurrentMetrics(CurrentMetric... currentMetrics)
The metrics to retrieve.
|
GetCurrentMetricDataRequest |
withFilters(Filters filters)
The queues, up to 100, or channels, to use to filter the metrics
returned.
|
GetCurrentMetricDataRequest |
withGroupings(java.util.Collection<java.lang.String> groupings)
The grouping applied to the metrics returned.
|
GetCurrentMetricDataRequest |
withGroupings(java.lang.String... groupings)
The grouping applied to the metrics returned.
|
GetCurrentMetricDataRequest |
withInstanceId(java.lang.String instanceId)
The identifier of the Amazon Connect instance.
|
GetCurrentMetricDataRequest |
withMaxResults(java.lang.Integer maxResults)
The maximimum number of results to return per page.
|
GetCurrentMetricDataRequest |
withNextToken(java.lang.String nextToken)
The token for the next set of results.
|
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public java.lang.String getInstanceId()
The identifier of the Amazon Connect instance.
Constraints:
Length: 1 - 100
The identifier of the Amazon Connect instance.
public void setInstanceId(java.lang.String instanceId)
The identifier of the Amazon Connect instance.
Constraints:
Length: 1 - 100
instanceId
- The identifier of the Amazon Connect instance.
public GetCurrentMetricDataRequest withInstanceId(java.lang.String instanceId)
The identifier of the Amazon Connect instance.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 100
instanceId
- The identifier of the Amazon Connect instance.
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. VOICE, CHAT, and TASK channels are supported.
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.
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. VOICE, CHAT, and TASK channels are supported.
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.
public GetCurrentMetricDataRequest 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. VOICE, CHAT, and TASK channels are supported.
Returns a reference to this object so that method calls can be chained together.
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.
public java.util.List<java.lang.String> getGroupings()
The grouping applied to the metrics returned. For example, when grouped
by QUEUE
, the metrics returned apply to each queue rather
than aggregated for all queues. If you group by CHANNEL
, you
should include a Channels filter. VOICE, CHAT, and TASK channels are
supported.
If no Grouping
is included in the request, a summary of
metrics is returned.
The grouping applied to the metrics returned. For example, when
grouped by QUEUE
, the metrics returned apply to each
queue rather than aggregated for all queues. If you group by
CHANNEL
, you should include a Channels filter.
VOICE, CHAT, and TASK channels are supported.
If no Grouping
is included in the request, a summary
of metrics is returned.
public void setGroupings(java.util.Collection<java.lang.String> groupings)
The grouping applied to the metrics returned. For example, when grouped
by QUEUE
, the metrics returned apply to each queue rather
than aggregated for all queues. If you group by CHANNEL
, you
should include a Channels filter. VOICE, CHAT, and TASK channels are
supported.
If no Grouping
is included in the request, a summary of
metrics is returned.
groupings
-
The grouping applied to the metrics returned. For example,
when grouped by QUEUE
, the metrics returned apply
to each queue rather than aggregated for all queues. If you
group by CHANNEL
, you should include a Channels
filter. VOICE, CHAT, and TASK channels are supported.
If no Grouping
is included in the request, a
summary of metrics is returned.
public GetCurrentMetricDataRequest withGroupings(java.lang.String... groupings)
The grouping applied to the metrics returned. For example, when grouped
by QUEUE
, the metrics returned apply to each queue rather
than aggregated for all queues. If you group by CHANNEL
, you
should include a Channels filter. VOICE, CHAT, and TASK channels are
supported.
If no Grouping
is included in the request, a summary of
metrics is returned.
Returns a reference to this object so that method calls can be chained together.
groupings
-
The grouping applied to the metrics returned. For example,
when grouped by QUEUE
, the metrics returned apply
to each queue rather than aggregated for all queues. If you
group by CHANNEL
, you should include a Channels
filter. VOICE, CHAT, and TASK channels are supported.
If no Grouping
is included in the request, a
summary of metrics is returned.
public GetCurrentMetricDataRequest withGroupings(java.util.Collection<java.lang.String> groupings)
The grouping applied to the metrics returned. For example, when grouped
by QUEUE
, the metrics returned apply to each queue rather
than aggregated for all queues. If you group by CHANNEL
, you
should include a Channels filter. VOICE, CHAT, and TASK channels are
supported.
If no Grouping
is included in the request, a summary of
metrics is returned.
Returns a reference to this object so that method calls can be chained together.
groupings
-
The grouping applied to the metrics returned. For example,
when grouped by QUEUE
, the metrics returned apply
to each queue rather than aggregated for all queues. If you
group by CHANNEL
, you should include a Channels
filter. VOICE, CHAT, and TASK channels are supported.
If no Grouping
is included in the request, a
summary of metrics is returned.
public java.util.List<CurrentMetric> getCurrentMetrics()
The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available. For a description of all the metrics, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
Unit: COUNT
Name in real-time metrics report: ACW
Unit: COUNT
Name in real-time metrics report: Available
Unit: COUNT
Name in real-time metrics report: Error
Unit: COUNT
Name in real-time metrics report: NPT (Non-Productive Time)
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: Online
Unit: COUNT
Name in real-time metrics report: Staffed
Unit: COUNT
Name in real-time metrics report: In queue
Unit: COUNT
Name in real-time metrics report: Scheduled
Unit: SECONDS
When you use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:
{ "Metric": { "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" }, "Value": 24113.0
The actual OLDEST_CONTACT_AGE is 24 seconds.
Name in real-time metrics report: Oldest
Unit: COUNT
Name in real-time metrics report: Active
Unit: COUNT
Name in real-time metrics report: Availability
The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available. For a description of all the metrics, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
Unit: COUNT
Name in real-time metrics report: ACW
Unit: COUNT
Name in real-time metrics report: Available
Unit: COUNT
Name in real-time metrics report: Error
Unit: COUNT
Name in real-time metrics report: NPT (Non-Productive Time)
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: Online
Unit: COUNT
Name in real-time metrics report: Staffed
Unit: COUNT
Name in real-time metrics report: In queue
Unit: COUNT
Name in real-time metrics report: Scheduled
Unit: SECONDS
When you use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:
{ "Metric": { "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" }, "Value": 24113.0
The actual OLDEST_CONTACT_AGE is 24 seconds.
Name in real-time metrics report: Oldest
Unit: COUNT
Name in real-time metrics report: Active
Unit: COUNT
Name in real-time metrics report: Availability
public void setCurrentMetrics(java.util.Collection<CurrentMetric> currentMetrics)
The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available. For a description of all the metrics, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
Unit: COUNT
Name in real-time metrics report: ACW
Unit: COUNT
Name in real-time metrics report: Available
Unit: COUNT
Name in real-time metrics report: Error
Unit: COUNT
Name in real-time metrics report: NPT (Non-Productive Time)
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: Online
Unit: COUNT
Name in real-time metrics report: Staffed
Unit: COUNT
Name in real-time metrics report: In queue
Unit: COUNT
Name in real-time metrics report: Scheduled
Unit: SECONDS
When you use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:
{ "Metric": { "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" }, "Value": 24113.0
The actual OLDEST_CONTACT_AGE is 24 seconds.
Name in real-time metrics report: Oldest
Unit: COUNT
Name in real-time metrics report: Active
Unit: COUNT
Name in real-time metrics report: Availability
currentMetrics
- The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available. For a description of all the metrics, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
Unit: COUNT
Name in real-time metrics report: ACW
Unit: COUNT
Name in real-time metrics report: Available
Unit: COUNT
Name in real-time metrics report: Error
Unit: COUNT
Name in real-time metrics report: NPT (Non-Productive Time)
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: Online
Unit: COUNT
Name in real-time metrics report: Staffed
Unit: COUNT
Name in real-time metrics report: In queue
Unit: COUNT
Name in real-time metrics report: Scheduled
Unit: SECONDS
When you use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:
{ "Metric": { "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" }, "Value": 24113.0
The actual OLDEST_CONTACT_AGE is 24 seconds.
Name in real-time metrics report: Oldest
Unit: COUNT
Name in real-time metrics report: Active
Unit: COUNT
Name in real-time metrics report: Availability
public GetCurrentMetricDataRequest withCurrentMetrics(CurrentMetric... currentMetrics)
The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available. For a description of all the metrics, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
Unit: COUNT
Name in real-time metrics report: ACW
Unit: COUNT
Name in real-time metrics report: Available
Unit: COUNT
Name in real-time metrics report: Error
Unit: COUNT
Name in real-time metrics report: NPT (Non-Productive Time)
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: Online
Unit: COUNT
Name in real-time metrics report: Staffed
Unit: COUNT
Name in real-time metrics report: In queue
Unit: COUNT
Name in real-time metrics report: Scheduled
Unit: SECONDS
When you use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:
{ "Metric": { "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" }, "Value": 24113.0
The actual OLDEST_CONTACT_AGE is 24 seconds.
Name in real-time metrics report: Oldest
Unit: COUNT
Name in real-time metrics report: Active
Unit: COUNT
Name in real-time metrics report: Availability
Returns a reference to this object so that method calls can be chained together.
currentMetrics
- The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available. For a description of all the metrics, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
Unit: COUNT
Name in real-time metrics report: ACW
Unit: COUNT
Name in real-time metrics report: Available
Unit: COUNT
Name in real-time metrics report: Error
Unit: COUNT
Name in real-time metrics report: NPT (Non-Productive Time)
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: Online
Unit: COUNT
Name in real-time metrics report: Staffed
Unit: COUNT
Name in real-time metrics report: In queue
Unit: COUNT
Name in real-time metrics report: Scheduled
Unit: SECONDS
When you use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:
{ "Metric": { "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" }, "Value": 24113.0
The actual OLDEST_CONTACT_AGE is 24 seconds.
Name in real-time metrics report: Oldest
Unit: COUNT
Name in real-time metrics report: Active
Unit: COUNT
Name in real-time metrics report: Availability
public GetCurrentMetricDataRequest withCurrentMetrics(java.util.Collection<CurrentMetric> currentMetrics)
The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available. For a description of all the metrics, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
Unit: COUNT
Name in real-time metrics report: ACW
Unit: COUNT
Name in real-time metrics report: Available
Unit: COUNT
Name in real-time metrics report: Error
Unit: COUNT
Name in real-time metrics report: NPT (Non-Productive Time)
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: Online
Unit: COUNT
Name in real-time metrics report: Staffed
Unit: COUNT
Name in real-time metrics report: In queue
Unit: COUNT
Name in real-time metrics report: Scheduled
Unit: SECONDS
When you use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:
{ "Metric": { "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" }, "Value": 24113.0
The actual OLDEST_CONTACT_AGE is 24 seconds.
Name in real-time metrics report: Oldest
Unit: COUNT
Name in real-time metrics report: Active
Unit: COUNT
Name in real-time metrics report: Availability
Returns a reference to this object so that method calls can be chained together.
currentMetrics
- The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available. For a description of all the metrics, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
Unit: COUNT
Name in real-time metrics report: ACW
Unit: COUNT
Name in real-time metrics report: Available
Unit: COUNT
Name in real-time metrics report: Error
Unit: COUNT
Name in real-time metrics report: NPT (Non-Productive Time)
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: Online
Unit: COUNT
Name in real-time metrics report: Staffed
Unit: COUNT
Name in real-time metrics report: In queue
Unit: COUNT
Name in real-time metrics report: Scheduled
Unit: SECONDS
When you use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:
{ "Metric": { "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" }, "Value": 24113.0
The actual OLDEST_CONTACT_AGE is 24 seconds.
Name in real-time metrics report: Oldest
Unit: COUNT
Name in real-time metrics report: Active
Unit: COUNT
Name in real-time metrics report: Availability
public java.lang.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.
The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.
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.
The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.
public void setNextToken(java.lang.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.
The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.
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.
The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.
public GetCurrentMetricDataRequest withNextToken(java.lang.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.
The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.
Returns a reference to this object so that method calls can be chained together.
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.
The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.
public java.lang.Integer getMaxResults()
The maximimum number of results to return per page.
Constraints:
Range: 1 - 100
The maximimum number of results to return per page.
public void setMaxResults(java.lang.Integer maxResults)
The maximimum number of results to return per page.
Constraints:
Range: 1 - 100
maxResults
- The maximimum number of results to return per page.
public GetCurrentMetricDataRequest withMaxResults(java.lang.Integer maxResults)
The maximimum 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
maxResults
- The maximimum number of results to return per page.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2018 Amazon Web Services, Inc. All Rights Reserved.