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

static interface 
GetMetricDataRequest.Builder 
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) 
boolean 
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.

Filters 
filters()
The queues, up to 100, or channels, to use to filter the metrics returned.

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

boolean 
hasGroupings()
Returns true if the Groupings property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).

int 
hashCode() 
boolean 
hasHistoricalMetrics()
Returns true if the HistoricalMetrics property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).

List<HistoricalMetric> 
historicalMetrics()
The metrics to retrieve.

String 
instanceId()
The identifier of the Amazon Connect instance.

Integer 
maxResults()
The maximimum number of results to return per page.

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()
Returns a string representation of this object.

overrideConfiguration
copy
public String instanceId()
The identifier of the Amazon Connect instance.
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.
The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available only for 24 hours.
The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available only for 24 hours.
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 start time timestamp.
The time range between the start and end time must be less than 24 hours.
The time range between the start and end time must be less than 24 hours.
public 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. Both VOICE
and CHAT
channels are supported.
VOICE
and CHAT
channels are
supported.public List<Grouping> groupings()
The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.
The only supported grouping is QUEUE
.
If no grouping is specified, a summary of metrics for all queues is returned.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasGroupings()
to see if a value was sent in this field.
The only supported grouping is QUEUE
.
If no grouping is specified, a summary of metrics for all queues is returned.
public boolean hasGroupings()
public List<String> groupingsAsStrings()
The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.
The only supported grouping is QUEUE
.
If no grouping is specified, a summary of metrics for all queues is returned.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasGroupings()
to see if a value was sent in this field.
The only supported grouping is QUEUE
.
If no grouping is specified, a summary of metrics for all queues is returned.
public boolean hasHistoricalMetrics()
public List<HistoricalMetric> historicalMetrics()
The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: PERCENT
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: MAX
Unit: PERCENT
Statistic: 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.
You can use hasHistoricalMetrics()
to see if a value was sent in this field.
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: PERCENT
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: MAX
Unit: PERCENT
Statistic: 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
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.
public Integer maxResults()
The maximimum number of results to return per page.
public GetMetricDataRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<GetMetricDataRequest.Builder,GetMetricDataRequest>
toBuilder
in class ConnectRequest
public static GetMetricDataRequest.Builder builder()
public static Class<? extends GetMetricDataRequest.Builder> serializableBuilderClass()
public int hashCode()
hashCode
in class AwsRequest
public boolean equals(Object obj)
equals
in class AwsRequest
public boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
 the object to be compared withpublic String toString()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service2.json model specified in the
codegenresources 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.getValueForField
in class SdkRequest
fieldName
 The name of the member to be retrieved.clazz
 The class to cast the returned object to.