GetCurrentMetricDataRequest.Builder (AWS Java SDK :: Services

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

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`GetCurrentMetricDataRequest.Builder`	`currentMetrics(Collection<CurrentMetric> currentMetrics)` The metrics to retrieve.
`GetCurrentMetricDataRequest.Builder`	`currentMetrics(Consumer<CurrentMetric.Builder>... currentMetrics)` The metrics to retrieve.
`GetCurrentMetricDataRequest.Builder`	`currentMetrics(CurrentMetric... currentMetrics)` The metrics to retrieve.
`default GetCurrentMetricDataRequest.Builder`	`filters(Consumer<Filters.Builder> filters)` The queues, up to 100, or channels, to use to filter the metrics returned.
`GetCurrentMetricDataRequest.Builder`	`filters(Filters filters)` The queues, up to 100, or channels, to use to filter the metrics returned.
`GetCurrentMetricDataRequest.Builder`	`groupings(Collection<Grouping> groupings)` The grouping applied to the metrics returned.
`GetCurrentMetricDataRequest.Builder`	`groupings(Grouping... groupings)` The grouping applied to the metrics returned.
`GetCurrentMetricDataRequest.Builder`	`groupingsWithStrings(Collection<String> groupings)` The grouping applied to the metrics returned.
`GetCurrentMetricDataRequest.Builder`	`groupingsWithStrings(String... groupings)` The grouping applied to the metrics returned.
`GetCurrentMetricDataRequest.Builder`	`instanceId(String instanceId)` The identifier of the Amazon Connect instance.
`GetCurrentMetricDataRequest.Builder`	`maxResults(Integer maxResults)` The maximum number of results to return per page.
`GetCurrentMetricDataRequest.Builder`	`nextToken(String nextToken)` The token for the next set of results.
`GetCurrentMetricDataRequest.Builder`	`overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)`
`GetCurrentMetricDataRequest.Builder`	`overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)`

Methods inherited from interface software.amazon.awssdk.services.connect.model.ConnectRequest.Builder
build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - instanceId
```
GetCurrentMetricDataRequest.Builder instanceId(String instanceId)
```
    The identifier of the Amazon Connect instance.
    
    Parameters:
    
    instanceId - The identifier of the Amazon Connect instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - filters
```
GetCurrentMetricDataRequest.Builder filters(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - filters
```
default GetCurrentMetricDataRequest.Builder filters(Consumer<Filters.Builder> 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.
    This is a convenience that creates an instance of the Filters.Builder avoiding the need to create one manually via Filters.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filters(Filters).
    
    Parameters:
    
    filters - a consumer that will call methods on Filters.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 no Grouping is included in the request, a summary of metrics is returned.
    
    Parameters:
    
    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:
    
    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 no Grouping is included in the request, a summary of metrics is returned.
    
    Parameters:
    
    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:
    
    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 no Grouping is included in the request, a summary of metrics is returned.
    
    Parameters:
    
    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:
    
    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 no Grouping is included in the request, a summary of metrics is returned.
    
    Parameters:
    
    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:
    
    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 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
    
    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 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
    
    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 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
    
    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 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
    
    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 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
    
    SLOTS_ACTIVE
    
    Unit: COUNT
    
    Name in real-time metrics report: Active
    
    SLOTS_AVAILABLE
    
    Unit: COUNT
    
    Name in real-time metrics report: Availability
    
    This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #currentMetrics(List).
    
    Parameters:
    
    currentMetrics - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #currentMetrics(List)
  - 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.
  - overrideConfiguration
```
GetCurrentMetricDataRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
```
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder
  - overrideConfiguration
```
GetCurrentMetricDataRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
```
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder

Interface GetCurrentMetricDataRequest.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.services.connect.model.ConnectRequest.Builder

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

Method Detail

instanceId

filters

filters

groupingsWithStrings

groupingsWithStrings

groupings

groupings

currentMetrics

currentMetrics

currentMetrics

nextToken

maxResults

overrideConfiguration

overrideConfiguration