GetMetricDataRequest (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.GetMetricDataRequest

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface GetMetricDataRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static GetMetricDataRequest.Builder`	`builder()`
`Instant`	`endTime()` The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data.
`boolean`	`equals(Object obj)`
`Filters`	`filters()` A `Filters` object that contains a list of queue IDs or queue ARNs, up to 100, or a 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()`
`List<HistoricalMetric>`	`historicalMetrics()` A list of `HistoricalMetric` objects that contain the metrics to retrieve with the request.
`String`	`instanceId()` The identifier for your Amazon Connect instance.
`Integer`	`maxResults()` Indicates the maximum number of results to return per page in the response, between 1-100.
`String`	`nextToken()` The token for the next set of results.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetMetricDataRequest.Builder>`	`serializableBuilderClass()`
`Instant`	`startTime()` The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data.
`GetMetricDataRequest.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.
  - startTime
```
public Instant startTime()
```
    The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05, 10:10, 10:15.
    
    StartTime cannot be earlier than 24 hours before the time of the request. Historical metrics are available in Amazon Connect only for 24 hours.
    
    Returns:
    
    The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05, 10:10, 10:15.
    
    StartTime cannot be earlier than 24 hours before the time of the request. Historical metrics are available in Amazon Connect only for 24 hours.
  - endTime
```
public Instant endTime()
```
    The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be later than the StartTime timestamp.
    
    The time range between StartTime and EndTime must be less than 24 hours.
    
    Returns:
    
    The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be later than the StartTime timestamp.
    
    The time range between StartTime and EndTime must be less than 24 hours.
  - filters
```
public Filters filters()
```
    A Filters object that contains a list of queue IDs or queue ARNs, up to 100, or a list of Channels to use to filter the metrics returned in the response. Metric data is retrieved only for the resources associated with the IDs, ARNs, or Channels included in the filter. You can use both IDs and ARNs together in a request. Only VOICE is supported for Channel.
    
    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 a list of Channels to use to filter the metrics returned in the response. Metric data is retrieved only for the resources associated with the IDs, ARNs, or Channels included in the filter. You can use both IDs and ARNs together in a request. Only VOICE is supported for Channel.
    
    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 results are grouped by queueId, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.
    
    The current version supports grouping by Queue
    
    If no Grouping is included in the request, a summary of HistoricalMetrics for all queues 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 results are grouped by queueId, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.
    
    The current version supports grouping by Queue
    
    If no Grouping is included in the request, a summary of HistoricalMetrics for all queues is returned.
  - groupingsAsStrings
```
public List<String> groupingsAsStrings()
```
    The grouping applied to the metrics returned. For example, when results are grouped by queueId, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.
    
    The current version supports grouping by Queue
    
    If no Grouping is included in the request, a summary of HistoricalMetrics for all queues 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 results are grouped by queueId, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.
    
    The current version supports grouping by Queue
    
    If no Grouping is included in the request, a summary of HistoricalMetrics for all queues is returned.
  - historicalMetrics
```
public List<HistoricalMetric> historicalMetrics()
```
    A list of HistoricalMetric objects that contain the metrics to retrieve with the request.
    
    A HistoricalMetric object contains: HistoricalMetricName, Statistic, Threshold, and Unit.
    
    For each historical metric you include in the request, you must include a Unit and a Statistic.
    
    The following historical metrics are available:
    
    CONTACTS_QUEUED
    
    Unit: COUNT
    
    Statistic: SUM
    
    CONTACTS_HANDLED
    
    Unit: COUNT
    
    Statistics: SUM
    
    CONTACTS_ABANDONED
    
    Unit: COUNT
    
    Statistics: SUM
    
    CONTACTS_CONSULTED
    
    Unit: COUNT
    
    Statistics: SUM
    
    CONTACTS_AGENT_HUNG_UP_FIRST
    
    Unit: COUNT
    
    Statistics: SUM
    
    CONTACTS_HANDLED_INCOMING
    
    Unit: COUNT
    
    Statistics: SUM
    
    CONTACTS_HANDLED_OUTBOUND
    
    Unit: COUNT
    
    Statistics: SUM
    
    CONTACTS_HOLD_ABANDONS
    
    Unit: COUNT
    
    Statistics: SUM
    
    CONTACTS_TRANSFERRED_IN
    
    Unit: COUNT
    
    Statistics: SUM
    
    CONTACTS_TRANSFERRED_OUT
    
    Unit: COUNT
    
    Statistics: SUM
    
    CONTACTS_TRANSFERRED_IN_FROM_QUEUE
    
    Unit: COUNT
    
    Statistics: SUM
    
    CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
    
    Unit: COUNT
    
    Statistics: SUM
    
    CALLBACK_CONTACTS_HANDLED
    
    Unit: COUNT
    
    Statistics: SUM
    
    CALLBACK_CONTACTS_HANDLED
    
    Unit: COUNT
    
    Statistics: SUM
    
    API_CONTACTS_HANDLED
    
    Unit: COUNT
    
    Statistics: SUM
    
    CONTACTS_MISSED
    
    Unit: COUNT
    
    Statistics: SUM
    
    OCCUPANCY
    
    Unit: PERCENT
    
    Statistics: AVG
    
    HANDLE_TIME
    
    Unit: SECONDS
    
    Statistics: AVG
    
    AFTER_CONTACT_WORK_TIME
    
    Unit: SECONDS
    
    Statistics: AVG
    
    QUEUED_TIME
    
    Unit: SECONDS
    
    Statistics: MAX
    
    ABANDON_TIME
    
    Unit: COUNT
    
    Statistics: SUM
    
    QUEUE_ANSWER_TIME
    
    Unit: SECONDS
    
    Statistics: AVG
    
    HOLD_TIME
    
    Unit: SECONDS
    
    Statistics: AVG
    
    INTERACTION_TIME
    
    Unit: SECONDS
    
    Statistics: AVG
    
    INTERACTION_AND_HOLD_TIME
    
    Unit: SECONDS
    
    Statistics: AVG
    
    SERVICE_LEVEL
    
    Unit: PERCENT
    
    Statistics: AVG
    
    Threshold: Only "Less than" comparisons are supported, with the following service level thresholds: 15, 20, 25, 30, 45, 60, 90, 120, 180, 240, 300, 600
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    A list of HistoricalMetric objects that contain the metrics to retrieve with the request.
    
    A HistoricalMetric object contains: HistoricalMetricName, Statistic, Threshold, and Unit.
    
    For each historical metric you include in the request, you must include a Unit and a Statistic.
    
    The following historical metrics are available:
    
    CONTACTS_QUEUED
    
    Unit: COUNT
    
    Statistic: SUM
    
    CONTACTS_HANDLED
    
    Unit: COUNT
    
    Statistics: SUM
    
    CONTACTS_ABANDONED
    
    Unit: COUNT
    
    Statistics: SUM
    
    CONTACTS_CONSULTED
    
    Unit: COUNT
    
    Statistics: SUM
    
    CONTACTS_AGENT_HUNG_UP_FIRST
    
    Unit: COUNT
    
    Statistics: SUM
    
    CONTACTS_HANDLED_INCOMING
    
    Unit: COUNT
    
    Statistics: SUM
    
    CONTACTS_HANDLED_OUTBOUND
    
    Unit: COUNT
    
    Statistics: SUM
    
    CONTACTS_HOLD_ABANDONS
    
    Unit: COUNT
    
    Statistics: SUM
    
    CONTACTS_TRANSFERRED_IN
    
    Unit: COUNT
    
    Statistics: SUM
    
    CONTACTS_TRANSFERRED_OUT
    
    Unit: COUNT
    
    Statistics: SUM
    
    CONTACTS_TRANSFERRED_IN_FROM_QUEUE
    
    Unit: COUNT
    
    Statistics: SUM
    
    CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
    
    Unit: COUNT
    
    Statistics: SUM
    
    CALLBACK_CONTACTS_HANDLED
    
    Unit: COUNT
    
    Statistics: SUM
    
    CALLBACK_CONTACTS_HANDLED
    
    Unit: COUNT
    
    Statistics: SUM
    
    API_CONTACTS_HANDLED
    
    Unit: COUNT
    
    Statistics: SUM
    
    CONTACTS_MISSED
    
    Unit: COUNT
    
    Statistics: SUM
    
    OCCUPANCY
    
    Unit: PERCENT
    
    Statistics: AVG
    
    HANDLE_TIME
    
    Unit: SECONDS
    
    Statistics: AVG
    
    AFTER_CONTACT_WORK_TIME
    
    Unit: SECONDS
    
    Statistics: AVG
    
    QUEUED_TIME
    
    Unit: SECONDS
    
    Statistics: MAX
    
    ABANDON_TIME
    
    Unit: COUNT
    
    Statistics: SUM
    
    QUEUE_ANSWER_TIME
    
    Unit: SECONDS
    
    Statistics: AVG
    
    HOLD_TIME
    
    Unit: SECONDS
    
    Statistics: AVG
    
    INTERACTION_TIME
    
    Unit: SECONDS
    
    Statistics: AVG
    
    INTERACTION_AND_HOLD_TIME
    
    Unit: SECONDS
    
    Statistics: AVG
    
    SERVICE_LEVEL
    
    Unit: PERCENT
    
    Statistics: AVG
    
    Threshold: Only "Less than" comparisons are supported, with the following service level thresholds: 15, 20, 25, 30, 45, 60, 90, 120, 180, 240, 300, 600
  - 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.
    
    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.
  - maxResults
```
public Integer maxResults()
```
    Indicates the maximum number of results to return per page in the response, between 1-100.
    
    Returns:
    
    Indicates the maximum number of results to return per page in the response, between 1-100.
  - toBuilder
```
public GetMetricDataRequest.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<GetMetricDataRequest.Builder,GetMetricDataRequest>
    
    Specified by:
    
    toBuilder in class ConnectRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static GetMetricDataRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetMetricDataRequest.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 GetMetricDataRequest

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

startTime

endTime

filters

groupings

groupingsAsStrings

historicalMetrics

nextToken

maxResults

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields