com.amazonaws.services.costexplorer.model.SavingsPlansUtilizationDetail Maven / Gradle / Ivy
Show all versions of aws-java-sdk-costexplorer Show documentation
/*
* Copyright 2015-2020 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 com.amazonaws.services.costexplorer.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* 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.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class SavingsPlansUtilizationDetail implements Serializable, Cloneable, StructuredPojo {
/**
*
* The unique Amazon Resource Name (ARN) for a particular Savings Plan.
*
*/
private String savingsPlanArn;
/**
*
* The attribute that applies to a specific Dimension.
*
*/
private java.util.Map attributes;
/**
*
* A ratio of your effectiveness of using existing Savings Plans to apply to workloads that are Savings Plans
* eligible.
*
*/
private SavingsPlansUtilization 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.
*
*/
private SavingsPlansSavings savings;
/**
*
* The total amortized commitment for a Savings Plans. Includes the sum of the upfront and recurring Savings Plans
* fees.
*
*/
private SavingsPlansAmortizedCommitment amortizedCommitment;
/**
*
* The unique Amazon Resource Name (ARN) for a particular Savings Plan.
*
*
* @param savingsPlanArn
* The unique Amazon Resource Name (ARN) for a particular Savings Plan.
*/
public void setSavingsPlanArn(String savingsPlanArn) {
this.savingsPlanArn = savingsPlanArn;
}
/**
*
* 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 getSavingsPlanArn() {
return this.savingsPlanArn;
}
/**
*
* 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.
*/
public SavingsPlansUtilizationDetail withSavingsPlanArn(String savingsPlanArn) {
setSavingsPlanArn(savingsPlanArn);
return this;
}
/**
*
* The attribute that applies to a specific Dimension.
*
*
* @return The attribute that applies to a specific Dimension.
*/
public java.util.Map getAttributes() {
return attributes;
}
/**
*
* The attribute that applies to a specific Dimension.
*
*
* @param attributes
* The attribute that applies to a specific Dimension.
*/
public void setAttributes(java.util.Map attributes) {
this.attributes = attributes;
}
/**
*
* 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.
*/
public SavingsPlansUtilizationDetail withAttributes(java.util.Map attributes) {
setAttributes(attributes);
return this;
}
/**
* Add a single Attributes entry
*
* @see SavingsPlansUtilizationDetail#withAttributes
* @returns a reference to this object so that method calls can be chained together.
*/
public SavingsPlansUtilizationDetail addAttributesEntry(String key, String value) {
if (null == this.attributes) {
this.attributes = new java.util.HashMap();
}
if (this.attributes.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.attributes.put(key, value);
return this;
}
/**
* Removes all the entries added into Attributes.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SavingsPlansUtilizationDetail clearAttributesEntries() {
this.attributes = null;
return this;
}
/**
*
* 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.
*/
public void setUtilization(SavingsPlansUtilization utilization) {
this.utilization = utilization;
}
/**
*
* 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 getUtilization() {
return this.utilization;
}
/**
*
* 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.
*/
public SavingsPlansUtilizationDetail withUtilization(SavingsPlansUtilization utilization) {
setUtilization(utilization);
return this;
}
/**
*
* 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.
*/
public void setSavings(SavingsPlansSavings savings) {
this.savings = 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 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 getSavings() {
return this.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.
*
*
* @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.
*/
public SavingsPlansUtilizationDetail withSavings(SavingsPlansSavings savings) {
setSavings(savings);
return this;
}
/**
*
* 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.
*/
public void setAmortizedCommitment(SavingsPlansAmortizedCommitment amortizedCommitment) {
this.amortizedCommitment = amortizedCommitment;
}
/**
*
* 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 getAmortizedCommitment() {
return this.amortizedCommitment;
}
/**
*
* 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.
*/
public SavingsPlansUtilizationDetail withAmortizedCommitment(SavingsPlansAmortizedCommitment amortizedCommitment) {
setAmortizedCommitment(amortizedCommitment);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getSavingsPlanArn() != null)
sb.append("SavingsPlanArn: ").append(getSavingsPlanArn()).append(",");
if (getAttributes() != null)
sb.append("Attributes: ").append(getAttributes()).append(",");
if (getUtilization() != null)
sb.append("Utilization: ").append(getUtilization()).append(",");
if (getSavings() != null)
sb.append("Savings: ").append(getSavings()).append(",");
if (getAmortizedCommitment() != null)
sb.append("AmortizedCommitment: ").append(getAmortizedCommitment());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof SavingsPlansUtilizationDetail == false)
return false;
SavingsPlansUtilizationDetail other = (SavingsPlansUtilizationDetail) obj;
if (other.getSavingsPlanArn() == null ^ this.getSavingsPlanArn() == null)
return false;
if (other.getSavingsPlanArn() != null && other.getSavingsPlanArn().equals(this.getSavingsPlanArn()) == false)
return false;
if (other.getAttributes() == null ^ this.getAttributes() == null)
return false;
if (other.getAttributes() != null && other.getAttributes().equals(this.getAttributes()) == false)
return false;
if (other.getUtilization() == null ^ this.getUtilization() == null)
return false;
if (other.getUtilization() != null && other.getUtilization().equals(this.getUtilization()) == false)
return false;
if (other.getSavings() == null ^ this.getSavings() == null)
return false;
if (other.getSavings() != null && other.getSavings().equals(this.getSavings()) == false)
return false;
if (other.getAmortizedCommitment() == null ^ this.getAmortizedCommitment() == null)
return false;
if (other.getAmortizedCommitment() != null && other.getAmortizedCommitment().equals(this.getAmortizedCommitment()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getSavingsPlanArn() == null) ? 0 : getSavingsPlanArn().hashCode());
hashCode = prime * hashCode + ((getAttributes() == null) ? 0 : getAttributes().hashCode());
hashCode = prime * hashCode + ((getUtilization() == null) ? 0 : getUtilization().hashCode());
hashCode = prime * hashCode + ((getSavings() == null) ? 0 : getSavings().hashCode());
hashCode = prime * hashCode + ((getAmortizedCommitment() == null) ? 0 : getAmortizedCommitment().hashCode());
return hashCode;
}
@Override
public SavingsPlansUtilizationDetail clone() {
try {
return (SavingsPlansUtilizationDetail) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.costexplorer.model.transform.SavingsPlansUtilizationDetailMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}