software.amazon.awssdk.services.computeoptimizer.model.Summary 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.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;
/**
*
* The summary of a recommendation.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class Summary implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("name")
.getter(getter(Summary::nameAsString)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("name").build()).build();
private static final SdkField VALUE_FIELD = SdkField. builder(MarshallingType.DOUBLE).memberName("value")
.getter(getter(Summary::value)).setter(setter(Builder::value))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("value").build()).build();
private static final SdkField> REASON_CODE_SUMMARIES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("reasonCodeSummaries")
.getter(getter(Summary::reasonCodeSummaries))
.setter(setter(Builder::reasonCodeSummaries))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("reasonCodeSummaries").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ReasonCodeSummary::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, VALUE_FIELD,
REASON_CODE_SUMMARIES_FIELD));
private static final long serialVersionUID = 1L;
private final String name;
private final Double value;
private final List reasonCodeSummaries;
private Summary(BuilderImpl builder) {
this.name = builder.name;
this.value = builder.value;
this.reasonCodeSummaries = builder.reasonCodeSummaries;
}
/**
*
* The finding classification of the recommendation.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #name} will return
* {@link Finding#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #nameAsString}.
*
*
* @return The finding classification of the recommendation.
* @see Finding
*/
public final Finding name() {
return Finding.fromValue(name);
}
/**
*
* The finding classification of the recommendation.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #name} will return
* {@link Finding#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #nameAsString}.
*
*
* @return The finding classification of the recommendation.
* @see Finding
*/
public final String nameAsString() {
return name;
}
/**
*
* The value of the recommendation summary.
*
*
* @return The value of the recommendation summary.
*/
public final Double value() {
return value;
}
/**
* Returns true if the ReasonCodeSummaries property was specified by the sender (it may be empty), or false if the
* sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS
* service.
*/
public final boolean hasReasonCodeSummaries() {
return reasonCodeSummaries != null && !(reasonCodeSummaries instanceof SdkAutoConstructList);
}
/**
*
* An array of objects that summarize a finding reason code.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasReasonCodeSummaries()} to see if a value was sent in this field.
*
*
* @return An array of objects that summarize a finding reason code.
*/
public final List reasonCodeSummaries() {
return reasonCodeSummaries;
}
@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(value());
hashCode = 31 * hashCode + Objects.hashCode(hasReasonCodeSummaries() ? reasonCodeSummaries() : 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 Summary)) {
return false;
}
Summary other = (Summary) obj;
return Objects.equals(nameAsString(), other.nameAsString()) && Objects.equals(value(), other.value())
&& hasReasonCodeSummaries() == other.hasReasonCodeSummaries()
&& Objects.equals(reasonCodeSummaries(), other.reasonCodeSummaries());
}
/**
* 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("Summary").add("Name", nameAsString()).add("Value", value())
.add("ReasonCodeSummaries", hasReasonCodeSummaries() ? reasonCodeSummaries() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "name":
return Optional.ofNullable(clazz.cast(nameAsString()));
case "value":
return Optional.ofNullable(clazz.cast(value()));
case "reasonCodeSummaries":
return Optional.ofNullable(clazz.cast(reasonCodeSummaries()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((Summary) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The finding classification of the recommendation.
*
*
* @param name
* The finding classification of the recommendation.
* @see Finding
* @return Returns a reference to this object so that method calls can be chained together.
* @see Finding
*/
Builder name(String name);
/**
*
* The finding classification of the recommendation.
*
*
* @param name
* The finding classification of the recommendation.
* @see Finding
* @return Returns a reference to this object so that method calls can be chained together.
* @see Finding
*/
Builder name(Finding name);
/**
*
* The value of the recommendation summary.
*
*
* @param value
* The value of the recommendation summary.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder value(Double value);
/**
*
* An array of objects that summarize a finding reason code.
*
*
* @param reasonCodeSummaries
* An array of objects that summarize a finding reason code.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder reasonCodeSummaries(Collection reasonCodeSummaries);
/**
*
* An array of objects that summarize a finding reason code.
*
*
* @param reasonCodeSummaries
* An array of objects that summarize a finding reason code.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder reasonCodeSummaries(ReasonCodeSummary... reasonCodeSummaries);
/**
*
* An array of objects that summarize a finding reason code.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the
* need to create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately
* and its result is passed to {@link #reasonCodeSummaries(List)}.
*
* @param reasonCodeSummaries
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #reasonCodeSummaries(List)
*/
Builder reasonCodeSummaries(Consumer... reasonCodeSummaries);
}
static final class BuilderImpl implements Builder {
private String name;
private Double value;
private List reasonCodeSummaries = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(Summary model) {
name(model.name);
value(model.value);
reasonCodeSummaries(model.reasonCodeSummaries);
}
public final String getName() {
return name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
@Override
public final Builder name(Finding name) {
this.name(name == null ? null : name.toString());
return this;
}
public final void setName(String name) {
this.name = name;
}
public final Double getValue() {
return value;
}
@Override
public final Builder value(Double value) {
this.value = value;
return this;
}
public final void setValue(Double value) {
this.value = value;
}
public final Collection getReasonCodeSummaries() {
if (reasonCodeSummaries instanceof SdkAutoConstructList) {
return null;
}
return reasonCodeSummaries != null ? reasonCodeSummaries.stream().map(ReasonCodeSummary::toBuilder)
.collect(Collectors.toList()) : null;
}
@Override
public final Builder reasonCodeSummaries(Collection reasonCodeSummaries) {
this.reasonCodeSummaries = ReasonCodeSummariesCopier.copy(reasonCodeSummaries);
return this;
}
@Override
@SafeVarargs
public final Builder reasonCodeSummaries(ReasonCodeSummary... reasonCodeSummaries) {
reasonCodeSummaries(Arrays.asList(reasonCodeSummaries));
return this;
}
@Override
@SafeVarargs
public final Builder reasonCodeSummaries(Consumer... reasonCodeSummaries) {
reasonCodeSummaries(Stream.of(reasonCodeSummaries).map(c -> ReasonCodeSummary.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final void setReasonCodeSummaries(Collection reasonCodeSummaries) {
this.reasonCodeSummaries = ReasonCodeSummariesCopier.copyFromBuilder(reasonCodeSummaries);
}
@Override
public Summary build() {
return new Summary(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy