software.amazon.awssdk.services.computeoptimizer.model.RDSDatabaseProjectedMetric Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of computeoptimizer Show documentation
Show all versions of computeoptimizer Show documentation
The AWS Java SDK for Compute Optimizer module holds the client classes that are used for
communicating with Compute Optimizer.
/*
* 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.computeoptimizer.model;
import java.io.Serializable;
import java.time.Instant;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.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.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;
/**
*
* Describes the projected metrics of an Amazon RDS recommendation option.
*
*
* To determine the performance difference between your current Amazon RDS and the recommended option, compare the
* metric data of your service against its projected metric data.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class RDSDatabaseProjectedMetric implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("name")
.getter(getter(RDSDatabaseProjectedMetric::nameAsString)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("name").build()).build();
private static final SdkField> TIMESTAMPS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("timestamps")
.getter(getter(RDSDatabaseProjectedMetric::timestamps))
.setter(setter(Builder::timestamps))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("timestamps").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.INSTANT)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> VALUES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("values")
.getter(getter(RDSDatabaseProjectedMetric::values))
.setter(setter(Builder::values))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("values").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.DOUBLE)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NAME_FIELD, TIMESTAMPS_FIELD,
VALUES_FIELD));
private static final long serialVersionUID = 1L;
private final String name;
private final List timestamps;
private final List values;
private RDSDatabaseProjectedMetric(BuilderImpl builder) {
this.name = builder.name;
this.timestamps = builder.timestamps;
this.values = builder.values;
}
/**
*
* The name of the projected metric.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #name} will return
* {@link RDSDBMetricName#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #nameAsString}.
*
*
* @return The name of the projected metric.
* @see RDSDBMetricName
*/
public final RDSDBMetricName name() {
return RDSDBMetricName.fromValue(name);
}
/**
*
* The name of the projected metric.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #name} will return
* {@link RDSDBMetricName#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #nameAsString}.
*
*
* @return The name of the projected metric.
* @see RDSDBMetricName
*/
public final String nameAsString() {
return name;
}
/**
* For responses, this returns true if the service returned a value for the Timestamps 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 hasTimestamps() {
return timestamps != null && !(timestamps instanceof SdkAutoConstructList);
}
/**
*
* The timestamps of the projected metric.
*
*
* 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 #hasTimestamps} method.
*
*
* @return The timestamps of the projected metric.
*/
public final List timestamps() {
return timestamps;
}
/**
* For responses, this returns true if the service returned a value for the Values 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 hasValues() {
return values != null && !(values instanceof SdkAutoConstructList);
}
/**
*
* The values for the projected metric.
*
*
* 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 #hasValues} method.
*
*
* @return The values for the projected metric.
*/
public final List values() {
return values;
}
@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(hasTimestamps() ? timestamps() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasValues() ? values() : 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 RDSDatabaseProjectedMetric)) {
return false;
}
RDSDatabaseProjectedMetric other = (RDSDatabaseProjectedMetric) obj;
return Objects.equals(nameAsString(), other.nameAsString()) && hasTimestamps() == other.hasTimestamps()
&& Objects.equals(timestamps(), other.timestamps()) && hasValues() == other.hasValues()
&& Objects.equals(values(), other.values());
}
/**
* 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("RDSDatabaseProjectedMetric").add("Name", nameAsString())
.add("Timestamps", hasTimestamps() ? timestamps() : null).add("Values", hasValues() ? values() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "name":
return Optional.ofNullable(clazz.cast(nameAsString()));
case "timestamps":
return Optional.ofNullable(clazz.cast(timestamps()));
case "values":
return Optional.ofNullable(clazz.cast(values()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((RDSDatabaseProjectedMetric) 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 projected metric.
*
*
* @param name
* The name of the projected metric.
* @see RDSDBMetricName
* @return Returns a reference to this object so that method calls can be chained together.
* @see RDSDBMetricName
*/
Builder name(String name);
/**
*
* The name of the projected metric.
*
*
* @param name
* The name of the projected metric.
* @see RDSDBMetricName
* @return Returns a reference to this object so that method calls can be chained together.
* @see RDSDBMetricName
*/
Builder name(RDSDBMetricName name);
/**
*
* The timestamps of the projected metric.
*
*
* @param timestamps
* The timestamps of the projected metric.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder timestamps(Collection timestamps);
/**
*
* The timestamps of the projected metric.
*
*
* @param timestamps
* The timestamps of the projected metric.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder timestamps(Instant... timestamps);
/**
*
* The values for the projected metric.
*
*
* @param values
* The values for the projected metric.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder values(Collection values);
/**
*
* The values for the projected metric.
*
*
* @param values
* The values for the projected metric.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder values(Double... values);
}
static final class BuilderImpl implements Builder {
private String name;
private List timestamps = DefaultSdkAutoConstructList.getInstance();
private List values = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(RDSDatabaseProjectedMetric model) {
name(model.name);
timestamps(model.timestamps);
values(model.values);
}
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(RDSDBMetricName name) {
this.name(name == null ? null : name.toString());
return this;
}
public final Collection getTimestamps() {
if (timestamps instanceof SdkAutoConstructList) {
return null;
}
return timestamps;
}
public final void setTimestamps(Collection timestamps) {
this.timestamps = TimestampsCopier.copy(timestamps);
}
@Override
public final Builder timestamps(Collection timestamps) {
this.timestamps = TimestampsCopier.copy(timestamps);
return this;
}
@Override
@SafeVarargs
public final Builder timestamps(Instant... timestamps) {
timestamps(Arrays.asList(timestamps));
return this;
}
public final Collection getValues() {
if (values instanceof SdkAutoConstructList) {
return null;
}
return values;
}
public final void setValues(Collection values) {
this.values = MetricValuesCopier.copy(values);
}
@Override
public final Builder values(Collection values) {
this.values = MetricValuesCopier.copy(values);
return this;
}
@Override
@SafeVarargs
public final Builder values(Double... values) {
values(Arrays.asList(values));
return this;
}
@Override
public RDSDatabaseProjectedMetric build() {
return new RDSDatabaseProjectedMetric(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}