software.amazon.awssdk.services.connect.model.GetMetricDataRequest Maven / Gradle / Ivy
Show all versions of connect Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.connect.model;
import java.time.Instant;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class GetMetricDataRequest extends ConnectRequest implements
ToCopyableBuilder {
private static final SdkField INSTANCE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("InstanceId").getter(getter(GetMetricDataRequest::instanceId)).setter(setter(Builder::instanceId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("InstanceId").build()).build();
private static final SdkField START_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("StartTime").getter(getter(GetMetricDataRequest::startTime)).setter(setter(Builder::startTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StartTime").build()).build();
private static final SdkField END_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("EndTime").getter(getter(GetMetricDataRequest::endTime)).setter(setter(Builder::endTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EndTime").build()).build();
private static final SdkField FILTERS_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("Filters").getter(getter(GetMetricDataRequest::filters)).setter(setter(Builder::filters))
.constructor(Filters::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Filters").build()).build();
private static final SdkField> GROUPINGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Groupings")
.getter(getter(GetMetricDataRequest::groupingsAsStrings))
.setter(setter(Builder::groupingsWithStrings))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Groupings").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> HISTORICAL_METRICS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("HistoricalMetrics")
.getter(getter(GetMetricDataRequest::historicalMetrics))
.setter(setter(Builder::historicalMetrics))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("HistoricalMetrics").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(HistoricalMetric::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(GetMetricDataRequest::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextToken").build()).build();
private static final SdkField MAX_RESULTS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxResults").getter(getter(GetMetricDataRequest::maxResults)).setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxResults").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(INSTANCE_ID_FIELD,
START_TIME_FIELD, END_TIME_FIELD, FILTERS_FIELD, GROUPINGS_FIELD, HISTORICAL_METRICS_FIELD, NEXT_TOKEN_FIELD,
MAX_RESULTS_FIELD));
private final String instanceId;
private final Instant startTime;
private final Instant endTime;
private final Filters filters;
private final List groupings;
private final List historicalMetrics;
private final String nextToken;
private final Integer maxResults;
private GetMetricDataRequest(BuilderImpl builder) {
super(builder);
this.instanceId = builder.instanceId;
this.startTime = builder.startTime;
this.endTime = builder.endTime;
this.filters = builder.filters;
this.groupings = builder.groupings;
this.historicalMetrics = builder.historicalMetrics;
this.nextToken = builder.nextToken;
this.maxResults = builder.maxResults;
}
/**
*
* The identifier of the Amazon Connect instance. You can find the instance ID in
* the Amazon Resource Name (ARN) of the instance.
*
*
* @return The identifier of the Amazon Connect instance. You can find the instance
* ID in the Amazon Resource Name (ARN) of the instance.
*/
public final String instanceId() {
return instanceId;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final Instant startTime() {
return startTime;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final Instant endTime() {
return endTime;
}
/**
*
* 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. VOICE, CHAT, and TASK channels are supported.
*
*
* RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for
* more up-to-date features.
*
*
*
* To filter by Queues, enter the queue ID/ARN, not the name of the queue.
*
*
*
* @return 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. VOICE, CHAT, and TASK channels are supported.
*
* RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to
* GetMetricDataV2 for more up-to-date features.
*
*
*
* To filter by Queues, enter the queue ID/ARN, not the name of the queue.
*
*/
public final Filters filters() {
return filters;
}
/**
*
* 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.
*
*
* If no grouping is specified, a summary of metrics for all queues is returned.
*
*
* RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for
* more up-to-date features.
*
*
* 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 {@link #hasGroupings} method.
*
*
* @return 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.
*
* If no grouping is specified, a summary of metrics for all queues is returned.
*
*
* RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to
* GetMetricDataV2 for more up-to-date features.
*/
public final List groupings() {
return GroupingsCopier.copyStringToEnum(groupings);
}
/**
* 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 {@code 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.
*/
public final boolean hasGroupings() {
return groupings != null && !(groupings instanceof SdkAutoConstructList);
}
/**
*
* 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.
*
*
* If no grouping is specified, a summary of metrics for all queues is returned.
*
*
* RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for
* more up-to-date features.
*
*
* 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 {@link #hasGroupings} method.
*
*
* @return 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.
*
* If no grouping is specified, a summary of metrics for all queues is returned.
*
*
* RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to
* GetMetricDataV2 for more up-to-date features.
*/
public final List groupingsAsStrings() {
return groupings;
}
/**
* For responses, this returns true if the service returned a value for the HistoricalMetrics property. This DOES
* NOT check that the value is non-empty (for which, you should check the {@code 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.
*/
public final boolean hasHistoricalMetrics() {
return historicalMetrics != null && !(historicalMetrics instanceof SdkAutoConstructList);
}
/**
*
* 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.
*
*
*
* This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the
* documented list).
*
*
*
* - ABANDON_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - AFTER_CONTACT_WORK_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - API_CONTACTS_HANDLED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CALLBACK_CONTACTS_HANDLED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_ABANDONED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_AGENT_HUNG_UP_FIRST
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_CONSULTED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_HANDLED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_HANDLED_INCOMING
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_HANDLED_OUTBOUND
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_HOLD_ABANDONS
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_MISSED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_QUEUED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_TRANSFERRED_IN
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_TRANSFERRED_IN_FROM_QUEUE
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_TRANSFERRED_OUT
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - HANDLE_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - HOLD_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - INTERACTION_AND_HOLD_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - INTERACTION_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - OCCUPANCY
* -
*
* Unit: PERCENT
*
*
* Statistic: AVG
*
*
* - QUEUE_ANSWER_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - QUEUED_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: MAX
*
*
* - SERVICE_LEVEL
* -
*
* You can include up to 20 SERVICE_LEVEL metrics in a request.
*
*
* Unit: PERCENT
*
*
* Statistic: AVG
*
*
* Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For
* Comparison, you must enter LT (for "Less than").
*
*
*
*
* 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 {@link #hasHistoricalMetrics} method.
*
*
* @return 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.
*
* This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from
* the documented list).
*
*
*
* - ABANDON_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - AFTER_CONTACT_WORK_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - API_CONTACTS_HANDLED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CALLBACK_CONTACTS_HANDLED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_ABANDONED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_AGENT_HUNG_UP_FIRST
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_CONSULTED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_HANDLED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_HANDLED_INCOMING
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_HANDLED_OUTBOUND
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_HOLD_ABANDONS
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_MISSED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_QUEUED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_TRANSFERRED_IN
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_TRANSFERRED_IN_FROM_QUEUE
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_TRANSFERRED_OUT
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - HANDLE_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - HOLD_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - INTERACTION_AND_HOLD_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - INTERACTION_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - OCCUPANCY
* -
*
* Unit: PERCENT
*
*
* Statistic: AVG
*
*
* - QUEUE_ANSWER_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - QUEUED_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: MAX
*
*
* - SERVICE_LEVEL
* -
*
* You can include up to 20 SERVICE_LEVEL metrics in a request.
*
*
* Unit: PERCENT
*
*
* Statistic: AVG
*
*
* Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in
* seconds. For Comparison, you must enter LT (for "Less than").
*
*
*/
public final List historicalMetrics() {
return historicalMetrics;
}
/**
*
* 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.
*
*
* @return 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 final String nextToken() {
return nextToken;
}
/**
*
* The maximum number of results to return per page.
*
*
* @return The maximum number of results to return per page.
*/
public final Integer maxResults() {
return maxResults;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(instanceId());
hashCode = 31 * hashCode + Objects.hashCode(startTime());
hashCode = 31 * hashCode + Objects.hashCode(endTime());
hashCode = 31 * hashCode + Objects.hashCode(filters());
hashCode = 31 * hashCode + Objects.hashCode(hasGroupings() ? groupingsAsStrings() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasHistoricalMetrics() ? historicalMetrics() : null);
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(maxResults());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof GetMetricDataRequest)) {
return false;
}
GetMetricDataRequest other = (GetMetricDataRequest) obj;
return Objects.equals(instanceId(), other.instanceId()) && Objects.equals(startTime(), other.startTime())
&& Objects.equals(endTime(), other.endTime()) && Objects.equals(filters(), other.filters())
&& hasGroupings() == other.hasGroupings() && Objects.equals(groupingsAsStrings(), other.groupingsAsStrings())
&& hasHistoricalMetrics() == other.hasHistoricalMetrics()
&& Objects.equals(historicalMetrics(), other.historicalMetrics())
&& Objects.equals(nextToken(), other.nextToken()) && Objects.equals(maxResults(), other.maxResults());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("GetMetricDataRequest").add("InstanceId", instanceId()).add("StartTime", startTime())
.add("EndTime", endTime()).add("Filters", filters())
.add("Groupings", hasGroupings() ? groupingsAsStrings() : null)
.add("HistoricalMetrics", hasHistoricalMetrics() ? historicalMetrics() : null).add("NextToken", nextToken())
.add("MaxResults", maxResults()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "InstanceId":
return Optional.ofNullable(clazz.cast(instanceId()));
case "StartTime":
return Optional.ofNullable(clazz.cast(startTime()));
case "EndTime":
return Optional.ofNullable(clazz.cast(endTime()));
case "Filters":
return Optional.ofNullable(clazz.cast(filters()));
case "Groupings":
return Optional.ofNullable(clazz.cast(groupingsAsStrings()));
case "HistoricalMetrics":
return Optional.ofNullable(clazz.cast(historicalMetrics()));
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "MaxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((GetMetricDataRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends ConnectRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The identifier of the Amazon Connect instance. You can find the instance ID
* in the Amazon Resource Name (ARN) of the instance.
*
*
* @param instanceId
* The identifier of the Amazon Connect instance. You can find the instance
* ID in the Amazon Resource Name (ARN) of the instance.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder instanceId(String instanceId);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder startTime(Instant startTime);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder endTime(Instant endTime);
/**
*
* 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. VOICE, CHAT, and TASK channels are supported.
*
*
* RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2
* for more up-to-date features.
*
*
*
* To filter by Queues, enter the queue ID/ARN, not the name of the queue.
*
*
*
* @param 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. VOICE, CHAT, and TASK channels are supported.
*
* RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to
* GetMetricDataV2 for more up-to-date features.
*
*
*
* To filter by Queues, enter the queue ID/ARN, not the name of the queue.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder filters(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. VOICE, CHAT, and TASK channels are supported.
*
*
* RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2
* for more up-to-date features.
*
*
*
* To filter by Queues, enter the queue ID/ARN, not the name of the queue.
*
* This is a convenience method that creates an instance of the {@link Filters.Builder} avoiding the
* need to create one manually via {@link Filters#builder()}.
*
*
* When the {@link Consumer} completes, {@link Filters.Builder#build()} is called immediately and its result is
* passed to {@link #filters(Filters)}.
*
* @param filters
* a consumer that will call methods on {@link Filters.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #filters(Filters)
*/
default Builder filters(Consumer filters) {
return filters(Filters.builder().applyMutation(filters).build());
}
/**
*
* 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.
*
*
* If no grouping is specified, a summary of metrics for all queues is returned.
*
*
* RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2
* for more up-to-date features.
*
*
* @param 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.
*
* If no grouping is specified, a summary of metrics for all queues is returned.
*
*
* RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to
* GetMetricDataV2 for more up-to-date features.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder groupingsWithStrings(Collection 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.
*
*
* If no grouping is specified, a summary of metrics for all queues is returned.
*
*
* RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2
* for more up-to-date features.
*
*
* @param 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.
*
* If no grouping is specified, a summary of metrics for all queues is returned.
*
*
* RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to
* GetMetricDataV2 for more up-to-date features.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder groupingsWithStrings(String... 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.
*
*
* If no grouping is specified, a summary of metrics for all queues is returned.
*
*
* RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2
* for more up-to-date features.
*
*
* @param 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.
*
* If no grouping is specified, a summary of metrics for all queues is returned.
*
*
* RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to
* GetMetricDataV2 for more up-to-date features.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder groupings(Collection 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.
*
*
* If no grouping is specified, a summary of metrics for all queues is returned.
*
*
* RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2
* for more up-to-date features.
*
*
* @param 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.
*
* If no grouping is specified, a summary of metrics for all queues is returned.
*
*
* RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to
* GetMetricDataV2 for more up-to-date features.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder groupings(Grouping... groupings);
/**
*
* 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.
*
*
*
* This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the
* documented list).
*
*
*
* - ABANDON_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - AFTER_CONTACT_WORK_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - API_CONTACTS_HANDLED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CALLBACK_CONTACTS_HANDLED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_ABANDONED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_AGENT_HUNG_UP_FIRST
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_CONSULTED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_HANDLED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_HANDLED_INCOMING
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_HANDLED_OUTBOUND
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_HOLD_ABANDONS
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_MISSED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_QUEUED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_TRANSFERRED_IN
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_TRANSFERRED_IN_FROM_QUEUE
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_TRANSFERRED_OUT
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - HANDLE_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - HOLD_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - INTERACTION_AND_HOLD_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - INTERACTION_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - OCCUPANCY
* -
*
* Unit: PERCENT
*
*
* Statistic: AVG
*
*
* - QUEUE_ANSWER_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - QUEUED_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: MAX
*
*
* - SERVICE_LEVEL
* -
*
* You can include up to 20 SERVICE_LEVEL metrics in a request.
*
*
* Unit: PERCENT
*
*
* Statistic: AVG
*
*
* Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds.
* For Comparison, you must enter LT (for "Less than").
*
*
*
*
* @param 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.
*
* This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from
* the documented list).
*
*
*
* - ABANDON_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - AFTER_CONTACT_WORK_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - API_CONTACTS_HANDLED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CALLBACK_CONTACTS_HANDLED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_ABANDONED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_AGENT_HUNG_UP_FIRST
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_CONSULTED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_HANDLED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_HANDLED_INCOMING
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_HANDLED_OUTBOUND
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_HOLD_ABANDONS
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_MISSED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_QUEUED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_TRANSFERRED_IN
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_TRANSFERRED_IN_FROM_QUEUE
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_TRANSFERRED_OUT
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - HANDLE_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - HOLD_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - INTERACTION_AND_HOLD_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - INTERACTION_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - OCCUPANCY
* -
*
* Unit: PERCENT
*
*
* Statistic: AVG
*
*
* - QUEUE_ANSWER_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - QUEUED_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: MAX
*
*
* - SERVICE_LEVEL
* -
*
* You can include up to 20 SERVICE_LEVEL metrics in a request.
*
*
* Unit: PERCENT
*
*
* Statistic: AVG
*
*
* Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in
* seconds. For Comparison, you must enter LT (for "Less than").
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder historicalMetrics(Collection 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.
*
*
*
* This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the
* documented list).
*
*
*
* - ABANDON_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - AFTER_CONTACT_WORK_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - API_CONTACTS_HANDLED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CALLBACK_CONTACTS_HANDLED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_ABANDONED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_AGENT_HUNG_UP_FIRST
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_CONSULTED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_HANDLED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_HANDLED_INCOMING
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_HANDLED_OUTBOUND
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_HOLD_ABANDONS
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_MISSED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_QUEUED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_TRANSFERRED_IN
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_TRANSFERRED_IN_FROM_QUEUE
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_TRANSFERRED_OUT
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - HANDLE_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - HOLD_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - INTERACTION_AND_HOLD_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - INTERACTION_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - OCCUPANCY
* -
*
* Unit: PERCENT
*
*
* Statistic: AVG
*
*
* - QUEUE_ANSWER_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - QUEUED_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: MAX
*
*
* - SERVICE_LEVEL
* -
*
* You can include up to 20 SERVICE_LEVEL metrics in a request.
*
*
* Unit: PERCENT
*
*
* Statistic: AVG
*
*
* Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds.
* For Comparison, you must enter LT (for "Less than").
*
*
*
*
* @param 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.
*
* This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from
* the documented list).
*
*
*
* - ABANDON_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - AFTER_CONTACT_WORK_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - API_CONTACTS_HANDLED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CALLBACK_CONTACTS_HANDLED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_ABANDONED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_AGENT_HUNG_UP_FIRST
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_CONSULTED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_HANDLED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_HANDLED_INCOMING
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_HANDLED_OUTBOUND
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_HOLD_ABANDONS
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_MISSED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_QUEUED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_TRANSFERRED_IN
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_TRANSFERRED_IN_FROM_QUEUE
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_TRANSFERRED_OUT
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - HANDLE_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - HOLD_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - INTERACTION_AND_HOLD_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - INTERACTION_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - OCCUPANCY
* -
*
* Unit: PERCENT
*
*
* Statistic: AVG
*
*
* - QUEUE_ANSWER_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - QUEUED_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: MAX
*
*
* - SERVICE_LEVEL
* -
*
* You can include up to 20 SERVICE_LEVEL metrics in a request.
*
*
* Unit: PERCENT
*
*
* Statistic: AVG
*
*
* Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in
* seconds. For Comparison, you must enter LT (for "Less than").
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder historicalMetrics(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.
*
*
*
* This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the
* documented list).
*
*
*
* - ABANDON_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - AFTER_CONTACT_WORK_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - API_CONTACTS_HANDLED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CALLBACK_CONTACTS_HANDLED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_ABANDONED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_AGENT_HUNG_UP_FIRST
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_CONSULTED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_HANDLED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_HANDLED_INCOMING
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_HANDLED_OUTBOUND
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_HOLD_ABANDONS
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_MISSED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_QUEUED
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_TRANSFERRED_IN
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_TRANSFERRED_IN_FROM_QUEUE
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_TRANSFERRED_OUT
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
* -
*
* Unit: COUNT
*
*
* Statistic: SUM
*
*
* - HANDLE_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - HOLD_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - INTERACTION_AND_HOLD_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - INTERACTION_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - OCCUPANCY
* -
*
* Unit: PERCENT
*
*
* Statistic: AVG
*
*
* - QUEUE_ANSWER_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: AVG
*
*
* - QUEUED_TIME
* -
*
* Unit: SECONDS
*
*
* Statistic: MAX
*
*
* - SERVICE_LEVEL
* -
*
* You can include up to 20 SERVICE_LEVEL metrics in a request.
*
*
* Unit: PERCENT
*
*
* Statistic: AVG
*
*
* Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds.
* For Comparison, you must enter LT (for "Less than").
*
*
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.connect.model.HistoricalMetric.Builder} avoiding the need to create
* one manually via {@link software.amazon.awssdk.services.connect.model.HistoricalMetric#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.connect.model.HistoricalMetric.Builder#build()} is called immediately
* and its result is passed to {@link #historicalMetrics(List)}.
*
* @param historicalMetrics
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.connect.model.HistoricalMetric.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #historicalMetrics(java.util.Collection)
*/
Builder historicalMetrics(Consumer... historicalMetrics);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
*
* The maximum number of results to return per page.
*
*
* @param maxResults
* The maximum number of results to return per page.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxResults(Integer maxResults);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends ConnectRequest.BuilderImpl implements Builder {
private String instanceId;
private Instant startTime;
private Instant endTime;
private Filters filters;
private List groupings = DefaultSdkAutoConstructList.getInstance();
private List historicalMetrics = DefaultSdkAutoConstructList.getInstance();
private String nextToken;
private Integer maxResults;
private BuilderImpl() {
}
private BuilderImpl(GetMetricDataRequest model) {
super(model);
instanceId(model.instanceId);
startTime(model.startTime);
endTime(model.endTime);
filters(model.filters);
groupingsWithStrings(model.groupings);
historicalMetrics(model.historicalMetrics);
nextToken(model.nextToken);
maxResults(model.maxResults);
}
public final String getInstanceId() {
return instanceId;
}
public final void setInstanceId(String instanceId) {
this.instanceId = instanceId;
}
@Override
public final Builder instanceId(String instanceId) {
this.instanceId = instanceId;
return this;
}
public final Instant getStartTime() {
return startTime;
}
public final void setStartTime(Instant startTime) {
this.startTime = startTime;
}
@Override
public final Builder startTime(Instant startTime) {
this.startTime = startTime;
return this;
}
public final Instant getEndTime() {
return endTime;
}
public final void setEndTime(Instant endTime) {
this.endTime = endTime;
}
@Override
public final Builder endTime(Instant endTime) {
this.endTime = endTime;
return this;
}
public final Filters.Builder getFilters() {
return filters != null ? filters.toBuilder() : null;
}
public final void setFilters(Filters.BuilderImpl filters) {
this.filters = filters != null ? filters.build() : null;
}
@Override
public final Builder filters(Filters filters) {
this.filters = filters;
return this;
}
public final Collection getGroupings() {
if (groupings instanceof SdkAutoConstructList) {
return null;
}
return groupings;
}
public final void setGroupings(Collection groupings) {
this.groupings = GroupingsCopier.copy(groupings);
}
@Override
public final Builder groupingsWithStrings(Collection groupings) {
this.groupings = GroupingsCopier.copy(groupings);
return this;
}
@Override
@SafeVarargs
public final Builder groupingsWithStrings(String... groupings) {
groupingsWithStrings(Arrays.asList(groupings));
return this;
}
@Override
public final Builder groupings(Collection groupings) {
this.groupings = GroupingsCopier.copyEnumToString(groupings);
return this;
}
@Override
@SafeVarargs
public final Builder groupings(Grouping... groupings) {
groupings(Arrays.asList(groupings));
return this;
}
public final List getHistoricalMetrics() {
List result = HistoricalMetricsCopier.copyToBuilder(this.historicalMetrics);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setHistoricalMetrics(Collection historicalMetrics) {
this.historicalMetrics = HistoricalMetricsCopier.copyFromBuilder(historicalMetrics);
}
@Override
public final Builder historicalMetrics(Collection historicalMetrics) {
this.historicalMetrics = HistoricalMetricsCopier.copy(historicalMetrics);
return this;
}
@Override
@SafeVarargs
public final Builder historicalMetrics(HistoricalMetric... historicalMetrics) {
historicalMetrics(Arrays.asList(historicalMetrics));
return this;
}
@Override
@SafeVarargs
public final Builder historicalMetrics(Consumer... historicalMetrics) {
historicalMetrics(Stream.of(historicalMetrics).map(c -> HistoricalMetric.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final String getNextToken() {
return nextToken;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
@Override
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
public final Integer getMaxResults() {
return maxResults;
}
public final void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
@Override
public final Builder maxResults(Integer maxResults) {
this.maxResults = maxResults;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public GetMetricDataRequest build() {
return new GetMetricDataRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}