software.amazon.awssdk.services.connect.model.GetCurrentMetricDataRequest 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.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 GetCurrentMetricDataRequest extends ConnectRequest implements
ToCopyableBuilder {
private static final SdkField INSTANCE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("InstanceId").getter(getter(GetCurrentMetricDataRequest::instanceId)).setter(setter(Builder::instanceId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("InstanceId").build()).build();
private static final SdkField FILTERS_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("Filters").getter(getter(GetCurrentMetricDataRequest::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(GetCurrentMetricDataRequest::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> CURRENT_METRICS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("CurrentMetrics")
.getter(getter(GetCurrentMetricDataRequest::currentMetrics))
.setter(setter(Builder::currentMetrics))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CurrentMetrics").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(CurrentMetric::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(GetCurrentMetricDataRequest::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(GetCurrentMetricDataRequest::maxResults)).setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxResults").build()).build();
private static final SdkField> SORT_CRITERIA_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("SortCriteria")
.getter(getter(GetCurrentMetricDataRequest::sortCriteria))
.setter(setter(Builder::sortCriteria))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SortCriteria").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(CurrentMetricSortCriteria::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(INSTANCE_ID_FIELD,
FILTERS_FIELD, GROUPINGS_FIELD, CURRENT_METRICS_FIELD, NEXT_TOKEN_FIELD, MAX_RESULTS_FIELD, SORT_CRITERIA_FIELD));
private final String instanceId;
private final Filters filters;
private final List groupings;
private final List currentMetrics;
private final String nextToken;
private final Integer maxResults;
private final List sortCriteria;
private GetCurrentMetricDataRequest(BuilderImpl builder) {
super(builder);
this.instanceId = builder.instanceId;
this.filters = builder.filters;
this.groupings = builder.groupings;
this.currentMetrics = builder.currentMetrics;
this.nextToken = builder.nextToken;
this.maxResults = builder.maxResults;
this.sortCriteria = builder.sortCriteria;
}
/**
*
* 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 filters to apply to returned metrics. You can filter up to the following limits:
*
*
* -
*
* Queues: 100
*
*
* -
*
* Routing profiles: 100
*
*
* -
*
* Channels: 3 (VOICE, CHAT, and TASK channels are supported.)
*
*
* -
*
* RoutingStepExpressions: 50
*
*
*
*
* Metric data is retrieved only for the resources associated with the queues or routing profiles, and by any
* channels included in the filter. (You cannot filter by both queue AND routing profile.) You can include both
* resource IDs and resource ARNs in the same request.
*
*
* When using the RoutingStepExpression filter, you need to pass exactly one QueueId. The
* filter is also case sensitive so when using the RoutingStepExpression filter, grouping by
* ROUTING_STEP_EXPRESSION is required.
*
*
* Currently tagging is only supported on the resources that are passed in the filter.
*
*
* @return The filters to apply to returned metrics. You can filter up to the following limits:
*
* -
*
* Queues: 100
*
*
* -
*
* Routing profiles: 100
*
*
* -
*
* Channels: 3 (VOICE, CHAT, and TASK channels are supported.)
*
*
* -
*
* RoutingStepExpressions: 50
*
*
*
*
* Metric data is retrieved only for the resources associated with the queues or routing profiles, and by
* any channels included in the filter. (You cannot filter by both queue AND routing profile.) You can
* include both resource IDs and resource ARNs in the same request.
*
*
* When using the RoutingStepExpression filter, you need to pass exactly one
* QueueId. The filter is also case sensitive so when using the
* RoutingStepExpression filter, grouping by ROUTING_STEP_EXPRESSION is required.
*
*
* Currently tagging is only supported on the resources that are passed in the filter.
*/
public final Filters filters() {
return filters;
}
/**
*
* The grouping applied to the metrics returned. For example, when grouped by QUEUE, the metrics
* returned apply to each queue rather than aggregated for all queues.
*
*
* -
*
* If you group by CHANNEL, you should include a Channels filter. VOICE, CHAT, and TASK channels are
* supported.
*
*
* -
*
* If you group by ROUTING_PROFILE, you must include either a queue or routing profile filter. In
* addition, a routing profile filter is required for metrics CONTACTS_SCHEDULED,
* CONTACTS_IN_QUEUE, and OLDEST_CONTACT_AGE.
*
*
* -
*
* If no Grouping is included in the request, a summary of metrics is returned.
*
*
* -
*
* When using the RoutingStepExpression filter, group by ROUTING_STEP_EXPRESSION is
* required.
*
*
*
*
* 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 grouped by QUEUE, the
* metrics returned apply to each queue rather than aggregated for all queues.
*
* -
*
* If you group by CHANNEL, you should include a Channels filter. VOICE, CHAT, and TASK
* channels are supported.
*
*
* -
*
* If you group by ROUTING_PROFILE, you must include either a queue or routing profile filter.
* In addition, a routing profile filter is required for metrics CONTACTS_SCHEDULED,
* CONTACTS_IN_QUEUE, and OLDEST_CONTACT_AGE.
*
*
* -
*
* If no Grouping is included in the request, a summary of metrics is returned.
*
*
* -
*
* When using the RoutingStepExpression filter, group by ROUTING_STEP_EXPRESSION
* is required.
*
*
*/
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 grouped by QUEUE, the metrics
* returned apply to each queue rather than aggregated for all queues.
*
*
* -
*
* If you group by CHANNEL, you should include a Channels filter. VOICE, CHAT, and TASK channels are
* supported.
*
*
* -
*
* If you group by ROUTING_PROFILE, you must include either a queue or routing profile filter. In
* addition, a routing profile filter is required for metrics CONTACTS_SCHEDULED,
* CONTACTS_IN_QUEUE, and OLDEST_CONTACT_AGE.
*
*
* -
*
* If no Grouping is included in the request, a summary of metrics is returned.
*
*
* -
*
* When using the RoutingStepExpression filter, group by ROUTING_STEP_EXPRESSION is
* required.
*
*
*
*
* 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 grouped by QUEUE, the
* metrics returned apply to each queue rather than aggregated for all queues.
*
* -
*
* If you group by CHANNEL, you should include a Channels filter. VOICE, CHAT, and TASK
* channels are supported.
*
*
* -
*
* If you group by ROUTING_PROFILE, you must include either a queue or routing profile filter.
* In addition, a routing profile filter is required for metrics CONTACTS_SCHEDULED,
* CONTACTS_IN_QUEUE, and OLDEST_CONTACT_AGE.
*
*
* -
*
* If no Grouping is included in the request, a summary of metrics is returned.
*
*
* -
*
* When using the RoutingStepExpression filter, group by ROUTING_STEP_EXPRESSION
* is required.
*
*
*/
public final List groupingsAsStrings() {
return groupings;
}
/**
* For responses, this returns true if the service returned a value for the CurrentMetrics 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 hasCurrentMetrics() {
return currentMetrics != null && !(currentMetrics instanceof SdkAutoConstructList);
}
/**
*
* The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available. For a
* description of all the metrics, see Real-time Metrics
* Definitions in the Amazon Connect Administrator Guide.
*
*
* - AGENTS_AFTER_CONTACT_WORK
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: ACW
*
*
* - AGENTS_AVAILABLE
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Available
*
*
* - AGENTS_ERROR
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Error
*
*
* - AGENTS_NON_PRODUCTIVE
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: NPT (Non-Productive Time)
*
*
* - AGENTS_ON_CALL
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: On
* contact
*
*
* - AGENTS_ON_CONTACT
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: On
* contact
*
*
* - AGENTS_ONLINE
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Online
*
*
* - AGENTS_STAFFED
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Staffed
*
*
* - CONTACTS_IN_QUEUE
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: In
* queue
*
*
* - CONTACTS_SCHEDULED
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Scheduled
*
*
* - OLDEST_CONTACT_AGE
* -
*
* Unit: SECONDS
*
*
* When you use groupings, Unit says SECONDS and the Value is returned in SECONDS.
*
*
* When you do not use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you
* get a response like this:
*
*
* { "Metric": { "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" }, "Value": 24113.0
*
*
* The actual OLDEST_CONTACT_AGE is 24 seconds.
*
*
* When the filter RoutingStepExpression is used, this metric is still calculated from enqueue time.
* For example, if a contact that has been queued under <Expression 1> for 10 seconds has expired
* and <Expression 2> becomes active, then OLDEST_CONTACT_AGE for this queue will be
* counted starting from 10, not 0.
*
*
* Name in real-time metrics report: Oldest
*
*
* - SLOTS_ACTIVE
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Active
*
*
* - SLOTS_AVAILABLE
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Availability
*
*
*
*
* 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 #hasCurrentMetrics} method.
*
*
* @return The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available.
* For a description of all the metrics, see Real-time
* Metrics Definitions in the Amazon Connect Administrator Guide.
*
* - AGENTS_AFTER_CONTACT_WORK
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: ACW
*
*
* - AGENTS_AVAILABLE
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Available
*
*
* - AGENTS_ERROR
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Error
*
*
* - AGENTS_NON_PRODUCTIVE
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: NPT (Non-Productive Time)
*
*
* - AGENTS_ON_CALL
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: On contact
*
*
* - AGENTS_ON_CONTACT
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: On contact
*
*
* - AGENTS_ONLINE
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Online
*
*
* - AGENTS_STAFFED
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Staffed
*
*
* - CONTACTS_IN_QUEUE
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: In queue
*
*
* - CONTACTS_SCHEDULED
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Scheduled
*
*
* - OLDEST_CONTACT_AGE
* -
*
* Unit: SECONDS
*
*
* When you use groupings, Unit says SECONDS and the Value is returned in SECONDS.
*
*
* When you do not use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example,
* if you get a response like this:
*
*
* { "Metric": { "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" }, "Value": 24113.0
*
*
* The actual OLDEST_CONTACT_AGE is 24 seconds.
*
*
* When the filter RoutingStepExpression is used, this metric is still calculated from enqueue
* time. For example, if a contact that has been queued under <Expression 1> for 10
* seconds has expired and <Expression 2> becomes active, then
* OLDEST_CONTACT_AGE for this queue will be counted starting from 10, not 0.
*
*
* Name in real-time metrics report: Oldest
*
*
* - SLOTS_ACTIVE
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Active
*
*
* - SLOTS_AVAILABLE
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Availability
*
*
*/
public final List currentMetrics() {
return currentMetrics;
}
/**
*
* The token for the next set of results. Use the value returned in the previous response in the next request to
* retrieve the next set of results.
*
*
* The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use
* the same request parameters as the request that generated the token.
*
*
* @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.
*
* The token expires after 5 minutes from the time it is created. Subsequent requests that use the token
* must use the same request parameters as the request that generated the token.
*/
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;
}
/**
* For responses, this returns true if the service returned a value for the SortCriteria 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 hasSortCriteria() {
return sortCriteria != null && !(sortCriteria instanceof SdkAutoConstructList);
}
/**
*
* The way to sort the resulting response based on metrics. You can enter one sort criteria. By default resources
* are sorted based on AGENTS_ONLINE, DESCENDING. The metric collection is sorted based on
* the input metrics.
*
*
* Note the following:
*
*
* -
*
* Sorting on SLOTS_ACTIVE and SLOTS_AVAILABLE is not supported.
*
*
*
*
* 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 #hasSortCriteria} method.
*
*
* @return The way to sort the resulting response based on metrics. You can enter one sort criteria. By default
* resources are sorted based on AGENTS_ONLINE, DESCENDING. The metric collection
* is sorted based on the input metrics.
*
* Note the following:
*
*
* -
*
* Sorting on SLOTS_ACTIVE and SLOTS_AVAILABLE is not supported.
*
*
*/
public final List sortCriteria() {
return sortCriteria;
}
@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(filters());
hashCode = 31 * hashCode + Objects.hashCode(hasGroupings() ? groupingsAsStrings() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasCurrentMetrics() ? currentMetrics() : null);
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(maxResults());
hashCode = 31 * hashCode + Objects.hashCode(hasSortCriteria() ? sortCriteria() : null);
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 GetCurrentMetricDataRequest)) {
return false;
}
GetCurrentMetricDataRequest other = (GetCurrentMetricDataRequest) obj;
return Objects.equals(instanceId(), other.instanceId()) && Objects.equals(filters(), other.filters())
&& hasGroupings() == other.hasGroupings() && Objects.equals(groupingsAsStrings(), other.groupingsAsStrings())
&& hasCurrentMetrics() == other.hasCurrentMetrics() && Objects.equals(currentMetrics(), other.currentMetrics())
&& Objects.equals(nextToken(), other.nextToken()) && Objects.equals(maxResults(), other.maxResults())
&& hasSortCriteria() == other.hasSortCriteria() && Objects.equals(sortCriteria(), other.sortCriteria());
}
/**
* 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("GetCurrentMetricDataRequest").add("InstanceId", instanceId()).add("Filters", filters())
.add("Groupings", hasGroupings() ? groupingsAsStrings() : null)
.add("CurrentMetrics", hasCurrentMetrics() ? currentMetrics() : null).add("NextToken", nextToken())
.add("MaxResults", maxResults()).add("SortCriteria", hasSortCriteria() ? sortCriteria() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "InstanceId":
return Optional.ofNullable(clazz.cast(instanceId()));
case "Filters":
return Optional.ofNullable(clazz.cast(filters()));
case "Groupings":
return Optional.ofNullable(clazz.cast(groupingsAsStrings()));
case "CurrentMetrics":
return Optional.ofNullable(clazz.cast(currentMetrics()));
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "MaxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
case "SortCriteria":
return Optional.ofNullable(clazz.cast(sortCriteria()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((GetCurrentMetricDataRequest) 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 filters to apply to returned metrics. You can filter up to the following limits:
*
*
* -
*
* Queues: 100
*
*
* -
*
* Routing profiles: 100
*
*
* -
*
* Channels: 3 (VOICE, CHAT, and TASK channels are supported.)
*
*
* -
*
* RoutingStepExpressions: 50
*
*
*
*
* Metric data is retrieved only for the resources associated with the queues or routing profiles, and by any
* channels included in the filter. (You cannot filter by both queue AND routing profile.) You can include both
* resource IDs and resource ARNs in the same request.
*
*
* When using the RoutingStepExpression filter, you need to pass exactly one QueueId.
* The filter is also case sensitive so when using the RoutingStepExpression filter, grouping by
* ROUTING_STEP_EXPRESSION is required.
*
*
* Currently tagging is only supported on the resources that are passed in the filter.
*
*
* @param filters
* The filters to apply to returned metrics. You can filter up to the following limits:
*
* -
*
* Queues: 100
*
*
* -
*
* Routing profiles: 100
*
*
* -
*
* Channels: 3 (VOICE, CHAT, and TASK channels are supported.)
*
*
* -
*
* RoutingStepExpressions: 50
*
*
*
*
* Metric data is retrieved only for the resources associated with the queues or routing profiles, and by
* any channels included in the filter. (You cannot filter by both queue AND routing profile.) You can
* include both resource IDs and resource ARNs in the same request.
*
*
* When using the RoutingStepExpression filter, you need to pass exactly one
* QueueId. The filter is also case sensitive so when using the
* RoutingStepExpression filter, grouping by ROUTING_STEP_EXPRESSION is
* required.
*
*
* Currently tagging is only supported on the resources that are passed in the filter.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder filters(Filters filters);
/**
*
* The filters to apply to returned metrics. You can filter up to the following limits:
*
*
* -
*
* Queues: 100
*
*
* -
*
* Routing profiles: 100
*
*
* -
*
* Channels: 3 (VOICE, CHAT, and TASK channels are supported.)
*
*
* -
*
* RoutingStepExpressions: 50
*
*
*
*
* Metric data is retrieved only for the resources associated with the queues or routing profiles, and by any
* channels included in the filter. (You cannot filter by both queue AND routing profile.) You can include both
* resource IDs and resource ARNs in the same request.
*
*
* When using the RoutingStepExpression filter, you need to pass exactly one QueueId.
* The filter is also case sensitive so when using the RoutingStepExpression filter, grouping by
* ROUTING_STEP_EXPRESSION is required.
*
*
* Currently tagging is only supported on the resources that are passed in the filter.
*
* 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 grouped by QUEUE, the metrics
* returned apply to each queue rather than aggregated for all queues.
*
*
* -
*
* If you group by CHANNEL, you should include a Channels filter. VOICE, CHAT, and TASK channels
* are supported.
*
*
* -
*
* If you group by ROUTING_PROFILE, you must include either a queue or routing profile filter. In
* addition, a routing profile filter is required for metrics CONTACTS_SCHEDULED,
* CONTACTS_IN_QUEUE, and OLDEST_CONTACT_AGE.
*
*
* -
*
* If no Grouping is included in the request, a summary of metrics is returned.
*
*
* -
*
* When using the RoutingStepExpression filter, group by ROUTING_STEP_EXPRESSION is
* required.
*
*
*
*
* @param groupings
* The grouping applied to the metrics returned. For example, when grouped by QUEUE, the
* metrics returned apply to each queue rather than aggregated for all queues.
*
* -
*
* If you group by CHANNEL, you should include a Channels filter. VOICE, CHAT, and TASK
* channels are supported.
*
*
* -
*
* If you group by ROUTING_PROFILE, you must include either a queue or routing profile
* filter. In addition, a routing profile filter is required for metrics CONTACTS_SCHEDULED,
* CONTACTS_IN_QUEUE, and OLDEST_CONTACT_AGE.
*
*
* -
*
* If no Grouping is included in the request, a summary of metrics is returned.
*
*
* -
*
* When using the RoutingStepExpression filter, group by
* ROUTING_STEP_EXPRESSION is required.
*
*
* @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 grouped by QUEUE, the metrics
* returned apply to each queue rather than aggregated for all queues.
*
*
* -
*
* If you group by CHANNEL, you should include a Channels filter. VOICE, CHAT, and TASK channels
* are supported.
*
*
* -
*
* If you group by ROUTING_PROFILE, you must include either a queue or routing profile filter. In
* addition, a routing profile filter is required for metrics CONTACTS_SCHEDULED,
* CONTACTS_IN_QUEUE, and OLDEST_CONTACT_AGE.
*
*
* -
*
* If no Grouping is included in the request, a summary of metrics is returned.
*
*
* -
*
* When using the RoutingStepExpression filter, group by ROUTING_STEP_EXPRESSION is
* required.
*
*
*
*
* @param groupings
* The grouping applied to the metrics returned. For example, when grouped by QUEUE, the
* metrics returned apply to each queue rather than aggregated for all queues.
*
* -
*
* If you group by CHANNEL, you should include a Channels filter. VOICE, CHAT, and TASK
* channels are supported.
*
*
* -
*
* If you group by ROUTING_PROFILE, you must include either a queue or routing profile
* filter. In addition, a routing profile filter is required for metrics CONTACTS_SCHEDULED,
* CONTACTS_IN_QUEUE, and OLDEST_CONTACT_AGE.
*
*
* -
*
* If no Grouping is included in the request, a summary of metrics is returned.
*
*
* -
*
* When using the RoutingStepExpression filter, group by
* ROUTING_STEP_EXPRESSION is required.
*
*
* @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 grouped by QUEUE, the metrics
* returned apply to each queue rather than aggregated for all queues.
*
*
* -
*
* If you group by CHANNEL, you should include a Channels filter. VOICE, CHAT, and TASK channels
* are supported.
*
*
* -
*
* If you group by ROUTING_PROFILE, you must include either a queue or routing profile filter. In
* addition, a routing profile filter is required for metrics CONTACTS_SCHEDULED,
* CONTACTS_IN_QUEUE, and OLDEST_CONTACT_AGE.
*
*
* -
*
* If no Grouping is included in the request, a summary of metrics is returned.
*
*
* -
*
* When using the RoutingStepExpression filter, group by ROUTING_STEP_EXPRESSION is
* required.
*
*
*
*
* @param groupings
* The grouping applied to the metrics returned. For example, when grouped by QUEUE, the
* metrics returned apply to each queue rather than aggregated for all queues.
*
* -
*
* If you group by CHANNEL, you should include a Channels filter. VOICE, CHAT, and TASK
* channels are supported.
*
*
* -
*
* If you group by ROUTING_PROFILE, you must include either a queue or routing profile
* filter. In addition, a routing profile filter is required for metrics CONTACTS_SCHEDULED,
* CONTACTS_IN_QUEUE, and OLDEST_CONTACT_AGE.
*
*
* -
*
* If no Grouping is included in the request, a summary of metrics is returned.
*
*
* -
*
* When using the RoutingStepExpression filter, group by
* ROUTING_STEP_EXPRESSION is required.
*
*
* @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 grouped by QUEUE, the metrics
* returned apply to each queue rather than aggregated for all queues.
*
*
* -
*
* If you group by CHANNEL, you should include a Channels filter. VOICE, CHAT, and TASK channels
* are supported.
*
*
* -
*
* If you group by ROUTING_PROFILE, you must include either a queue or routing profile filter. In
* addition, a routing profile filter is required for metrics CONTACTS_SCHEDULED,
* CONTACTS_IN_QUEUE, and OLDEST_CONTACT_AGE.
*
*
* -
*
* If no Grouping is included in the request, a summary of metrics is returned.
*
*
* -
*
* When using the RoutingStepExpression filter, group by ROUTING_STEP_EXPRESSION is
* required.
*
*
*
*
* @param groupings
* The grouping applied to the metrics returned. For example, when grouped by QUEUE, the
* metrics returned apply to each queue rather than aggregated for all queues.
*
* -
*
* If you group by CHANNEL, you should include a Channels filter. VOICE, CHAT, and TASK
* channels are supported.
*
*
* -
*
* If you group by ROUTING_PROFILE, you must include either a queue or routing profile
* filter. In addition, a routing profile filter is required for metrics CONTACTS_SCHEDULED,
* CONTACTS_IN_QUEUE, and OLDEST_CONTACT_AGE.
*
*
* -
*
* If no Grouping is included in the request, a summary of metrics is returned.
*
*
* -
*
* When using the RoutingStepExpression filter, group by
* ROUTING_STEP_EXPRESSION is required.
*
*
* @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 and unit for each metric. The following metrics are available. For
* a description of all the metrics, see Real-time
* Metrics Definitions in the Amazon Connect Administrator Guide.
*
*
* - AGENTS_AFTER_CONTACT_WORK
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: ACW
*
*
* - AGENTS_AVAILABLE
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Available
*
*
* - AGENTS_ERROR
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Error
*
*
* - AGENTS_NON_PRODUCTIVE
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: NPT (Non-Productive Time)
*
*
* - AGENTS_ON_CALL
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: On contact
*
*
* - AGENTS_ON_CONTACT
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: On contact
*
*
* - AGENTS_ONLINE
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Online
*
*
* - AGENTS_STAFFED
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Staffed
*
*
* - CONTACTS_IN_QUEUE
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: In queue
*
*
* - CONTACTS_SCHEDULED
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Scheduled
*
*
* - OLDEST_CONTACT_AGE
* -
*
* Unit: SECONDS
*
*
* When you use groupings, Unit says SECONDS and the Value is returned in SECONDS.
*
*
* When you do not use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if
* you get a response like this:
*
*
* { "Metric": { "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" }, "Value": 24113.0
*
*
* The actual OLDEST_CONTACT_AGE is 24 seconds.
*
*
* When the filter RoutingStepExpression is used, this metric is still calculated from enqueue
* time. For example, if a contact that has been queued under <Expression 1> for 10 seconds
* has expired and <Expression 2> becomes active, then OLDEST_CONTACT_AGE for
* this queue will be counted starting from 10, not 0.
*
*
* Name in real-time metrics report: Oldest
*
*
* - SLOTS_ACTIVE
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Active
*
*
* - SLOTS_AVAILABLE
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Availability
*
*
*
*
* @param currentMetrics
* The metrics to retrieve. Specify the name and unit for each metric. The following metrics are
* available. For a description of all the metrics, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
*
* - AGENTS_AFTER_CONTACT_WORK
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: ACW
*
*
* - AGENTS_AVAILABLE
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Available
*
*
* - AGENTS_ERROR
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Error
*
*
* - AGENTS_NON_PRODUCTIVE
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: NPT (Non-Productive Time)
*
*
* - AGENTS_ON_CALL
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: On contact
*
*
* - AGENTS_ON_CONTACT
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: On contact
*
*
* - AGENTS_ONLINE
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Online
*
*
* - AGENTS_STAFFED
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Staffed
*
*
* - CONTACTS_IN_QUEUE
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: In queue
*
*
* - CONTACTS_SCHEDULED
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Scheduled
*
*
* - OLDEST_CONTACT_AGE
* -
*
* Unit: SECONDS
*
*
* When you use groupings, Unit says SECONDS and the Value is returned in SECONDS.
*
*
* When you do not use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For
* example, if you get a response like this:
*
*
* { "Metric": { "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" }, "Value": 24113.0
*
*
* The actual OLDEST_CONTACT_AGE is 24 seconds.
*
*
* When the filter RoutingStepExpression is used, this metric is still calculated from
* enqueue time. For example, if a contact that has been queued under <Expression 1>
* for 10 seconds has expired and <Expression 2> becomes active, then
* OLDEST_CONTACT_AGE for this queue will be counted starting from 10, not 0.
*
*
* Name in real-time metrics report: Oldest
*
*
* - SLOTS_ACTIVE
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Active
*
*
* - SLOTS_AVAILABLE
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Availability
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder currentMetrics(Collection currentMetrics);
/**
*
* The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available. For
* a description of all the metrics, see Real-time
* Metrics Definitions in the Amazon Connect Administrator Guide.
*
*
* - AGENTS_AFTER_CONTACT_WORK
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: ACW
*
*
* - AGENTS_AVAILABLE
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Available
*
*
* - AGENTS_ERROR
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Error
*
*
* - AGENTS_NON_PRODUCTIVE
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: NPT (Non-Productive Time)
*
*
* - AGENTS_ON_CALL
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: On contact
*
*
* - AGENTS_ON_CONTACT
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: On contact
*
*
* - AGENTS_ONLINE
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Online
*
*
* - AGENTS_STAFFED
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Staffed
*
*
* - CONTACTS_IN_QUEUE
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: In queue
*
*
* - CONTACTS_SCHEDULED
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Scheduled
*
*
* - OLDEST_CONTACT_AGE
* -
*
* Unit: SECONDS
*
*
* When you use groupings, Unit says SECONDS and the Value is returned in SECONDS.
*
*
* When you do not use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if
* you get a response like this:
*
*
* { "Metric": { "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" }, "Value": 24113.0
*
*
* The actual OLDEST_CONTACT_AGE is 24 seconds.
*
*
* When the filter RoutingStepExpression is used, this metric is still calculated from enqueue
* time. For example, if a contact that has been queued under <Expression 1> for 10 seconds
* has expired and <Expression 2> becomes active, then OLDEST_CONTACT_AGE for
* this queue will be counted starting from 10, not 0.
*
*
* Name in real-time metrics report: Oldest
*
*
* - SLOTS_ACTIVE
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Active
*
*
* - SLOTS_AVAILABLE
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Availability
*
*
*
*
* @param currentMetrics
* The metrics to retrieve. Specify the name and unit for each metric. The following metrics are
* available. For a description of all the metrics, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
*
* - AGENTS_AFTER_CONTACT_WORK
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: ACW
*
*
* - AGENTS_AVAILABLE
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Available
*
*
* - AGENTS_ERROR
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Error
*
*
* - AGENTS_NON_PRODUCTIVE
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: NPT (Non-Productive Time)
*
*
* - AGENTS_ON_CALL
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: On contact
*
*
* - AGENTS_ON_CONTACT
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: On contact
*
*
* - AGENTS_ONLINE
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Online
*
*
* - AGENTS_STAFFED
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Staffed
*
*
* - CONTACTS_IN_QUEUE
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: In queue
*
*
* - CONTACTS_SCHEDULED
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Scheduled
*
*
* - OLDEST_CONTACT_AGE
* -
*
* Unit: SECONDS
*
*
* When you use groupings, Unit says SECONDS and the Value is returned in SECONDS.
*
*
* When you do not use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For
* example, if you get a response like this:
*
*
* { "Metric": { "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" }, "Value": 24113.0
*
*
* The actual OLDEST_CONTACT_AGE is 24 seconds.
*
*
* When the filter RoutingStepExpression is used, this metric is still calculated from
* enqueue time. For example, if a contact that has been queued under <Expression 1>
* for 10 seconds has expired and <Expression 2> becomes active, then
* OLDEST_CONTACT_AGE for this queue will be counted starting from 10, not 0.
*
*
* Name in real-time metrics report: Oldest
*
*
* - SLOTS_ACTIVE
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Active
*
*
* - SLOTS_AVAILABLE
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Availability
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder currentMetrics(CurrentMetric... currentMetrics);
/**
*
* The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available. For
* a description of all the metrics, see Real-time
* Metrics Definitions in the Amazon Connect Administrator Guide.
*
*
* - AGENTS_AFTER_CONTACT_WORK
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: ACW
*
*
* - AGENTS_AVAILABLE
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Available
*
*
* - AGENTS_ERROR
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Error
*
*
* - AGENTS_NON_PRODUCTIVE
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: NPT (Non-Productive Time)
*
*
* - AGENTS_ON_CALL
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: On contact
*
*
* - AGENTS_ON_CONTACT
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: On contact
*
*
* - AGENTS_ONLINE
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Online
*
*
* - AGENTS_STAFFED
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Staffed
*
*
* - CONTACTS_IN_QUEUE
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: In queue
*
*
* - CONTACTS_SCHEDULED
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Scheduled
*
*
* - OLDEST_CONTACT_AGE
* -
*
* Unit: SECONDS
*
*
* When you use groupings, Unit says SECONDS and the Value is returned in SECONDS.
*
*
* When you do not use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if
* you get a response like this:
*
*
* { "Metric": { "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" }, "Value": 24113.0
*
*
* The actual OLDEST_CONTACT_AGE is 24 seconds.
*
*
* When the filter RoutingStepExpression is used, this metric is still calculated from enqueue
* time. For example, if a contact that has been queued under <Expression 1> for 10 seconds
* has expired and <Expression 2> becomes active, then OLDEST_CONTACT_AGE for
* this queue will be counted starting from 10, not 0.
*
*
* Name in real-time metrics report: Oldest
*
*
* - SLOTS_ACTIVE
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Active
*
*
* - SLOTS_AVAILABLE
* -
*
* Unit: COUNT
*
*
* Name in real-time metrics report: Availability
*
*
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.connect.model.CurrentMetric.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.connect.model.CurrentMetric#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.connect.model.CurrentMetric.Builder#build()} is called immediately and
* its result is passed to {@link #currentMetrics(List)}.
*
* @param currentMetrics
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.connect.model.CurrentMetric.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #currentMetrics(java.util.Collection)
*/
Builder currentMetrics(Consumer... currentMetrics);
/**
*
* The token for the next set of results. Use the value returned in the previous response in the next request to
* retrieve the next set of results.
*
*
* The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must
* use the same request parameters as the request that generated the token.
*
*
* @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.
*
* The token expires after 5 minutes from the time it is created. Subsequent requests that use the token
* must use the same request parameters as the request that generated the token.
* @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);
/**
*
* The way to sort the resulting response based on metrics. You can enter one sort criteria. By default
* resources are sorted based on AGENTS_ONLINE, DESCENDING. The metric collection is
* sorted based on the input metrics.
*
*
* Note the following:
*
*
* -
*
* Sorting on SLOTS_ACTIVE and SLOTS_AVAILABLE is not supported.
*
*
*
*
* @param sortCriteria
* The way to sort the resulting response based on metrics. You can enter one sort criteria. By default
* resources are sorted based on AGENTS_ONLINE, DESCENDING. The metric
* collection is sorted based on the input metrics.
*
* Note the following:
*
*
* -
*
* Sorting on SLOTS_ACTIVE and SLOTS_AVAILABLE is not supported.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder sortCriteria(Collection sortCriteria);
/**
*
* The way to sort the resulting response based on metrics. You can enter one sort criteria. By default
* resources are sorted based on AGENTS_ONLINE, DESCENDING. The metric collection is
* sorted based on the input metrics.
*
*
* Note the following:
*
*
* -
*
* Sorting on SLOTS_ACTIVE and SLOTS_AVAILABLE is not supported.
*
*
*
*
* @param sortCriteria
* The way to sort the resulting response based on metrics. You can enter one sort criteria. By default
* resources are sorted based on AGENTS_ONLINE, DESCENDING. The metric
* collection is sorted based on the input metrics.
*
* Note the following:
*
*
* -
*
* Sorting on SLOTS_ACTIVE and SLOTS_AVAILABLE is not supported.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder sortCriteria(CurrentMetricSortCriteria... sortCriteria);
/**
*
* The way to sort the resulting response based on metrics. You can enter one sort criteria. By default
* resources are sorted based on AGENTS_ONLINE, DESCENDING. The metric collection is
* sorted based on the input metrics.
*
*
* Note the following:
*
*
* -
*
* Sorting on SLOTS_ACTIVE and SLOTS_AVAILABLE is not supported.
*
*
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.connect.model.CurrentMetricSortCriteria.Builder} avoiding the need to
* create one manually via
* {@link software.amazon.awssdk.services.connect.model.CurrentMetricSortCriteria#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.connect.model.CurrentMetricSortCriteria.Builder#build()} is called
* immediately and its result is passed to {@link #sortCriteria(List)}.
*
* @param sortCriteria
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.connect.model.CurrentMetricSortCriteria.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #sortCriteria(java.util.Collection)
*/
Builder sortCriteria(Consumer... sortCriteria);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends ConnectRequest.BuilderImpl implements Builder {
private String instanceId;
private Filters filters;
private List groupings = DefaultSdkAutoConstructList.getInstance();
private List currentMetrics = DefaultSdkAutoConstructList.getInstance();
private String nextToken;
private Integer maxResults;
private List sortCriteria = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(GetCurrentMetricDataRequest model) {
super(model);
instanceId(model.instanceId);
filters(model.filters);
groupingsWithStrings(model.groupings);
currentMetrics(model.currentMetrics);
nextToken(model.nextToken);
maxResults(model.maxResults);
sortCriteria(model.sortCriteria);
}
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 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 getCurrentMetrics() {
List result = CurrentMetricsCopier.copyToBuilder(this.currentMetrics);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setCurrentMetrics(Collection currentMetrics) {
this.currentMetrics = CurrentMetricsCopier.copyFromBuilder(currentMetrics);
}
@Override
public final Builder currentMetrics(Collection currentMetrics) {
this.currentMetrics = CurrentMetricsCopier.copy(currentMetrics);
return this;
}
@Override
@SafeVarargs
public final Builder currentMetrics(CurrentMetric... currentMetrics) {
currentMetrics(Arrays.asList(currentMetrics));
return this;
}
@Override
@SafeVarargs
public final Builder currentMetrics(Consumer... currentMetrics) {
currentMetrics(Stream.of(currentMetrics).map(c -> CurrentMetric.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;
}
public final List getSortCriteria() {
List result = CurrentMetricSortCriteriaMaxOneCopier
.copyToBuilder(this.sortCriteria);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setSortCriteria(Collection sortCriteria) {
this.sortCriteria = CurrentMetricSortCriteriaMaxOneCopier.copyFromBuilder(sortCriteria);
}
@Override
public final Builder sortCriteria(Collection sortCriteria) {
this.sortCriteria = CurrentMetricSortCriteriaMaxOneCopier.copy(sortCriteria);
return this;
}
@Override
@SafeVarargs
public final Builder sortCriteria(CurrentMetricSortCriteria... sortCriteria) {
sortCriteria(Arrays.asList(sortCriteria));
return this;
}
@Override
@SafeVarargs
public final Builder sortCriteria(Consumer... sortCriteria) {
sortCriteria(Stream.of(sortCriteria).map(c -> CurrentMetricSortCriteria.builder().applyMutation(c).build())
.collect(Collectors.toList()));
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 GetCurrentMetricDataRequest build() {
return new GetCurrentMetricDataRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}