software.amazon.awssdk.services.rds.model.Metric Maven / Gradle / Ivy
/*
* 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.rds.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
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;
/**
*
* The representation of a metric.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class Metric implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(Metric::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField> REFERENCES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("References")
.getter(getter(Metric::references))
.setter(setter(Builder::references))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("References").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(MetricReference::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField STATISTICS_DETAILS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("StatisticsDetails").getter(getter(Metric::statisticsDetails)).setter(setter(Builder::statisticsDetails))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StatisticsDetails").build()).build();
private static final SdkField METRIC_QUERY_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("MetricQuery").getter(getter(Metric::metricQuery)).setter(setter(Builder::metricQuery))
.constructor(MetricQuery::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MetricQuery").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NAME_FIELD, REFERENCES_FIELD,
STATISTICS_DETAILS_FIELD, METRIC_QUERY_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private static final long serialVersionUID = 1L;
private final String name;
private final List references;
private final String statisticsDetails;
private final MetricQuery metricQuery;
private Metric(BuilderImpl builder) {
this.name = builder.name;
this.references = builder.references;
this.statisticsDetails = builder.statisticsDetails;
this.metricQuery = builder.metricQuery;
}
/**
*
* The name of a metric.
*
*
* @return The name of a metric.
*/
public final String name() {
return name;
}
/**
* For responses, this returns true if the service returned a value for the References 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 hasReferences() {
return references != null && !(references instanceof SdkAutoConstructList);
}
/**
*
* A list of metric references (thresholds).
*
*
* 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 #hasReferences} method.
*
*
* @return A list of metric references (thresholds).
*/
public final List references() {
return references;
}
/**
*
* The details of different statistics for a metric. The description might contain markdown.
*
*
* @return The details of different statistics for a metric. The description might contain markdown.
*/
public final String statisticsDetails() {
return statisticsDetails;
}
/**
*
* The query to retrieve metric data points.
*
*
* @return The query to retrieve metric data points.
*/
public final MetricQuery metricQuery() {
return metricQuery;
}
@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(hasReferences() ? references() : null);
hashCode = 31 * hashCode + Objects.hashCode(statisticsDetails());
hashCode = 31 * hashCode + Objects.hashCode(metricQuery());
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 Metric)) {
return false;
}
Metric other = (Metric) obj;
return Objects.equals(name(), other.name()) && hasReferences() == other.hasReferences()
&& Objects.equals(references(), other.references())
&& Objects.equals(statisticsDetails(), other.statisticsDetails())
&& Objects.equals(metricQuery(), other.metricQuery());
}
/**
* 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("Metric").add("Name", name()).add("References", hasReferences() ? references() : null)
.add("StatisticsDetails", statisticsDetails()).add("MetricQuery", metricQuery()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "References":
return Optional.ofNullable(clazz.cast(references()));
case "StatisticsDetails":
return Optional.ofNullable(clazz.cast(statisticsDetails()));
case "MetricQuery":
return Optional.ofNullable(clazz.cast(metricQuery()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Map> memberNameToFieldInitializer() {
Map> map = new HashMap<>();
map.put("Name", NAME_FIELD);
map.put("References", REFERENCES_FIELD);
map.put("StatisticsDetails", STATISTICS_DETAILS_FIELD);
map.put("MetricQuery", METRIC_QUERY_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((Metric) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The name of a metric.
*
*
* @param name
* The name of a metric.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* A list of metric references (thresholds).
*
*
* @param references
* A list of metric references (thresholds).
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder references(Collection references);
/**
*
* A list of metric references (thresholds).
*
*
* @param references
* A list of metric references (thresholds).
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder references(MetricReference... references);
/**
*
* A list of metric references (thresholds).
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.rds.model.MetricReference.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.rds.model.MetricReference#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.rds.model.MetricReference.Builder#build()} is called immediately and
* its result is passed to {@link #references(List)}.
*
* @param references
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.rds.model.MetricReference.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #references(java.util.Collection)
*/
Builder references(Consumer... references);
/**
*
* The details of different statistics for a metric. The description might contain markdown.
*
*
* @param statisticsDetails
* The details of different statistics for a metric. The description might contain markdown.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder statisticsDetails(String statisticsDetails);
/**
*
* The query to retrieve metric data points.
*
*
* @param metricQuery
* The query to retrieve metric data points.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder metricQuery(MetricQuery metricQuery);
/**
*
* The query to retrieve metric data points.
*
* This is a convenience method that creates an instance of the {@link MetricQuery.Builder} avoiding the need to
* create one manually via {@link MetricQuery#builder()}.
*
*
* When the {@link Consumer} completes, {@link MetricQuery.Builder#build()} is called immediately and its result
* is passed to {@link #metricQuery(MetricQuery)}.
*
* @param metricQuery
* a consumer that will call methods on {@link MetricQuery.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #metricQuery(MetricQuery)
*/
default Builder metricQuery(Consumer metricQuery) {
return metricQuery(MetricQuery.builder().applyMutation(metricQuery).build());
}
}
static final class BuilderImpl implements Builder {
private String name;
private List references = DefaultSdkAutoConstructList.getInstance();
private String statisticsDetails;
private MetricQuery metricQuery;
private BuilderImpl() {
}
private BuilderImpl(Metric model) {
name(model.name);
references(model.references);
statisticsDetails(model.statisticsDetails);
metricQuery(model.metricQuery);
}
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 getReferences() {
List result = MetricReferenceListCopier.copyToBuilder(this.references);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setReferences(Collection references) {
this.references = MetricReferenceListCopier.copyFromBuilder(references);
}
@Override
public final Builder references(Collection references) {
this.references = MetricReferenceListCopier.copy(references);
return this;
}
@Override
@SafeVarargs
public final Builder references(MetricReference... references) {
references(Arrays.asList(references));
return this;
}
@Override
@SafeVarargs
public final Builder references(Consumer... references) {
references(Stream.of(references).map(c -> MetricReference.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final String getStatisticsDetails() {
return statisticsDetails;
}
public final void setStatisticsDetails(String statisticsDetails) {
this.statisticsDetails = statisticsDetails;
}
@Override
public final Builder statisticsDetails(String statisticsDetails) {
this.statisticsDetails = statisticsDetails;
return this;
}
public final MetricQuery.Builder getMetricQuery() {
return metricQuery != null ? metricQuery.toBuilder() : null;
}
public final void setMetricQuery(MetricQuery.BuilderImpl metricQuery) {
this.metricQuery = metricQuery != null ? metricQuery.build() : null;
}
@Override
public final Builder metricQuery(MetricQuery metricQuery) {
this.metricQuery = metricQuery;
return this;
}
@Override
public Metric build() {
return new Metric(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}