GetMetricDataV2Request (AWS Java SDK :: Services

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.GetMetricDataV2Request

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface GetMetricDataV2Request.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static GetMetricDataV2Request.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)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<FilterV2>`	`filters()` The filters to apply to returned metrics.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`List<String>`	`groupings()` The grouping applied to the metrics that are returned.
`boolean`	`hasFilters()` For responses, this returns true if the service returned a value for the Filters property.
`boolean`	`hasGroupings()` For responses, this returns true if the service returned a value for the Groupings property.
`int`	`hashCode()`
`boolean`	`hasMetrics()` For responses, this returns true if the service returned a value for the Metrics property.
`Integer`	`maxResults()` The maximum number of results to return per page.
`List<MetricV2>`	`metrics()` The metrics to retrieve.
`String`	`nextToken()` The token for the next set of results.
`String`	`resourceArn()` The Amazon Resource Name (ARN) of the resource.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetMetricDataV2Request.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.
`GetMetricDataV2Request.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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

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

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

- Method Detail
  - resourceArn
```
public final String resourceArn()
```
    The Amazon Resource Name (ARN) of the resource. This includes the instanceId an Amazon Connect instance.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the resource. This includes the instanceId an Amazon Connect instance.
  - startTime
```
public final 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 before the end time timestamp. The time range between the start and end time must be less than 24 hours. The start time cannot be earlier than 35 days before the time of the request. Historical metrics are available for 35 days.
    
    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 before the end time timestamp. The time range between the start and end time must be less than 24 hours. The start time cannot be earlier than 35 days before the time of the request. Historical metrics are available for 35 days.
  - endTime
```
public final 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 later than the start time timestamp. It cannot be later than the current timestamp.
    
    The time range between the start and end time 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 later than the start time timestamp. It cannot be later than the current timestamp.
    
    The time range between the start and end time must be less than 24 hours.
  - hasFilters
```
public final boolean hasFilters()
```
    For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - filters
```
public final List<FilterV2> filters()
```
    The filters to apply to returned metrics. You can filter on the following resources:
    - Queues
    - Routing profiles
    - Agents
    - Channels
    - User hierarchy groups
    At least one filter must be passed from queues, routing profiles, agents, or user hierarchy groups.
    
    To filter by phone number, see Create a historical metrics report in the Amazon Connect Administrator's Guide.
    
    Note the following limits:
    - Filter keys: A maximum of 5 filter keys are supported in a single request. Valid filter keys: QUEUE | ROUTING_PROFILE | AGENT | CHANNEL | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE
    - Filter values: A maximum of 100 filter values are supported in a single request. For example, a GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values. VOICE, CHAT, and TASK are valid filterValue for the CHANNEL filter key.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFilters() method.
    Returns:
    The filters to apply to returned metrics. You can filter on the following resources:
    
    Queues
    
    Routing profiles
    
    Agents
    
    Channels
    
    User hierarchy groups
    
    At least one filter must be passed from queues, routing profiles, agents, or user hierarchy groups.
    
    To filter by phone number, see Create a historical metrics report in the Amazon Connect Administrator's Guide.
    
    Note the following limits:
    
    Filter keys: A maximum of 5 filter keys are supported in a single request. Valid filter keys: QUEUE | ROUTING_PROFILE | AGENT | CHANNEL | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE
    
    Filter values: A maximum of 100 filter values are supported in a single request. For example, a GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values. VOICE, CHAT, and TASK are valid filterValue for the CHANNEL filter key.
  - hasGroupings
```
public final boolean hasGroupings()
```
    For responses, this returns true if the service returned a value for the Groupings property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - groupings
```
public final List<String> groupings()
```
    The grouping applied to the metrics that are returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values that are returned apply to the metrics for each queue. They are not aggregated for all queues.
    
    If no grouping is specified, a summary of all metrics is returned.
    
    Valid grouping keys: QUEUE | ROUTING_PROFILE | AGENT | CHANNEL | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasGroupings() method.
    
    Returns:
    
    The grouping applied to the metrics that are returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values that are returned apply to the metrics for each queue. They are not aggregated for all queues.
    
    If no grouping is specified, a summary of all metrics is returned.
    
    Valid grouping keys: QUEUE | ROUTING_PROFILE | AGENT | CHANNEL | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE
  - hasMetrics
```
public final boolean hasMetrics()
```
    For responses, this returns true if the service returned a value for the Metrics property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - metrics
