software.amazon.awssdk.services.computeoptimizer.model.RecommendationSummary 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.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;
/**
*
* A summary of a recommendation.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class RecommendationSummary implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField> SUMMARIES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("summaries")
.getter(getter(RecommendationSummary::summaries))
.setter(setter(Builder::summaries))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("summaries").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Summary::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField RECOMMENDATION_RESOURCE_TYPE_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("recommendationResourceType")
.getter(getter(RecommendationSummary::recommendationResourceTypeAsString))
.setter(setter(Builder::recommendationResourceType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("recommendationResourceType").build())
.build();
private static final SdkField ACCOUNT_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("accountId").getter(getter(RecommendationSummary::accountId)).setter(setter(Builder::accountId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("accountId").build()).build();
private static final SdkField SAVINGS_OPPORTUNITY_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("savingsOpportunity")
.getter(getter(RecommendationSummary::savingsOpportunity)).setter(setter(Builder::savingsOpportunity))
.constructor(SavingsOpportunity::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("savingsOpportunity").build())
.build();
private static final SdkField CURRENT_PERFORMANCE_RISK_RATINGS_FIELD = SdkField
. builder(MarshallingType.SDK_POJO)
.memberName("currentPerformanceRiskRatings")
.getter(getter(RecommendationSummary::currentPerformanceRiskRatings))
.setter(setter(Builder::currentPerformanceRiskRatings))
.constructor(CurrentPerformanceRiskRatings::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("currentPerformanceRiskRatings")
.build()).build();
private static final SdkField> INFERRED_WORKLOAD_SAVINGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("inferredWorkloadSavings")
.getter(getter(RecommendationSummary::inferredWorkloadSavings))
.setter(setter(Builder::inferredWorkloadSavings))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("inferredWorkloadSavings").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(InferredWorkloadSaving::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(SUMMARIES_FIELD,
RECOMMENDATION_RESOURCE_TYPE_FIELD, ACCOUNT_ID_FIELD, SAVINGS_OPPORTUNITY_FIELD,
CURRENT_PERFORMANCE_RISK_RATINGS_FIELD, INFERRED_WORKLOAD_SAVINGS_FIELD));
private static final long serialVersionUID = 1L;
private final List summaries;
private final String recommendationResourceType;
private final String accountId;
private final SavingsOpportunity savingsOpportunity;
private final CurrentPerformanceRiskRatings currentPerformanceRiskRatings;
private final List inferredWorkloadSavings;
private RecommendationSummary(BuilderImpl builder) {
this.summaries = builder.summaries;
this.recommendationResourceType = builder.recommendationResourceType;
this.accountId = builder.accountId;
this.savingsOpportunity = builder.savingsOpportunity;
this.currentPerformanceRiskRatings = builder.currentPerformanceRiskRatings;
this.inferredWorkloadSavings = builder.inferredWorkloadSavings;
}
/**
* For responses, this returns true if the service returned a value for the Summaries 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 hasSummaries() {
return summaries != null && !(summaries instanceof SdkAutoConstructList);
}
/**
*
* An array of objects that describe a recommendation summary.
*
*
* 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 #hasSummaries} method.
*
*
* @return An array of objects that describe a recommendation summary.
*/
public final List summaries() {
return summaries;
}
/**
*
* The resource type that the recommendation summary applies to.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #recommendationResourceType} will return {@link RecommendationSourceType#UNKNOWN_TO_SDK_VERSION}. The raw
* value returned by the service is available from {@link #recommendationResourceTypeAsString}.
*
*
* @return The resource type that the recommendation summary applies to.
* @see RecommendationSourceType
*/
public final RecommendationSourceType recommendationResourceType() {
return RecommendationSourceType.fromValue(recommendationResourceType);
}
/**
*
* The resource type that the recommendation summary applies to.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #recommendationResourceType} will return {@link RecommendationSourceType#UNKNOWN_TO_SDK_VERSION}. The raw
* value returned by the service is available from {@link #recommendationResourceTypeAsString}.
*
*
* @return The resource type that the recommendation summary applies to.
* @see RecommendationSourceType
*/
public final String recommendationResourceTypeAsString() {
return recommendationResourceType;
}
/**
*
* The Amazon Web Services account ID of the recommendation summary.
*
*
* @return The Amazon Web Services account ID of the recommendation summary.
*/
public final String accountId() {
return accountId;
}
/**
*
* An object that describes the savings opportunity for a given resource type. Savings opportunity includes the
* estimated monthly savings amount and percentage.
*
*
* @return An object that describes the savings opportunity for a given resource type. Savings opportunity includes
* the estimated monthly savings amount and percentage.
*/
public final SavingsOpportunity savingsOpportunity() {
return savingsOpportunity;
}
/**
*
* An object that describes the performance risk ratings for a given resource type.
*
*
* @return An object that describes the performance risk ratings for a given resource type.
*/
public final CurrentPerformanceRiskRatings currentPerformanceRiskRatings() {
return currentPerformanceRiskRatings;
}
/**
* For responses, this returns true if the service returned a value for the InferredWorkloadSavings 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 hasInferredWorkloadSavings() {
return inferredWorkloadSavings != null && !(inferredWorkloadSavings instanceof SdkAutoConstructList);
}
/**
*
* An array of objects that describes the estimated monthly saving amounts for the instances running on the
* specified inferredWorkloadTypes
. The array contains the top five savings opportunites for the
* instances that run inferred workload types.
*
*
* 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 #hasInferredWorkloadSavings} method.
*
*
* @return An array of objects that describes the estimated monthly saving amounts for the instances running on the
* specified inferredWorkloadTypes
. The array contains the top five savings opportunites for
* the instances that run inferred workload types.
*/
public final List inferredWorkloadSavings() {
return inferredWorkloadSavings;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(hasSummaries() ? summaries() : null);
hashCode = 31 * hashCode + Objects.hashCode(recommendationResourceTypeAsString());
hashCode = 31 * hashCode + Objects.hashCode(accountId());
hashCode = 31 * hashCode + Objects.hashCode(savingsOpportunity());
hashCode = 31 * hashCode + Objects.hashCode(currentPerformanceRiskRatings());
hashCode = 31 * hashCode + Objects.hashCode(hasInferredWorkloadSavings() ? inferredWorkloadSavings() : 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 RecommendationSummary)) {
return false;
}
RecommendationSummary other = (RecommendationSummary) obj;
return hasSummaries() == other.hasSummaries() && Objects.equals(summaries(), other.summaries())
&& Objects.equals(recommendationResourceTypeAsString(), other.recommendationResourceTypeAsString())
&& Objects.equals(accountId(), other.accountId())
&& Objects.equals(savingsOpportunity(), other.savingsOpportunity())
&& Objects.equals(currentPerformanceRiskRatings(), other.currentPerformanceRiskRatings())
&& hasInferredWorkloadSavings() == other.hasInferredWorkloadSavings()
&& Objects.equals(inferredWorkloadSavings(), other.inferredWorkloadSavings());
}
/**
* 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("RecommendationSummary").add("Summaries", hasSummaries() ? summaries() : null)
.add("RecommendationResourceType", recommendationResourceTypeAsString()).add("AccountId", accountId())
.add("SavingsOpportunity", savingsOpportunity())
.add("CurrentPerformanceRiskRatings", currentPerformanceRiskRatings())
.add("InferredWorkloadSavings", hasInferredWorkloadSavings() ? inferredWorkloadSavings() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "summaries":
return Optional.ofNullable(clazz.cast(summaries()));
case "recommendationResourceType":
return Optional.ofNullable(clazz.cast(recommendationResourceTypeAsString()));
case "accountId":
return Optional.ofNullable(clazz.cast(accountId()));
case "savingsOpportunity":
return Optional.ofNullable(clazz.cast(savingsOpportunity()));
case "currentPerformanceRiskRatings":
return Optional.ofNullable(clazz.cast(currentPerformanceRiskRatings()));
case "inferredWorkloadSavings":
return Optional.ofNullable(clazz.cast(inferredWorkloadSavings()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function