Interface GetCurrentMetricDataRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,Buildable,ConnectRequest.Builder,CopyableBuilder<GetCurrentMetricDataRequest.Builder,GetCurrentMetricDataRequest>,SdkBuilder<GetCurrentMetricDataRequest.Builder,GetCurrentMetricDataRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- GetCurrentMetricDataRequest
public static interface GetCurrentMetricDataRequest.Builder extends ConnectRequest.Builder, SdkPojo, CopyableBuilder<GetCurrentMetricDataRequest.Builder,GetCurrentMetricDataRequest>
-
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.services.connect.model.ConnectRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
instanceId
GetCurrentMetricDataRequest.Builder instanceId(String instanceId)
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- Parameters:
instanceId- The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
GetCurrentMetricDataRequest.Builder filters(Filters filters)
The filters to apply to returned metrics. You can filter up to the following limits:
-
Queues: 100
-
Routing profiles: 100
-
Channels: 3 (VOICE, CHAT, and TASK channels are supported.)
Metric data is retrieved only for the resources associated with the queues or routing profiles, and by any channels included in the filter. (You cannot filter by both queue AND routing profile.) You can include both resource IDs and resource ARNs in the same request.
Currently tagging is only supported on the resources that are passed in the filter.
- Parameters:
filters- The filters to apply to returned metrics. You can filter up to the following limits:-
Queues: 100
-
Routing profiles: 100
-
Channels: 3 (VOICE, CHAT, and TASK channels are supported.)
Metric data is retrieved only for the resources associated with the queues or routing profiles, and by any channels included in the filter. (You cannot filter by both queue AND routing profile.) You can include both resource IDs and resource ARNs in the same request.
Currently tagging is only supported on the resources that are passed in the filter.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
filters
default GetCurrentMetricDataRequest.Builder filters(Consumer<Filters.Builder> filters)
The filters to apply to returned metrics. You can filter up to the following limits:
-
Queues: 100
-
Routing profiles: 100
-
Channels: 3 (VOICE, CHAT, and TASK channels are supported.)
Metric data is retrieved only for the resources associated with the queues or routing profiles, and by any channels included in the filter. (You cannot filter by both queue AND routing profile.) You can include both resource IDs and resource ARNs in the same request.
Currently tagging is only supported on the resources that are passed in the filter.
This is a convenience method that creates an instance of theFilters.Builderavoiding the need to create one manually viaFilters.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tofilters(Filters).- Parameters:
filters- a consumer that will call methods onFilters.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
filters(Filters)
-
-
groupingsWithStrings
GetCurrentMetricDataRequest.Builder groupingsWithStrings(Collection<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 you group by
ROUTING_PROFILE, you must include either a queue or routing profile filter. In addition, a routing profile filter is required for metricsCONTACTS_SCHEDULED,CONTACTS_IN_QUEUE, andOLDEST_CONTACT_AGE. -
If no
Groupingis included in the request, a summary of metrics is returned.
- Parameters:
groupings- The grouping applied to the metrics returned. For example, when grouped byQUEUE, 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 you group by
ROUTING_PROFILE, you must include either a queue or routing profile filter. In addition, a routing profile filter is required for metricsCONTACTS_SCHEDULED,CONTACTS_IN_QUEUE, andOLDEST_CONTACT_AGE. -
If no
Groupingis included in the request, a summary of metrics is returned.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
groupingsWithStrings
GetCurrentMetricDataRequest.Builder groupingsWithStrings(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 you group by
ROUTING_PROFILE, you must include either a queue or routing profile filter. In addition, a routing profile filter is required for metricsCONTACTS_SCHEDULED,CONTACTS_IN_QUEUE, andOLDEST_CONTACT_AGE. -
If no
Groupingis included in the request, a summary of metrics is returned.
- Parameters:
groupings- The grouping applied to the metrics returned. For example, when grouped byQUEUE, 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 you group by
ROUTING_PROFILE, you must include either a queue or routing profile filter. In addition, a routing profile filter is required for metricsCONTACTS_SCHEDULED,CONTACTS_IN_QUEUE, andOLDEST_CONTACT_AGE. -
If no
Groupingis included in the request, a summary of metrics is returned.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
groupings
GetCurrentMetricDataRequest.Builder groupings(Collection<Grouping> 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 you group by
ROUTING_PROFILE, you must include either a queue or routing profile filter. In addition, a routing profile filter is required for metricsCONTACTS_SCHEDULED,CONTACTS_IN_QUEUE, andOLDEST_CONTACT_AGE. -
If no
Groupingis included in the request, a summary of metrics is returned.
- Parameters:
groupings- The grouping applied to the metrics returned. For example, when grouped byQUEUE, 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 you group by
ROUTING_PROFILE, you must include either a queue or routing profile filter. In addition, a routing profile filter is required for metricsCONTACTS_SCHEDULED,CONTACTS_IN_QUEUE, andOLDEST_CONTACT_AGE. -
If no
Groupingis included in the request, a summary of metrics is returned.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
groupings
GetCurrentMetricDataRequest.Builder groupings(Grouping... 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 you group by
ROUTING_PROFILE, you must include either a queue or routing profile filter. In addition, a routing profile filter is required for metricsCONTACTS_SCHEDULED,CONTACTS_IN_QUEUE, andOLDEST_CONTACT_AGE. -
If no
Groupingis included in the request, a summary of metrics is returned.
- Parameters:
groupings- The grouping applied to the metrics returned. For example, when grouped byQUEUE, 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 you group by
ROUTING_PROFILE, you must include either a queue or routing profile filter. In addition, a routing profile filter is required for metricsCONTACTS_SCHEDULED,CONTACTS_IN_QUEUE, andOLDEST_CONTACT_AGE. -
If no
Groupingis included in the request, a summary of metrics is returned.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
currentMetrics
GetCurrentMetricDataRequest.Builder currentMetrics(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.
- AGENTS_AFTER_CONTACT_WORK
-
Unit: COUNT
Name in real-time metrics report: ACW
- AGENTS_AVAILABLE
-
Unit: COUNT
Name in real-time metrics report: Available
- AGENTS_ERROR
-
Unit: COUNT
Name in real-time metrics report: Error
- AGENTS_NON_PRODUCTIVE
-
Unit: COUNT
Name in real-time metrics report: NPT (Non-Productive Time)
- AGENTS_ON_CALL
-
Unit: COUNT
Name in real-time metrics report: On contact
- AGENTS_ON_CONTACT
-
Unit: COUNT
Name in real-time metrics report: On contact
- AGENTS_ONLINE
-
Unit: COUNT
Name in real-time metrics report: Online
- AGENTS_STAFFED
-
Unit: COUNT
Name in real-time metrics report: Staffed
- CONTACTS_IN_QUEUE
-
Unit: COUNT
Name in real-time metrics report: In queue
- CONTACTS_SCHEDULED
-
Unit: COUNT
Name in real-time metrics report: Scheduled
- OLDEST_CONTACT_AGE
-
Unit: SECONDS
When you use groupings, Unit says SECONDS and the Value is returned in SECONDS.
When you do not 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.0The actual OLDEST_CONTACT_AGE is 24 seconds.
Name in real-time metrics report: Oldest
- SLOTS_ACTIVE
-
Unit: COUNT
Name in real-time metrics report: Active
- SLOTS_AVAILABLE
-
Unit: COUNT
Name in real-time metrics report: Availability
- Parameters:
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.- AGENTS_AFTER_CONTACT_WORK
-
Unit: COUNT
Name in real-time metrics report: ACW
- AGENTS_AVAILABLE
-
Unit: COUNT
Name in real-time metrics report: Available
- AGENTS_ERROR
-
Unit: COUNT
Name in real-time metrics report: Error
- AGENTS_NON_PRODUCTIVE
-
Unit: COUNT
Name in real-time metrics report: NPT (Non-Productive Time)
- AGENTS_ON_CALL
-
Unit: COUNT
Name in real-time metrics report: On contact
- AGENTS_ON_CONTACT
-
Unit: COUNT
Name in real-time metrics report: On contact
- AGENTS_ONLINE
-
Unit: COUNT
Name in real-time metrics report: Online
- AGENTS_STAFFED
-
Unit: COUNT
Name in real-time metrics report: Staffed
- CONTACTS_IN_QUEUE
-
Unit: COUNT
Name in real-time metrics report: In queue
- CONTACTS_SCHEDULED
-
Unit: COUNT
Name in real-time metrics report: Scheduled
- OLDEST_CONTACT_AGE
-
Unit: SECONDS
When you use groupings, Unit says SECONDS and the Value is returned in SECONDS.
When you do not 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.0The actual OLDEST_CONTACT_AGE is 24 seconds.
Name in real-time metrics report: Oldest
- SLOTS_ACTIVE
-
Unit: COUNT
Name in real-time metrics report: Active
- SLOTS_AVAILABLE
-
Unit: COUNT
Name in real-time metrics report: Availability
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
currentMetrics
GetCurrentMetricDataRequest.Builder currentMetrics(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.
- AGENTS_AFTER_CONTACT_WORK
-
Unit: COUNT
Name in real-time metrics report: ACW
- AGENTS_AVAILABLE
-
Unit: COUNT
Name in real-time metrics report: Available
- AGENTS_ERROR
-
Unit: COUNT
Name in real-time metrics report: Error
- AGENTS_NON_PRODUCTIVE
-
Unit: COUNT
Name in real-time metrics report: NPT (Non-Productive Time)
- AGENTS_ON_CALL
-
Unit: COUNT
Name in real-time metrics report: On contact
- AGENTS_ON_CONTACT
-
Unit: COUNT
Name in real-time metrics report: On contact
- AGENTS_ONLINE
-
Unit: COUNT
Name in real-time metrics report: Online
- AGENTS_STAFFED
-
Unit: COUNT
Name in real-time metrics report: Staffed
- CONTACTS_IN_QUEUE
-
Unit: COUNT
Name in real-time metrics report: In queue
- CONTACTS_SCHEDULED
-
Unit: COUNT
Name in real-time metrics report: Scheduled
- OLDEST_CONTACT_AGE
-
Unit: SECONDS
When you use groupings, Unit says SECONDS and the Value is returned in SECONDS.
When you do not 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.0The actual OLDEST_CONTACT_AGE is 24 seconds.
Name in real-time metrics report: Oldest
- SLOTS_ACTIVE
-
Unit: COUNT
Name in real-time metrics report: Active
- SLOTS_AVAILABLE
-
Unit: COUNT
Name in real-time metrics report: Availability
- Parameters:
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.- AGENTS_AFTER_CONTACT_WORK
-
Unit: COUNT
Name in real-time metrics report: ACW
- AGENTS_AVAILABLE
-
Unit: COUNT
Name in real-time metrics report: Available
- AGENTS_ERROR
-
Unit: COUNT
Name in real-time metrics report: Error
- AGENTS_NON_PRODUCTIVE
-
Unit: COUNT
Name in real-time metrics report: NPT (Non-Productive Time)
- AGENTS_ON_CALL
-
Unit: COUNT
Name in real-time metrics report: On contact
- AGENTS_ON_CONTACT
-
Unit: COUNT
Name in real-time metrics report: On contact
- AGENTS_ONLINE
-
Unit: COUNT
Name in real-time metrics report: Online
- AGENTS_STAFFED
-
Unit: COUNT
Name in real-time metrics report: Staffed
- CONTACTS_IN_QUEUE
-
Unit: COUNT
Name in real-time metrics report: In queue
- CONTACTS_SCHEDULED
-
Unit: COUNT
Name in real-time metrics report: Scheduled
- OLDEST_CONTACT_AGE
-
Unit: SECONDS
When you use groupings, Unit says SECONDS and the Value is returned in SECONDS.
When you do not 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.0The actual OLDEST_CONTACT_AGE is 24 seconds.
Name in real-time metrics report: Oldest
- SLOTS_ACTIVE
-
Unit: COUNT
Name in real-time metrics report: Active
- SLOTS_AVAILABLE
-
Unit: COUNT
Name in real-time metrics report: Availability
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
currentMetrics
GetCurrentMetricDataRequest.Builder currentMetrics(Consumer<CurrentMetric.Builder>... 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.
- AGENTS_AFTER_CONTACT_WORK
-
Unit: COUNT
Name in real-time metrics report: ACW
- AGENTS_AVAILABLE
-
Unit: COUNT
Name in real-time metrics report: Available
- AGENTS_ERROR
-
Unit: COUNT
Name in real-time metrics report: Error
- AGENTS_NON_PRODUCTIVE
-
Unit: COUNT
Name in real-time metrics report: NPT (Non-Productive Time)
- AGENTS_ON_CALL
-
Unit: COUNT
Name in real-time metrics report: On contact
- AGENTS_ON_CONTACT
-
Unit: COUNT
Name in real-time metrics report: On contact
- AGENTS_ONLINE
-
Unit: COUNT
Name in real-time metrics report: Online
- AGENTS_STAFFED
-
Unit: COUNT
Name in real-time metrics report: Staffed
- CONTACTS_IN_QUEUE
-
Unit: COUNT
Name in real-time metrics report: In queue
- CONTACTS_SCHEDULED
-
Unit: COUNT
Name in real-time metrics report: Scheduled
- OLDEST_CONTACT_AGE
-
Unit: SECONDS
When you use groupings, Unit says SECONDS and the Value is returned in SECONDS.
When you do not 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.0The actual OLDEST_CONTACT_AGE is 24 seconds.
Name in real-time metrics report: Oldest
- SLOTS_ACTIVE
-
Unit: COUNT
Name in real-time metrics report: Active
- SLOTS_AVAILABLE
-
Unit: COUNT
Name in real-time metrics report: Availability
CurrentMetric.Builderavoiding the need to create one manually viaCurrentMetric.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#currentMetrics(List.) - Parameters:
currentMetrics- a consumer that will call methods onCurrentMetric.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#currentMetrics(java.util.Collection)
-
nextToken
GetCurrentMetricDataRequest.Builder nextToken(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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
maxResults
GetCurrentMetricDataRequest.Builder maxResults(Integer maxResults)
The maximum number of results to return per page.
- Parameters:
maxResults- The maximum number of results to return per page.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sortCriteria
GetCurrentMetricDataRequest.Builder sortCriteria(Collection<CurrentMetricSortCriteria> sortCriteria)
The way to sort the resulting response based on metrics. You can enter one sort criteria. By default resources are sorted based on
AGENTS_ONLINE,DESCENDING. The metric collection is sorted based on the input metrics.Note the following:
-
Sorting on
SLOTS_ACTIVEandSLOTS_AVAILABLEis not supported.
- Parameters:
sortCriteria- The way to sort the resulting response based on metrics. You can enter one sort criteria. By default resources are sorted based onAGENTS_ONLINE,DESCENDING. The metric collection is sorted based on the input metrics.Note the following:
-
Sorting on
SLOTS_ACTIVEandSLOTS_AVAILABLEis not supported.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
sortCriteria
GetCurrentMetricDataRequest.Builder sortCriteria(CurrentMetricSortCriteria... sortCriteria)
The way to sort the resulting response based on metrics. You can enter one sort criteria. By default resources are sorted based on
AGENTS_ONLINE,DESCENDING. The metric collection is sorted based on the input metrics.Note the following:
-
Sorting on
SLOTS_ACTIVEandSLOTS_AVAILABLEis not supported.
- Parameters:
sortCriteria- The way to sort the resulting response based on metrics. You can enter one sort criteria. By default resources are sorted based onAGENTS_ONLINE,DESCENDING. The metric collection is sorted based on the input metrics.Note the following:
-
Sorting on
SLOTS_ACTIVEandSLOTS_AVAILABLEis not supported.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
sortCriteria
GetCurrentMetricDataRequest.Builder sortCriteria(Consumer<CurrentMetricSortCriteria.Builder>... sortCriteria)
The way to sort the resulting response based on metrics. You can enter one sort criteria. By default resources are sorted based on
AGENTS_ONLINE,DESCENDING. The metric collection is sorted based on the input metrics.Note the following:
-
Sorting on
SLOTS_ACTIVEandSLOTS_AVAILABLEis not supported.
CurrentMetricSortCriteria.Builderavoiding the need to create one manually viaCurrentMetricSortCriteria.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#sortCriteria(List.) - Parameters:
sortCriteria- a consumer that will call methods onCurrentMetricSortCriteria.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#sortCriteria(java.util.Collection)
-
-
overrideConfiguration
GetCurrentMetricDataRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
GetCurrentMetricDataRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-