```
public final List<MetricV2> metrics()
```
    The metrics to retrieve. Specify the name, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator's Guide.
    
    AGENT_ADHERENT_TIME
    
    This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    AGENT_NON_RESPONSE
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    AGENT_OCCUPANCY
    
    Unit: Percentage
    
    Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
    
    AGENT_SCHEDULE_ADHERENCE
    
    This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
    
    Unit: Percent
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    AGENT_SCHEDULED_TIME
    
    This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    AVG_ABANDON_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    AVG_AFTER_CONTACT_WORK_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    AVG_AGENT_CONNECTING_TIME
    
    Unit: Seconds
    
    Valid metric filter key: INITIATION_METHOD. For now, this metric only supports the following as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    AVG_HANDLE_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    AVG_HOLD_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    AVG_INTERACTION_AND_HOLD_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    AVG_INTERACTION_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile
    
    AVG_QUEUE_ANSWER_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile
    
    CONTACTS_ABANDONED
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    CONTACTS_CREATED
    
    Unit: Count
    
    Valid metric filter key: INITIATION_METHOD
    
    Valid groupings and filters: Queue, Channel, Routing Profile
    
    CONTACTS_HANDLED
    
    Unit: Count
    
    Valid metric filter key: INITIATION_METHOD, DISCONNECT_REASON
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    CONTACTS_HOLD_ABANDONS
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    CONTACTS_QUEUED
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    CONTACTS_TRANSFERRED_OUT
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    CONTACTS_TRANSFERRED_OUT_BY_AGENT
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    MAX_QUEUED_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    SERVICE_LEVEL
    
    You can include up to 20 SERVICE_LEVEL metrics in a request.
    
    Unit: Percent
    
    Valid groupings and filters: Queue, Channel, Routing Profile
    
    Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than").
    
    SUM_CONTACTS_ANSWERED_IN_X
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile
    
    Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than").
    
    SUM_CONTACTS_ABANDONED_IN_X
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile
    
    Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than").
    
    SUM_CONTACTS_DISCONNECTED
    
    Valid metric filter key: DISCONNECT_REASON
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile
    
    SUM_RETRY_CALLBACK_ATTEMPTS
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMetrics() method.
    
    Returns:
    
    The metrics to retrieve. Specify the name, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator's Guide.
    
    AGENT_ADHERENT_TIME
    
    This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    AGENT_NON_RESPONSE
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    AGENT_OCCUPANCY
    
    Unit: Percentage
    
    Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
    
    AGENT_SCHEDULE_ADHERENCE
    
    This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
    
    Unit: Percent
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    AGENT_SCHEDULED_TIME
    
    This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    AVG_ABANDON_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    AVG_AFTER_CONTACT_WORK_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    AVG_AGENT_CONNECTING_TIME
    
    Unit: Seconds
    
    Valid metric filter key: INITIATION_METHOD. For now, this metric only supports the following as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    AVG_HANDLE_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    AVG_HOLD_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    AVG_INTERACTION_AND_HOLD_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    AVG_INTERACTION_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile
    
    AVG_QUEUE_ANSWER_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile
    
    CONTACTS_ABANDONED
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    CONTACTS_CREATED
    
    Unit: Count
    
    Valid metric filter key: INITIATION_METHOD
    
    Valid groupings and filters: Queue, Channel, Routing Profile
    
    CONTACTS_HANDLED
    
    Unit: Count
    
    Valid metric filter key: INITIATION_METHOD, DISCONNECT_REASON
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    CONTACTS_HOLD_ABANDONS
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    CONTACTS_QUEUED
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    CONTACTS_TRANSFERRED_OUT
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    CONTACTS_TRANSFERRED_OUT_BY_AGENT
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    MAX_QUEUED_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    SERVICE_LEVEL
    
    You can include up to 20 SERVICE_LEVEL metrics in a request.
    
    Unit: Percent
    
    Valid groupings and filters: Queue, Channel, Routing Profile
    
    Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than").
    
    SUM_CONTACTS_ANSWERED_IN_X
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile
    
    Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than").
    
    SUM_CONTACTS_ABANDONED_IN_X
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile
    
    Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than").
    
    SUM_CONTACTS_DISCONNECTED
    
    Valid metric filter key: DISCONNECT_REASON
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile
    
    SUM_RETRY_CALLBACK_ATTEMPTS
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile
  - nextToken
```
public final 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 final Integer maxResults()
```
    The maximum number of results to return per page.
    
    Returns:
    
    The maximum number of results to return per page.
  - toBuilder
```
public GetMetricDataV2Request.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetMetricDataV2Request.Builder,GetMetricDataV2Request>
    
    Specified by:
    
    toBuilder in class ConnectRequest
  - builder
```
public static GetMetricDataV2Request.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetMetricDataV2Request.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class GetMetricDataV2Request

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

resourceArn

startTime

endTime

hasFilters

filters

hasGroupings

groupings

hasMetrics

metrics

nextToken

maxResults

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields