software.amazon.awssdk.services.connect.model.MetricV2 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.io.Serializable;
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.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;
/**
*
* Contains information about the metric.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class MetricV2 implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(MetricV2::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField> THRESHOLD_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Threshold")
.getter(getter(MetricV2::threshold))
.setter(setter(Builder::threshold))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Threshold").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ThresholdV2::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> METRIC_FILTERS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("MetricFilters")
.getter(getter(MetricV2::metricFilters))
.setter(setter(Builder::metricFilters))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MetricFilters").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(MetricFilterV2::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NAME_FIELD, THRESHOLD_FIELD,
METRIC_FILTERS_FIELD));
private static final long serialVersionUID = 1L;
private final String name;
private final List threshold;
private final List metricFilters;
private MetricV2(BuilderImpl builder) {
this.name = builder.name;
this.threshold = builder.threshold;
this.metricFilters = builder.metricFilters;
}
/**
*
* The name of the metric.
*
*
*
* This parameter is required. The following Required = No is incorrect.
*
*
*
* @return The name of the metric.
*
* This parameter is required. The following Required = No is incorrect.
*
*/
public final String name() {
return name;
}
/**
* For responses, this returns true if the service returned a value for the Threshold 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 hasThreshold() {
return threshold != null && !(threshold instanceof SdkAutoConstructList);
}
/**
*
* Contains information about the threshold for service level metrics.
*
*
* 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 #hasThreshold} method.
*
*
* @return Contains information about the threshold for service level metrics.
*/
public final List threshold() {
return threshold;
}
/**
* For responses, this returns true if the service returned a value for the MetricFilters 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 hasMetricFilters() {
return metricFilters != null && !(metricFilters instanceof SdkAutoConstructList);
}
/**
*
* Contains the filters to be used when returning data.
*
*
* 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 #hasMetricFilters} method.
*
*
* @return Contains the filters to be used when returning data.
*/
public final List metricFilters() {
return metricFilters;
}
@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 + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(hasThreshold() ? threshold() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasMetricFilters() ? metricFilters() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof MetricV2)) {
return false;
}
MetricV2 other = (MetricV2) obj;
return Objects.equals(name(), other.name()) && hasThreshold() == other.hasThreshold()
&& Objects.equals(threshold(), other.threshold()) && hasMetricFilters() == other.hasMetricFilters()
&& Objects.equals(metricFilters(), other.metricFilters());
}
/**
* 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("MetricV2").add("Name", name()).add("Threshold", hasThreshold() ? threshold() : null)
.add("MetricFilters", hasMetricFilters() ? metricFilters() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "Threshold":
return Optional.ofNullable(clazz.cast(threshold()));
case "MetricFilters":
return Optional.ofNullable(clazz.cast(metricFilters()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((MetricV2) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The name of the metric.
*
*
*
* This parameter is required. The following Required = No is incorrect.
*
*
*
* @param name
* The name of the metric.
*
* This parameter is required. The following Required = No is incorrect.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* Contains information about the threshold for service level metrics.
*
*
* @param threshold
* Contains information about the threshold for service level metrics.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder threshold(Collection threshold);
/**
*
* Contains information about the threshold for service level metrics.
*
*
* @param threshold
* Contains information about the threshold for service level metrics.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder threshold(ThresholdV2... threshold);
/**
*
* Contains information about the threshold for service level metrics.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.connect.model.ThresholdV2.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.connect.model.ThresholdV2#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.connect.model.ThresholdV2.Builder#build()} is called immediately and
* its result is passed to {@link #threshold(List)}.
*
* @param threshold
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.connect.model.ThresholdV2.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #threshold(java.util.Collection)
*/
Builder threshold(Consumer... threshold);
/**
*
* Contains the filters to be used when returning data.
*
*
* @param metricFilters
* Contains the filters to be used when returning data.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder metricFilters(Collection metricFilters);
/**
*
* Contains the filters to be used when returning data.
*
*
* @param metricFilters
* Contains the filters to be used when returning data.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder metricFilters(MetricFilterV2... metricFilters);
/**
*
* Contains the filters to be used when returning data.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.connect.model.MetricFilterV2.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.connect.model.MetricFilterV2#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.connect.model.MetricFilterV2.Builder#build()} is called immediately
* and its result is passed to {@link #metricFilters(List)}.
*
* @param metricFilters
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.connect.model.MetricFilterV2.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #metricFilters(java.util.Collection)
*/
Builder metricFilters(Consumer... metricFilters);
}
static final class BuilderImpl implements Builder {
private String name;
private List threshold = DefaultSdkAutoConstructList.getInstance();
private List metricFilters = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(MetricV2 model) {
name(model.name);
threshold(model.threshold);
metricFilters(model.metricFilters);
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final List getThreshold() {
List result = ThresholdCollectionsCopier.copyToBuilder(this.threshold);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setThreshold(Collection threshold) {
this.threshold = ThresholdCollectionsCopier.copyFromBuilder(threshold);
}
@Override
public final Builder threshold(Collection threshold) {
this.threshold = ThresholdCollectionsCopier.copy(threshold);
return this;
}
@Override
@SafeVarargs
public final Builder threshold(ThresholdV2... threshold) {
threshold(Arrays.asList(threshold));
return this;
}
@Override
@SafeVarargs
public final Builder threshold(Consumer... threshold) {
threshold(Stream.of(threshold).map(c -> ThresholdV2.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final List getMetricFilters() {
List result = MetricFiltersV2ListCopier.copyToBuilder(this.metricFilters);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setMetricFilters(Collection metricFilters) {
this.metricFilters = MetricFiltersV2ListCopier.copyFromBuilder(metricFilters);
}
@Override
public final Builder metricFilters(Collection metricFilters) {
this.metricFilters = MetricFiltersV2ListCopier.copy(metricFilters);
return this;
}
@Override
@SafeVarargs
public final Builder metricFilters(MetricFilterV2... metricFilters) {
metricFilters(Arrays.asList(metricFilters));
return this;
}
@Override
@SafeVarargs
public final Builder metricFilters(Consumer... metricFilters) {
metricFilters(Stream.of(metricFilters).map(c -> MetricFilterV2.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
@Override
public MetricV2 build() {
return new MetricV2(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}