software.amazon.awssdk.services.connect.model

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

Modifier and Type	Method and Description
GetCurrentMetricDataRequest.Builder	currentMetrics(Collection<CurrentMetric> currentMetrics) A list of CurrentMetric objects for the metrics to retrieve.
GetCurrentMetricDataRequest.Builder	currentMetrics(Consumer<CurrentMetric.Builder>... currentMetrics) A list of CurrentMetric objects for the metrics to retrieve.
GetCurrentMetricDataRequest.Builder	currentMetrics(CurrentMetric... currentMetrics) A list of CurrentMetric objects for the metrics to retrieve.
default GetCurrentMetricDataRequest.Builder	filters(Consumer<Filters.Builder> filters) A Filters object that contains a list of queue IDs or queue ARNs, up to 100, or list of Channels to use to filter the metrics returned in the response.
GetCurrentMetricDataRequest.Builder	filters(Filters filters) A Filters object that contains a list of queue IDs or queue ARNs, up to 100, or list of Channels to use to filter the metrics returned in the response.
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 for your Amazon Connect instance.
GetCurrentMetricDataRequest.Builder	maxResults(Integer maxResults) MaxResults indicates the maximum number of results to return per page in the response, between 1 and 100.
GetCurrentMetricDataRequest.Builder	nextToken(String nextToken) The token for the next set of results.
GetCurrentMetricDataRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
GetCurrentMetricDataRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.

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

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 for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

Parameters:

instanceId - The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

Returns:

Returns a reference to this object so that method calls can be chained together.

filters

GetCurrentMetricDataRequest.Builder filters(Filters filters)

A Filters object that contains a list of queue IDs or queue ARNs, up to 100, or list of Channels to use to filter the metrics returned in the response. Metric data is retrieved only for the resources associated with the queue IDs, ARNs, or Channels included in the filter. You can include both IDs and ARNs in the same request. To retrieve metrics for all queues, add the queue ID or ARN for each queue in your instance. Only VOICE is supported for Channels.

To find the ARN for a queue, open the queue you want to use in the Amazon Connect Queue editor. The ARN for the queue is displayed in the address bar as part of the URL. For example, the queue ARN is the set of characters at the end of the URL, after 'id=' such as arn:aws:connect:us-east-1:270923740243:instance/78fb859d-1b7d-44b1-8aa3-12f0835c5855/queue/1d1a4575-9618-40ab-bbeb-81e45795fe61 . The queue ID is also included in the URL, and is the string after 'queue/'.

Parameters:

filters - A Filters object that contains a list of queue IDs or queue ARNs, up to 100, or list of Channels to use to filter the metrics returned in the response. Metric data is retrieved only for the resources associated with the queue IDs, ARNs, or Channels included in the filter. You can include both IDs and ARNs in the same request. To retrieve metrics for all queues, add the queue ID or ARN for each queue in your instance. Only VOICE is supported for Channels.

To find the ARN for a queue, open the queue you want to use in the Amazon Connect Queue editor. The ARN for the queue is displayed in the address bar as part of the URL. For example, the queue ARN is the set of characters at the end of the URL, after 'id=' such as arn:aws:connect:us-east-1:270923740243:instance/78fb859d-1b7d-44b1-8aa3-12f0835c5855/queue/1d1a4575-9618-40ab-bbeb-81e45795fe61 . The queue ID is also included in the URL, and is the string after 'queue/'.

Returns:

Returns a reference to this object so that method calls can be chained together.

filters

default GetCurrentMetricDataRequest.Builder filters(Consumer<Filters.Builder> filters)

A Filters object that contains a list of queue IDs or queue ARNs, up to 100, or list of Channels to use to filter the metrics returned in the response. Metric data is retrieved only for the resources associated with the queue IDs, ARNs, or Channels included in the filter. You can include both IDs and ARNs in the same request. To retrieve metrics for all queues, add the queue ID or ARN for each queue in your instance. Only VOICE is supported for Channels.

To find the ARN for a queue, open the queue you want to use in the Amazon Connect Queue editor. The ARN for the queue is displayed in the address bar as part of the URL. For example, the queue ARN is the set of characters at the end of the URL, after 'id=' such as arn:aws:connect:us-east-1:270923740243:instance/78fb859d-1b7d-44b1-8aa3-12f0835c5855/queue/1d1a4575-9618-40ab-bbeb-81e45795fe61 . The queue ID is also included in the URL, and is the string after 'queue/'.

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. The only supported channel is VOICE.

If no Grouping is included in the request, a summary of CurrentMetrics 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. The only supported channel is VOICE.

If no Grouping is included in the request, a summary of CurrentMetrics 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. The only supported channel is VOICE.

If no Grouping is included in the request, a summary of CurrentMetrics 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. The only supported channel is VOICE.

If no Grouping is included in the request, a summary of CurrentMetrics 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. The only supported channel is VOICE.

If no Grouping is included in the request, a summary of CurrentMetrics 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. The only supported channel is VOICE.

