GetCurrentMetricDataRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.connect.model.ConnectRequest
    - - software.amazon.awssdk.services.connect.model.GetCurrentMetricDataRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<GetCurrentMetricDataRequest.Builder,GetCurrentMetricDataRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetCurrentMetricDataRequest
extends ConnectRequest
implements ToCopyableBuilder<GetCurrentMetricDataRequest.Builder,GetCurrentMetricDataRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface GetCurrentMetricDataRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`GetCurrentMetricDataRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static GetCurrentMetricDataRequest.Builder`	`builder()`
`List<CurrentMetric>`	`currentMetrics()` A list of `CurrentMetric` objects for the metrics to retrieve.
`boolean`	`equals(Object obj)`
`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.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`List<Grouping>`	`groupings()` The grouping applied to the metrics returned.
`List<String>`	`groupingsAsStrings()` The grouping applied to the metrics returned.
`int`	`hashCode()`
`String`	`instanceId()` The identifier for your Amazon Connect instance.
`Integer`	`maxResults()` `MaxResults` indicates the maximum number of results to return per page in the response, between 1 and 100.
`String`	`nextToken()` The token for the next set of results.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetCurrentMetricDataRequest.Builder>`	`serializableBuilderClass()`
`GetCurrentMetricDataRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - instanceId
```
public 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.
    
    Returns:
    
    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.
  - filters
```
public 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/'.
    
    Returns:
    
    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/'.
  - groupings
```
public List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    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.
  - groupingsAsStrings
```
public List<String> groupingsAsStrings()
```
    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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    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.
  - currentMetrics
```
public List<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
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    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
  - nextToken
```
public 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.
    
    Returns:
    
    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.
  - maxResults
```
public Integer maxResults()
```
    MaxResults indicates the maximum number of results to return per page in the response, between 1 and 100.
    
    Returns:
    
    MaxResults indicates the maximum number of results to return per page in the response, between 1 and 100.
  - toBuilder
```
public GetCurrentMetricDataRequest.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetCurrentMetricDataRequest.Builder,GetCurrentMetricDataRequest>
    
    Specified by:
    
    toBuilder in class ConnectRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static GetCurrentMetricDataRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetCurrentMetricDataRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class GetCurrentMetricDataRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

instanceId

filters

groupings

groupingsAsStrings

currentMetrics

nextToken

maxResults

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields