software.amazon.awssdk.services.connect.model.HistoricalMetric 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.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 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.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Contains information about a historical metric. For a description of each metric, see Historical Metrics
* Definitions in the Amazon Connect Administrator Guide.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class HistoricalMetric implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(HistoricalMetric::nameAsString)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField THRESHOLD_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("Threshold").getter(getter(HistoricalMetric::threshold)).setter(setter(Builder::threshold))
.constructor(Threshold::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Threshold").build()).build();
private static final SdkField STATISTIC_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Statistic").getter(getter(HistoricalMetric::statisticAsString)).setter(setter(Builder::statistic))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Statistic").build()).build();
private static final SdkField UNIT_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Unit")
.getter(getter(HistoricalMetric::unitAsString)).setter(setter(Builder::unit))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Unit").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NAME_FIELD, THRESHOLD_FIELD,
STATISTIC_FIELD, UNIT_FIELD));
private static final long serialVersionUID = 1L;
private final String name;
private final Threshold threshold;
private final String statistic;
private final String unit;
private HistoricalMetric(BuilderImpl builder) {
this.name = builder.name;
this.threshold = builder.threshold;
this.statistic = builder.statistic;
this.unit = builder.unit;
}
/**
*
* The name of the metric.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #name} will return
* {@link HistoricalMetricName#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #nameAsString}.
*
*
* @return The name of the metric.
* @see HistoricalMetricName
*/
public final HistoricalMetricName name() {
return HistoricalMetricName.fromValue(name);
}
/**
*
* The name of the metric.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #name} will return
* {@link HistoricalMetricName#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #nameAsString}.
*
*
* @return The name of the metric.
* @see HistoricalMetricName
*/
public final String nameAsString() {
return name;
}
/**
*
* The threshold for the metric, used with service level metrics.
*
*
* @return The threshold for the metric, used with service level metrics.
*/
public final Threshold threshold() {
return threshold;
}
/**
*
* The statistic for the metric.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #statistic} will
* return {@link Statistic#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statisticAsString}.
*
*
* @return The statistic for the metric.
* @see Statistic
*/
public final Statistic statistic() {
return Statistic.fromValue(statistic);
}
/**
*
* The statistic for the metric.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #statistic} will
* return {@link Statistic#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statisticAsString}.
*
*
* @return The statistic for the metric.
* @see Statistic
*/
public final String statisticAsString() {
return statistic;
}
/**
*
* The unit for the metric.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #unit} will return
* {@link Unit#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #unitAsString}.
*
*
* @return The unit for the metric.
* @see Unit
*/
public final Unit unit() {
return Unit.fromValue(unit);
}
/**
*
* The unit for the metric.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #unit} will return
* {@link Unit#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #unitAsString}.
*
*
* @return The unit for the metric.
* @see Unit
*/
public final String unitAsString() {
return unit;
}
@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(nameAsString());
hashCode = 31 * hashCode + Objects.hashCode(threshold());
hashCode = 31 * hashCode + Objects.hashCode(statisticAsString());
hashCode = 31 * hashCode + Objects.hashCode(unitAsString());
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 HistoricalMetric)) {
return false;
}
HistoricalMetric other = (HistoricalMetric) obj;
return Objects.equals(nameAsString(), other.nameAsString()) && Objects.equals(threshold(), other.threshold())
&& Objects.equals(statisticAsString(), other.statisticAsString())
&& Objects.equals(unitAsString(), other.unitAsString());
}
/**
* 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("HistoricalMetric").add("Name", nameAsString()).add("Threshold", threshold())
.add("Statistic", statisticAsString()).add("Unit", unitAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Name":
return Optional.ofNullable(clazz.cast(nameAsString()));
case "Threshold":
return Optional.ofNullable(clazz.cast(threshold()));
case "Statistic":
return Optional.ofNullable(clazz.cast(statisticAsString()));
case "Unit":
return Optional.ofNullable(clazz.cast(unitAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((HistoricalMetric) 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.
*
*
* @param name
* The name of the metric.
* @see HistoricalMetricName
* @return Returns a reference to this object so that method calls can be chained together.
* @see HistoricalMetricName
*/
Builder name(String name);
/**
*
* The name of the metric.
*
*
* @param name
* The name of the metric.
* @see HistoricalMetricName
* @return Returns a reference to this object so that method calls can be chained together.
* @see HistoricalMetricName
*/
Builder name(HistoricalMetricName name);
/**
*
* The threshold for the metric, used with service level metrics.
*
*
* @param threshold
* The threshold for the metric, used with service level metrics.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder threshold(Threshold threshold);
/**
*
* The threshold for the metric, used with service level metrics.
*
* This is a convenience method that creates an instance of the {@link Threshold.Builder} avoiding the need to
* create one manually via {@link Threshold#builder()}.
*
*
* When the {@link Consumer} completes, {@link Threshold.Builder#build()} is called immediately and its result
* is passed to {@link #threshold(Threshold)}.
*
* @param threshold
* a consumer that will call methods on {@link Threshold.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #threshold(Threshold)
*/
default Builder threshold(Consumer threshold) {
return threshold(Threshold.builder().applyMutation(threshold).build());
}
/**
*
* The statistic for the metric.
*
*
* @param statistic
* The statistic for the metric.
* @see Statistic
* @return Returns a reference to this object so that method calls can be chained together.
* @see Statistic
*/
Builder statistic(String statistic);
/**
*
* The statistic for the metric.
*
*
* @param statistic
* The statistic for the metric.
* @see Statistic
* @return Returns a reference to this object so that method calls can be chained together.
* @see Statistic
*/
Builder statistic(Statistic statistic);
/**
*
* The unit for the metric.
*
*
* @param unit
* The unit for the metric.
* @see Unit
* @return Returns a reference to this object so that method calls can be chained together.
* @see Unit
*/
Builder unit(String unit);
/**
*
* The unit for the metric.
*
*
* @param unit
* The unit for the metric.
* @see Unit
* @return Returns a reference to this object so that method calls can be chained together.
* @see Unit
*/
Builder unit(Unit unit);
}
static final class BuilderImpl implements Builder {
private String name;
private Threshold threshold;
private String statistic;
private String unit;
private BuilderImpl() {
}
private BuilderImpl(HistoricalMetric model) {
name(model.name);
threshold(model.threshold);
statistic(model.statistic);
unit(model.unit);
}
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;
}
@Override
public final Builder name(HistoricalMetricName name) {
this.name(name == null ? null : name.toString());
return this;
}
public final Threshold.Builder getThreshold() {
return threshold != null ? threshold.toBuilder() : null;
}
public final void setThreshold(Threshold.BuilderImpl threshold) {
this.threshold = threshold != null ? threshold.build() : null;
}
@Override
public final Builder threshold(Threshold threshold) {
this.threshold = threshold;
return this;
}
public final String getStatistic() {
return statistic;
}
public final void setStatistic(String statistic) {
this.statistic = statistic;
}
@Override
public final Builder statistic(String statistic) {
this.statistic = statistic;
return this;
}
@Override
public final Builder statistic(Statistic statistic) {
this.statistic(statistic == null ? null : statistic.toString());
return this;
}
public final String getUnit() {
return unit;
}
public final void setUnit(String unit) {
this.unit = unit;
}
@Override
public final Builder unit(String unit) {
this.unit = unit;
return this;
}
@Override
public final Builder unit(Unit unit) {
this.unit(unit == null ? null : unit.toString());
return this;
}
@Override
public HistoricalMetric build() {
return new HistoricalMetric(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}