If no Grouping is included in the request, a summary of CurrentMetrics 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. The only supported channel is VOICE.

If no Grouping is included in the request, a summary of CurrentMetrics 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. The only supported channel is VOICE.

If no Grouping is included in the request, a summary of CurrentMetrics is returned.

Returns:

Returns a reference to this object so that method calls can be chained together.

currentMetrics

GetCurrentMetricDataRequest.Builder currentMetrics(Collection<CurrentMetric> currentMetrics)

A list of CurrentMetric objects for the metrics to retrieve. Each CurrentMetric includes a name of a metric to retrieve and the unit to use for it.

The following metrics are available:

AGENTS_AVAILABLE

Unit: COUNT

AGENTS_ONLINE

Unit: COUNT

AGENTS_ON_CALL

Unit: COUNT

AGENTS_STAFFED

Unit: COUNT

AGENTS_AFTER_CONTACT_WORK

Unit: COUNT

AGENTS_NON_PRODUCTIVE

Unit: COUNT

AGENTS_ERROR

Unit: COUNT

CONTACTS_IN_QUEUE

Unit: COUNT

OLDEST_CONTACT_AGE

Unit: SECONDS

CONTACTS_SCHEDULED

Unit: COUNT

Parameters:

currentMetrics - A list of CurrentMetric objects for the metrics to retrieve. Each CurrentMetric includes a name of a metric to retrieve and the unit to use for it.

The following metrics are available:

AGENTS_AVAILABLE

Unit: COUNT

AGENTS_ONLINE

Unit: COUNT

AGENTS_ON_CALL

Unit: COUNT

AGENTS_STAFFED

Unit: COUNT

AGENTS_AFTER_CONTACT_WORK

Unit: COUNT

AGENTS_NON_PRODUCTIVE

Unit: COUNT

AGENTS_ERROR

Unit: COUNT

CONTACTS_IN_QUEUE

Unit: COUNT

OLDEST_CONTACT_AGE

Unit: SECONDS

CONTACTS_SCHEDULED

Unit: COUNT

Returns:

Returns a reference to this object so that method calls can be chained together.

currentMetrics

GetCurrentMetricDataRequest.Builder currentMetrics(CurrentMetric... currentMetrics)

A list of CurrentMetric objects for the metrics to retrieve. Each CurrentMetric includes a name of a metric to retrieve and the unit to use for it.

The following metrics are available:

AGENTS_AVAILABLE

Unit: COUNT

AGENTS_ONLINE

Unit: COUNT

AGENTS_ON_CALL

Unit: COUNT

AGENTS_STAFFED

Unit: COUNT

AGENTS_AFTER_CONTACT_WORK

Unit: COUNT

AGENTS_NON_PRODUCTIVE

Unit: COUNT

AGENTS_ERROR

Unit: COUNT

CONTACTS_IN_QUEUE

Unit: COUNT

OLDEST_CONTACT_AGE

Unit: SECONDS

CONTACTS_SCHEDULED

Unit: COUNT

Parameters:

currentMetrics - A list of CurrentMetric objects for the metrics to retrieve. Each CurrentMetric includes a name of a metric to retrieve and the unit to use for it.

The following metrics are available:

AGENTS_AVAILABLE

Unit: COUNT

AGENTS_ONLINE

Unit: COUNT

AGENTS_ON_CALL

Unit: COUNT

AGENTS_STAFFED

Unit: COUNT

AGENTS_AFTER_CONTACT_WORK

Unit: COUNT

AGENTS_NON_PRODUCTIVE

Unit: COUNT

AGENTS_ERROR

Unit: COUNT

CONTACTS_IN_QUEUE

Unit: COUNT

OLDEST_CONTACT_AGE

Unit: SECONDS

CONTACTS_SCHEDULED

Unit: COUNT

Returns:

Returns a reference to this object so that method calls can be chained together.

currentMetrics

GetCurrentMetricDataRequest.Builder currentMetrics(Consumer<CurrentMetric.Builder>... currentMetrics)

A list of CurrentMetric objects for the metrics to retrieve. Each CurrentMetric includes a name of a metric to retrieve and the unit to use for it.

The following metrics are available:

AGENTS_AVAILABLE

Unit: COUNT

AGENTS_ONLINE

Unit: COUNT

AGENTS_ON_CALL

Unit: COUNT

AGENTS_STAFFED

Unit: COUNT

AGENTS_AFTER_CONTACT_WORK

Unit: COUNT

AGENTS_NON_PRODUCTIVE

Unit: COUNT

AGENTS_ERROR

Unit: COUNT

CONTACTS_IN_QUEUE

Unit: COUNT

OLDEST_CONTACT_AGE

Unit: SECONDS

CONTACTS_SCHEDULED

Unit: COUNT

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 NextToken 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 NextToken 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)

MaxResults indicates the maximum number of results to return per page in the response, between 1 and 100.

Parameters:

maxResults - MaxResults indicates the maximum number of results to return per page in the response, between 1 and 100.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

GetCurrentMetricDataRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

GetCurrentMetricDataRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.