software.amazon.awssdk.services.costexplorer.model.SavingsPlansUtilizationDetail Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of costexplorer Show documentation
Show all versions of costexplorer Show documentation
The AWS Java SDK for AWS Cost Explorer module holds the client classes that are used for communicating
with AWS Cost Explorer Service
/*
* 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.costexplorer.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
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 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.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* A single daily or monthly Savings Plans utilization rate, and details for your account. Master accounts in an
* organization have access to member accounts. You can use GetDimensionValues to determine the possible
* dimension values.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class SavingsPlansUtilizationDetail implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField SAVINGS_PLAN_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(SavingsPlansUtilizationDetail::savingsPlanArn)).setter(setter(Builder::savingsPlanArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SavingsPlanArn").build()).build();
private static final SdkField> ATTRIBUTES_FIELD = SdkField
.> builder(MarshallingType.MAP)
.getter(getter(SavingsPlansUtilizationDetail::attributes))
.setter(setter(Builder::attributes))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Attributes").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final SdkField UTILIZATION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO)
.getter(getter(SavingsPlansUtilizationDetail::utilization)).setter(setter(Builder::utilization))
.constructor(SavingsPlansUtilization::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Utilization").build()).build();
private static final SdkField SAVINGS_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).getter(getter(SavingsPlansUtilizationDetail::savings))
.setter(setter(Builder::savings)).constructor(SavingsPlansSavings::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Savings").build()).build();
private static final SdkField AMORTIZED_COMMITMENT_FIELD = SdkField
. builder(MarshallingType.SDK_POJO)
.getter(getter(SavingsPlansUtilizationDetail::amortizedCommitment)).setter(setter(Builder::amortizedCommitment))
.constructor(SavingsPlansAmortizedCommitment::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AmortizedCommitment").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(SAVINGS_PLAN_ARN_FIELD,
ATTRIBUTES_FIELD, UTILIZATION_FIELD, SAVINGS_FIELD, AMORTIZED_COMMITMENT_FIELD));
private static final long serialVersionUID = 1L;
private final String savingsPlanArn;
private final Map attributes;
private final SavingsPlansUtilization utilization;
private final SavingsPlansSavings savings;
private final SavingsPlansAmortizedCommitment amortizedCommitment;
private SavingsPlansUtilizationDetail(BuilderImpl builder) {
this.savingsPlanArn = builder.savingsPlanArn;
this.attributes = builder.attributes;
this.utilization = builder.utilization;
this.savings = builder.savings;
this.amortizedCommitment = builder.amortizedCommitment;
}
/**
*
* The unique Amazon Resource Name (ARN) for a particular Savings Plan.
*
*
* @return The unique Amazon Resource Name (ARN) for a particular Savings Plan.
*/
public String savingsPlanArn() {
return savingsPlanArn;
}
/**
* Returns true if the Attributes 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 boolean hasAttributes() {
return attributes != null && !(attributes instanceof SdkAutoConstructMap);
}
/**
*
* The attribute that applies to a specific Dimension.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasAttributes()} to see if a value was sent in this field.
*
*
* @return The attribute that applies to a specific Dimension.
*/
public Map attributes() {
return attributes;
}
/**
*
* A ratio of your effectiveness of using existing Savings Plans to apply to workloads that are Savings Plans
* eligible.
*
*
* @return A ratio of your effectiveness of using existing Savings Plans to apply to workloads that are Savings
* Plans eligible.
*/
public SavingsPlansUtilization utilization() {
return utilization;
}
/**
*
* The amount saved by using existing Savings Plans. Savings returns both net savings from savings plans as well as
* the onDemandCostEquivalent of the Savings Plans when considering the utilization rate.
*
*
* @return The amount saved by using existing Savings Plans. Savings returns both net savings from savings plans as
* well as the onDemandCostEquivalent of the Savings Plans when considering the utilization
* rate.
*/
public SavingsPlansSavings savings() {
return savings;
}
/**
*
* The total amortized commitment for a Savings Plans. Includes the sum of the upfront and recurring Savings Plans
* fees.
*
*
* @return The total amortized commitment for a Savings Plans. Includes the sum of the upfront and recurring Savings
* Plans fees.
*/
public SavingsPlansAmortizedCommitment amortizedCommitment() {
return amortizedCommitment;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(savingsPlanArn());
hashCode = 31 * hashCode + Objects.hashCode(attributes());
hashCode = 31 * hashCode + Objects.hashCode(utilization());
hashCode = 31 * hashCode + Objects.hashCode(savings());
hashCode = 31 * hashCode + Objects.hashCode(amortizedCommitment());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof SavingsPlansUtilizationDetail)) {
return false;
}
SavingsPlansUtilizationDetail other = (SavingsPlansUtilizationDetail) obj;
return Objects.equals(savingsPlanArn(), other.savingsPlanArn()) && Objects.equals(attributes(), other.attributes())
&& Objects.equals(utilization(), other.utilization()) && Objects.equals(savings(), other.savings())
&& Objects.equals(amortizedCommitment(), other.amortizedCommitment());
}
/**
* 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 String toString() {
return ToString.builder("SavingsPlansUtilizationDetail").add("SavingsPlanArn", savingsPlanArn())
.add("Attributes", attributes()).add("Utilization", utilization()).add("Savings", savings())
.add("AmortizedCommitment", amortizedCommitment()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "SavingsPlanArn":
return Optional.ofNullable(clazz.cast(savingsPlanArn()));
case "Attributes":
return Optional.ofNullable(clazz.cast(attributes()));
case "Utilization":
return Optional.ofNullable(clazz.cast(utilization()));
case "Savings":
return Optional.ofNullable(clazz.cast(savings()));
case "AmortizedCommitment":
return Optional.ofNullable(clazz.cast(amortizedCommitment()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((SavingsPlansUtilizationDetail) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The unique Amazon Resource Name (ARN) for a particular Savings Plan.
*
*
* @param savingsPlanArn
* The unique Amazon Resource Name (ARN) for a particular Savings Plan.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder savingsPlanArn(String savingsPlanArn);
/**
*
* The attribute that applies to a specific Dimension.
*
*
* @param attributes
* The attribute that applies to a specific Dimension.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder attributes(Map attributes);
/**
*
* A ratio of your effectiveness of using existing Savings Plans to apply to workloads that are Savings Plans
* eligible.
*
*
* @param utilization
* A ratio of your effectiveness of using existing Savings Plans to apply to workloads that are Savings
* Plans eligible.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder utilization(SavingsPlansUtilization utilization);
/**
*
* A ratio of your effectiveness of using existing Savings Plans to apply to workloads that are Savings Plans
* eligible.
*
* This is a convenience that creates an instance of the {@link SavingsPlansUtilization.Builder} avoiding the
* need to create one manually via {@link SavingsPlansUtilization#builder()}.
*
* When the {@link Consumer} completes, {@link SavingsPlansUtilization.Builder#build()} is called immediately
* and its result is passed to {@link #utilization(SavingsPlansUtilization)}.
*
* @param utilization
* a consumer that will call methods on {@link SavingsPlansUtilization.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #utilization(SavingsPlansUtilization)
*/
default Builder utilization(Consumer utilization) {
return utilization(SavingsPlansUtilization.builder().applyMutation(utilization).build());
}
/**
*
* The amount saved by using existing Savings Plans. Savings returns both net savings from savings plans as well
* as the onDemandCostEquivalent of the Savings Plans when considering the utilization rate.
*
*
* @param savings
* The amount saved by using existing Savings Plans. Savings returns both net savings from savings plans
* as well as the onDemandCostEquivalent of the Savings Plans when considering the
* utilization rate.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder savings(SavingsPlansSavings savings);
/**
*
* The amount saved by using existing Savings Plans. Savings returns both net savings from savings plans as well
* as the onDemandCostEquivalent of the Savings Plans when considering the utilization rate.
*
* This is a convenience that creates an instance of the {@link SavingsPlansSavings.Builder} avoiding the need
* to create one manually via {@link SavingsPlansSavings#builder()}.
*
* When the {@link Consumer} completes, {@link SavingsPlansSavings.Builder#build()} is called immediately and
* its result is passed to {@link #savings(SavingsPlansSavings)}.
*
* @param savings
* a consumer that will call methods on {@link SavingsPlansSavings.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #savings(SavingsPlansSavings)
*/
default Builder savings(Consumer savings) {
return savings(SavingsPlansSavings.builder().applyMutation(savings).build());
}
/**
*
* The total amortized commitment for a Savings Plans. Includes the sum of the upfront and recurring Savings
* Plans fees.
*
*
* @param amortizedCommitment
* The total amortized commitment for a Savings Plans. Includes the sum of the upfront and recurring
* Savings Plans fees.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder amortizedCommitment(SavingsPlansAmortizedCommitment amortizedCommitment);
/**
*
* The total amortized commitment for a Savings Plans. Includes the sum of the upfront and recurring Savings
* Plans fees.
*
* This is a convenience that creates an instance of the {@link SavingsPlansAmortizedCommitment.Builder}
* avoiding the need to create one manually via {@link SavingsPlansAmortizedCommitment#builder()}.
*
* When the {@link Consumer} completes, {@link SavingsPlansAmortizedCommitment.Builder#build()} is called
* immediately and its result is passed to {@link #amortizedCommitment(SavingsPlansAmortizedCommitment)}.
*
* @param amortizedCommitment
* a consumer that will call methods on {@link SavingsPlansAmortizedCommitment.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #amortizedCommitment(SavingsPlansAmortizedCommitment)
*/
default Builder amortizedCommitment(Consumer amortizedCommitment) {
return amortizedCommitment(SavingsPlansAmortizedCommitment.builder().applyMutation(amortizedCommitment).build());
}
}
static final class BuilderImpl implements Builder {
private String savingsPlanArn;
private Map attributes = DefaultSdkAutoConstructMap.getInstance();
private SavingsPlansUtilization utilization;
private SavingsPlansSavings savings;
private SavingsPlansAmortizedCommitment amortizedCommitment;
private BuilderImpl() {
}
private BuilderImpl(SavingsPlansUtilizationDetail model) {
savingsPlanArn(model.savingsPlanArn);
attributes(model.attributes);
utilization(model.utilization);
savings(model.savings);
amortizedCommitment(model.amortizedCommitment);
}
public final String getSavingsPlanArn() {
return savingsPlanArn;
}
@Override
public final Builder savingsPlanArn(String savingsPlanArn) {
this.savingsPlanArn = savingsPlanArn;
return this;
}
public final void setSavingsPlanArn(String savingsPlanArn) {
this.savingsPlanArn = savingsPlanArn;
}
public final Map getAttributes() {
return attributes;
}
@Override
public final Builder attributes(Map attributes) {
this.attributes = AttributesCopier.copy(attributes);
return this;
}
public final void setAttributes(Map attributes) {
this.attributes = AttributesCopier.copy(attributes);
}
public final SavingsPlansUtilization.Builder getUtilization() {
return utilization != null ? utilization.toBuilder() : null;
}
@Override
public final Builder utilization(SavingsPlansUtilization utilization) {
this.utilization = utilization;
return this;
}
public final void setUtilization(SavingsPlansUtilization.BuilderImpl utilization) {
this.utilization = utilization != null ? utilization.build() : null;
}
public final SavingsPlansSavings.Builder getSavings() {
return savings != null ? savings.toBuilder() : null;
}
@Override
public final Builder savings(SavingsPlansSavings savings) {
this.savings = savings;
return this;
}
public final void setSavings(SavingsPlansSavings.BuilderImpl savings) {
this.savings = savings != null ? savings.build() : null;
}
public final SavingsPlansAmortizedCommitment.Builder getAmortizedCommitment() {
return amortizedCommitment != null ? amortizedCommitment.toBuilder() : null;
}
@Override
public final Builder amortizedCommitment(SavingsPlansAmortizedCommitment amortizedCommitment) {
this.amortizedCommitment = amortizedCommitment;
return this;
}
public final void setAmortizedCommitment(SavingsPlansAmortizedCommitment.BuilderImpl amortizedCommitment) {
this.amortizedCommitment = amortizedCommitment != null ? amortizedCommitment.build() : null;
}
@Override
public SavingsPlansUtilizationDetail build() {
return new SavingsPlansUtilizationDetail(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy