software.amazon.awssdk.services.computeoptimizer.model.ECSServiceUtilizationMetric Maven / Gradle / Ivy
Show all versions of computeoptimizer 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.computeoptimizer.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.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;
/**
*
* Describes the utilization metric of an Amazon ECS service.
*
*
* To determine the performance difference between your current Amazon ECS service and the recommended option, compare
* the utilization metric data of your service against its projected utilization metric data.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ECSServiceUtilizationMetric implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("name")
.getter(getter(ECSServiceUtilizationMetric::nameAsString)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("name").build()).build();
private static final SdkField STATISTIC_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("statistic").getter(getter(ECSServiceUtilizationMetric::statisticAsString))
.setter(setter(Builder::statistic))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("statistic").build()).build();
private static final SdkField VALUE_FIELD = SdkField. builder(MarshallingType.DOUBLE).memberName("value")
.getter(getter(ECSServiceUtilizationMetric::value)).setter(setter(Builder::value))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("value").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NAME_FIELD, STATISTIC_FIELD,
VALUE_FIELD));
private static final long serialVersionUID = 1L;
private final String name;
private final String statistic;
private final Double value;
private ECSServiceUtilizationMetric(BuilderImpl builder) {
this.name = builder.name;
this.statistic = builder.statistic;
this.value = builder.value;
}
/**
*
* The name of the utilization metric.
*
*
* The following utilization metrics are available:
*
*
* -
*
* Cpu — The amount of CPU capacity that's used in the service.
*
*
* -
*
* Memory — The amount of memory that's used in the service.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #name} will return
* {@link ECSServiceMetricName#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #nameAsString}.
*
*
* @return The name of the utilization metric.
*
* The following utilization metrics are available:
*
*
* -
*
* Cpu — The amount of CPU capacity that's used in the service.
*
*
* -
*
* Memory — The amount of memory that's used in the service.
*
*
* @see ECSServiceMetricName
*/
public final ECSServiceMetricName name() {
return ECSServiceMetricName.fromValue(name);
}
/**
*
* The name of the utilization metric.
*
*
* The following utilization metrics are available:
*
*
* -
*
* Cpu — The amount of CPU capacity that's used in the service.
*
*
* -
*
* Memory — The amount of memory that's used in the service.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #name} will return
* {@link ECSServiceMetricName#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #nameAsString}.
*
*
* @return The name of the utilization metric.
*
* The following utilization metrics are available:
*
*
* -
*
* Cpu — The amount of CPU capacity that's used in the service.
*
*
* -
*
* Memory — The amount of memory that's used in the service.
*
*
* @see ECSServiceMetricName
*/
public final String nameAsString() {
return name;
}
/**
*
* The statistic of the utilization metric.
*
*
* The Compute Optimizer API, Command Line Interface (CLI), and SDKs return utilization metrics using only the
* Maximum statistic, which is the highest value observed during the specified period.
*
*
* The Compute Optimizer console displays graphs for some utilization metrics using the Average
* statistic, which is the value of Sum / SampleCount during the specified period. For
* more information, see Viewing resource
* recommendations in the Compute Optimizer User Guide. You can also get averaged utilization metric data
* for your resources using Amazon CloudWatch. For more information, see the Amazon CloudWatch
* User Guide.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #statistic} will
* return {@link ECSServiceMetricStatistic#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #statisticAsString}.
*
*
* @return The statistic of the utilization metric.
*
* The Compute Optimizer API, Command Line Interface (CLI), and SDKs return utilization metrics using only
* the Maximum statistic, which is the highest value observed during the specified period.
*
*
* The Compute Optimizer console displays graphs for some utilization metrics using the Average
* statistic, which is the value of Sum / SampleCount during the specified period.
* For more information, see Viewing
* resource recommendations in the Compute Optimizer User Guide. You can also get averaged
* utilization metric data for your resources using Amazon CloudWatch. For more information, see the Amazon
* CloudWatch User Guide.
* @see ECSServiceMetricStatistic
*/
public final ECSServiceMetricStatistic statistic() {
return ECSServiceMetricStatistic.fromValue(statistic);
}
/**
*
* The statistic of the utilization metric.
*
*
* The Compute Optimizer API, Command Line Interface (CLI), and SDKs return utilization metrics using only the
* Maximum statistic, which is the highest value observed during the specified period.
*
*
* The Compute Optimizer console displays graphs for some utilization metrics using the Average
* statistic, which is the value of Sum / SampleCount during the specified period. For
* more information, see Viewing resource
* recommendations in the Compute Optimizer User Guide. You can also get averaged utilization metric data
* for your resources using Amazon CloudWatch. For more information, see the Amazon CloudWatch
* User Guide.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #statistic} will
* return {@link ECSServiceMetricStatistic#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #statisticAsString}.
*
*
* @return The statistic of the utilization metric.
*
* The Compute Optimizer API, Command Line Interface (CLI), and SDKs return utilization metrics using only
* the Maximum statistic, which is the highest value observed during the specified period.
*
*
* The Compute Optimizer console displays graphs for some utilization metrics using the Average
* statistic, which is the value of Sum / SampleCount during the specified period.
* For more information, see Viewing
* resource recommendations in the Compute Optimizer User Guide. You can also get averaged
* utilization metric data for your resources using Amazon CloudWatch. For more information, see the Amazon
* CloudWatch User Guide.
* @see ECSServiceMetricStatistic
*/
public final String statisticAsString() {
return statistic;
}
/**
*
* The value of the utilization metric.
*
*
* @return The value of the utilization metric.
*/
public final Double value() {
return value;
}
@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(statisticAsString());
hashCode = 31 * hashCode + Objects.hashCode(value());
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 ECSServiceUtilizationMetric)) {
return false;
}
ECSServiceUtilizationMetric other = (ECSServiceUtilizationMetric) obj;
return Objects.equals(nameAsString(), other.nameAsString())
&& Objects.equals(statisticAsString(), other.statisticAsString()) && Objects.equals(value(), other.value());
}
/**
* 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("ECSServiceUtilizationMetric").add("Name", nameAsString()).add("Statistic", statisticAsString())
.add("Value", value()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "name":
return Optional.ofNullable(clazz.cast(nameAsString()));
case "statistic":
return Optional.ofNullable(clazz.cast(statisticAsString()));
case "value":
return Optional.ofNullable(clazz.cast(value()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ECSServiceUtilizationMetric) 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 utilization metric.
*
*
* The following utilization metrics are available:
*
*
* -
*
* Cpu — The amount of CPU capacity that's used in the service.
*
*
* -
*
* Memory — The amount of memory that's used in the service.
*
*
*
*
* @param name
* The name of the utilization metric.
*
* The following utilization metrics are available:
*
*
* -
*
* Cpu — The amount of CPU capacity that's used in the service.
*
*
* -
*
* Memory — The amount of memory that's used in the service.
*
*
* @see ECSServiceMetricName
* @return Returns a reference to this object so that method calls can be chained together.
* @see ECSServiceMetricName
*/
Builder name(String name);
/**
*
* The name of the utilization metric.
*
*
* The following utilization metrics are available:
*
*
* -
*
* Cpu — The amount of CPU capacity that's used in the service.
*
*
* -
*
* Memory — The amount of memory that's used in the service.
*
*
*
*
* @param name
* The name of the utilization metric.
*
* The following utilization metrics are available:
*
*
* -
*
* Cpu — The amount of CPU capacity that's used in the service.
*
*
* -
*
* Memory — The amount of memory that's used in the service.
*
*
* @see ECSServiceMetricName
* @return Returns a reference to this object so that method calls can be chained together.
* @see ECSServiceMetricName
*/
Builder name(ECSServiceMetricName name);
/**
*
* The statistic of the utilization metric.
*
*
* The Compute Optimizer API, Command Line Interface (CLI), and SDKs return utilization metrics using only the
* Maximum statistic, which is the highest value observed during the specified period.
*
*
* The Compute Optimizer console displays graphs for some utilization metrics using the Average
* statistic, which is the value of Sum / SampleCount during the specified period. For
* more information, see Viewing resource
* recommendations in the Compute Optimizer User Guide. You can also get averaged utilization metric
* data for your resources using Amazon CloudWatch. For more information, see the Amazon CloudWatch
* User Guide.
*
*
* @param statistic
* The statistic of the utilization metric.
*
* The Compute Optimizer API, Command Line Interface (CLI), and SDKs return utilization metrics using
* only the Maximum statistic, which is the highest value observed during the specified
* period.
*
*
* The Compute Optimizer console displays graphs for some utilization metrics using the
* Average statistic, which is the value of Sum / SampleCount
* during the specified period. For more information, see Viewing
* resource recommendations in the Compute Optimizer User Guide. You can also get averaged
* utilization metric data for your resources using Amazon CloudWatch. For more information, see the Amazon
* CloudWatch User Guide.
* @see ECSServiceMetricStatistic
* @return Returns a reference to this object so that method calls can be chained together.
* @see ECSServiceMetricStatistic
*/
Builder statistic(String statistic);
/**
*
* The statistic of the utilization metric.
*
*
* The Compute Optimizer API, Command Line Interface (CLI), and SDKs return utilization metrics using only the
* Maximum statistic, which is the highest value observed during the specified period.
*
*
* The Compute Optimizer console displays graphs for some utilization metrics using the Average
* statistic, which is the value of Sum / SampleCount during the specified period. For
* more information, see Viewing resource
* recommendations in the Compute Optimizer User Guide. You can also get averaged utilization metric
* data for your resources using Amazon CloudWatch. For more information, see the Amazon CloudWatch
* User Guide.
*
*
* @param statistic
* The statistic of the utilization metric.
*
* The Compute Optimizer API, Command Line Interface (CLI), and SDKs return utilization metrics using
* only the Maximum statistic, which is the highest value observed during the specified
* period.
*
*
* The Compute Optimizer console displays graphs for some utilization metrics using the
* Average statistic, which is the value of Sum / SampleCount
* during the specified period. For more information, see Viewing
* resource recommendations in the Compute Optimizer User Guide. You can also get averaged
* utilization metric data for your resources using Amazon CloudWatch. For more information, see the Amazon
* CloudWatch User Guide.
* @see ECSServiceMetricStatistic
* @return Returns a reference to this object so that method calls can be chained together.
* @see ECSServiceMetricStatistic
*/
Builder statistic(ECSServiceMetricStatistic statistic);
/**
*
* The value of the utilization metric.
*
*
* @param value
* The value of the utilization metric.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder value(Double value);
}
static final class BuilderImpl implements Builder {
private String name;
private String statistic;
private Double value;
private BuilderImpl() {
}
private BuilderImpl(ECSServiceUtilizationMetric model) {
name(model.name);
statistic(model.statistic);
value(model.value);
}
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(ECSServiceMetricName name) {
this.name(name == null ? null : name.toString());
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(ECSServiceMetricStatistic statistic) {
this.statistic(statistic == null ? null : statistic.toString());
return this;
}
public final Double getValue() {
return value;
}
public final void setValue(Double value) {
this.value = value;
}
@Override
public final Builder value(Double value) {
this.value = value;
return this;
}
@Override
public ECSServiceUtilizationMetric build() {
return new ECSServiceUtilizationMetric(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}