com.amazonaws.services.costexplorer.model.SavingsPlansPurchaseRecommendation Maven / Gradle / Ivy
Show all versions of aws-java-sdk-costexplorer Show documentation
/*
* Copyright 2020-2025 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;
/**
*
* Contains your request parameters, Savings Plan Recommendations Summary, and Details.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class SavingsPlansPurchaseRecommendation implements Serializable, Cloneable, StructuredPojo {
/**
*
* The account scope that you want your recommendations for. Amazon Web Services calculates recommendations that
* include the management account and member accounts if the value is set to PAYER. If the value is
* LINKED, recommendations are calculated for individual member accounts only.
*
*/
private String accountScope;
/**
*
* The requested Savings Plans recommendation type.
*
*/
private String savingsPlansType;
/**
*
* The Savings Plans recommendation term in years. It's used to generate the recommendation.
*
*/
private String termInYears;
/**
*
* The payment option that's used to generate the recommendation.
*
*/
private String paymentOption;
/**
*
* The lookback period in days that's used to generate the recommendation.
*
*/
private String lookbackPeriodInDays;
/**
*
* Details for the Savings Plans that we recommend that you purchase to cover existing Savings Plans eligible
* workloads.
*
*/
private java.util.List savingsPlansPurchaseRecommendationDetails;
/**
*
* Summary metrics for your Savings Plans Recommendations.
*
*/
private SavingsPlansPurchaseRecommendationSummary savingsPlansPurchaseRecommendationSummary;
/**
*
* The account scope that you want your recommendations for. Amazon Web Services calculates recommendations that
* include the management account and member accounts if the value is set to PAYER. If the value is
* LINKED, recommendations are calculated for individual member accounts only.
*
*
* @param accountScope
* The account scope that you want your recommendations for. Amazon Web Services calculates recommendations
* that include the management account and member accounts if the value is set to PAYER. If the
* value is LINKED, recommendations are calculated for individual member accounts only.
* @see AccountScope
*/
public void setAccountScope(String accountScope) {
this.accountScope = accountScope;
}
/**
*
* The account scope that you want your recommendations for. Amazon Web Services calculates recommendations that
* include the management account and member accounts if the value is set to PAYER. If the value is
* LINKED, recommendations are calculated for individual member accounts only.
*
*
* @return The account scope that you want your recommendations for. Amazon Web Services calculates recommendations
* that include the management account and member accounts if the value is set to PAYER. If the
* value is LINKED, recommendations are calculated for individual member accounts only.
* @see AccountScope
*/
public String getAccountScope() {
return this.accountScope;
}
/**
*
* The account scope that you want your recommendations for. Amazon Web Services calculates recommendations that
* include the management account and member accounts if the value is set to PAYER. If the value is
* LINKED, recommendations are calculated for individual member accounts only.
*
*
* @param accountScope
* The account scope that you want your recommendations for. Amazon Web Services calculates recommendations
* that include the management account and member accounts if the value is set to PAYER. If the
* value is LINKED, recommendations are calculated for individual member accounts only.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AccountScope
*/
public SavingsPlansPurchaseRecommendation withAccountScope(String accountScope) {
setAccountScope(accountScope);
return this;
}
/**
*
* The account scope that you want your recommendations for. Amazon Web Services calculates recommendations that
* include the management account and member accounts if the value is set to PAYER. If the value is
* LINKED, recommendations are calculated for individual member accounts only.
*
*
* @param accountScope
* The account scope that you want your recommendations for. Amazon Web Services calculates recommendations
* that include the management account and member accounts if the value is set to PAYER. If the
* value is LINKED, recommendations are calculated for individual member accounts only.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AccountScope
*/
public SavingsPlansPurchaseRecommendation withAccountScope(AccountScope accountScope) {
this.accountScope = accountScope.toString();
return this;
}
/**
*
* The requested Savings Plans recommendation type.
*
*
* @param savingsPlansType
* The requested Savings Plans recommendation type.
* @see SupportedSavingsPlansType
*/
public void setSavingsPlansType(String savingsPlansType) {
this.savingsPlansType = savingsPlansType;
}
/**
*
* The requested Savings Plans recommendation type.
*
*
* @return The requested Savings Plans recommendation type.
* @see SupportedSavingsPlansType
*/
public String getSavingsPlansType() {
return this.savingsPlansType;
}
/**
*
* The requested Savings Plans recommendation type.
*
*
* @param savingsPlansType
* The requested Savings Plans recommendation type.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SupportedSavingsPlansType
*/
public SavingsPlansPurchaseRecommendation withSavingsPlansType(String savingsPlansType) {
setSavingsPlansType(savingsPlansType);
return this;
}
/**
*
* The requested Savings Plans recommendation type.
*
*
* @param savingsPlansType
* The requested Savings Plans recommendation type.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SupportedSavingsPlansType
*/
public SavingsPlansPurchaseRecommendation withSavingsPlansType(SupportedSavingsPlansType savingsPlansType) {
this.savingsPlansType = savingsPlansType.toString();
return this;
}
/**
*
* The Savings Plans recommendation term in years. It's used to generate the recommendation.
*
*
* @param termInYears
* The Savings Plans recommendation term in years. It's used to generate the recommendation.
* @see TermInYears
*/
public void setTermInYears(String termInYears) {
this.termInYears = termInYears;
}
/**
*
* The Savings Plans recommendation term in years. It's used to generate the recommendation.
*
*
* @return The Savings Plans recommendation term in years. It's used to generate the recommendation.
* @see TermInYears
*/
public String getTermInYears() {
return this.termInYears;
}
/**
*
* The Savings Plans recommendation term in years. It's used to generate the recommendation.
*
*
* @param termInYears
* The Savings Plans recommendation term in years. It's used to generate the recommendation.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TermInYears
*/
public SavingsPlansPurchaseRecommendation withTermInYears(String termInYears) {
setTermInYears(termInYears);
return this;
}
/**
*
* The Savings Plans recommendation term in years. It's used to generate the recommendation.
*
*
* @param termInYears
* The Savings Plans recommendation term in years. It's used to generate the recommendation.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TermInYears
*/
public SavingsPlansPurchaseRecommendation withTermInYears(TermInYears termInYears) {
this.termInYears = termInYears.toString();
return this;
}
/**
*
* The payment option that's used to generate the recommendation.
*
*
* @param paymentOption
* The payment option that's used to generate the recommendation.
* @see PaymentOption
*/
public void setPaymentOption(String paymentOption) {
this.paymentOption = paymentOption;
}
/**
*
* The payment option that's used to generate the recommendation.
*
*
* @return The payment option that's used to generate the recommendation.
* @see PaymentOption
*/
public String getPaymentOption() {
return this.paymentOption;
}
/**
*
* The payment option that's used to generate the recommendation.
*
*
* @param paymentOption
* The payment option that's used to generate the recommendation.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PaymentOption
*/
public SavingsPlansPurchaseRecommendation withPaymentOption(String paymentOption) {
setPaymentOption(paymentOption);
return this;
}
/**
*
* The payment option that's used to generate the recommendation.
*
*
* @param paymentOption
* The payment option that's used to generate the recommendation.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PaymentOption
*/
public SavingsPlansPurchaseRecommendation withPaymentOption(PaymentOption paymentOption) {
this.paymentOption = paymentOption.toString();
return this;
}
/**
*
* The lookback period in days that's used to generate the recommendation.
*
*
* @param lookbackPeriodInDays
* The lookback period in days that's used to generate the recommendation.
* @see LookbackPeriodInDays
*/
public void setLookbackPeriodInDays(String lookbackPeriodInDays) {
this.lookbackPeriodInDays = lookbackPeriodInDays;
}
/**
*
* The lookback period in days that's used to generate the recommendation.
*
*
* @return The lookback period in days that's used to generate the recommendation.
* @see LookbackPeriodInDays
*/
public String getLookbackPeriodInDays() {
return this.lookbackPeriodInDays;
}
/**
*
* The lookback period in days that's used to generate the recommendation.
*
*
* @param lookbackPeriodInDays
* The lookback period in days that's used to generate the recommendation.
* @return Returns a reference to this object so that method calls can be chained together.
* @see LookbackPeriodInDays
*/
public SavingsPlansPurchaseRecommendation withLookbackPeriodInDays(String lookbackPeriodInDays) {
setLookbackPeriodInDays(lookbackPeriodInDays);
return this;
}
/**
*
* The lookback period in days that's used to generate the recommendation.
*
*
* @param lookbackPeriodInDays
* The lookback period in days that's used to generate the recommendation.
* @return Returns a reference to this object so that method calls can be chained together.
* @see LookbackPeriodInDays
*/
public SavingsPlansPurchaseRecommendation withLookbackPeriodInDays(LookbackPeriodInDays lookbackPeriodInDays) {
this.lookbackPeriodInDays = lookbackPeriodInDays.toString();
return this;
}
/**
*
* Details for the Savings Plans that we recommend that you purchase to cover existing Savings Plans eligible
* workloads.
*
*
* @return Details for the Savings Plans that we recommend that you purchase to cover existing Savings Plans
* eligible workloads.
*/
public java.util.List getSavingsPlansPurchaseRecommendationDetails() {
return savingsPlansPurchaseRecommendationDetails;
}
/**
*
* Details for the Savings Plans that we recommend that you purchase to cover existing Savings Plans eligible
* workloads.
*
*
* @param savingsPlansPurchaseRecommendationDetails
* Details for the Savings Plans that we recommend that you purchase to cover existing Savings Plans eligible
* workloads.
*/
public void setSavingsPlansPurchaseRecommendationDetails(
java.util.Collection savingsPlansPurchaseRecommendationDetails) {
if (savingsPlansPurchaseRecommendationDetails == null) {
this.savingsPlansPurchaseRecommendationDetails = null;
return;
}
this.savingsPlansPurchaseRecommendationDetails = new java.util.ArrayList(
savingsPlansPurchaseRecommendationDetails);
}
/**
*
* Details for the Savings Plans that we recommend that you purchase to cover existing Savings Plans eligible
* workloads.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setSavingsPlansPurchaseRecommendationDetails(java.util.Collection)} or
* {@link #withSavingsPlansPurchaseRecommendationDetails(java.util.Collection)} if you want to override the existing
* values.
*
*
* @param savingsPlansPurchaseRecommendationDetails
* Details for the Savings Plans that we recommend that you purchase to cover existing Savings Plans eligible
* workloads.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SavingsPlansPurchaseRecommendation withSavingsPlansPurchaseRecommendationDetails(
SavingsPlansPurchaseRecommendationDetail... savingsPlansPurchaseRecommendationDetails) {
if (this.savingsPlansPurchaseRecommendationDetails == null) {
setSavingsPlansPurchaseRecommendationDetails(new java.util.ArrayList(
savingsPlansPurchaseRecommendationDetails.length));
}
for (SavingsPlansPurchaseRecommendationDetail ele : savingsPlansPurchaseRecommendationDetails) {
this.savingsPlansPurchaseRecommendationDetails.add(ele);
}
return this;
}
/**
*
* Details for the Savings Plans that we recommend that you purchase to cover existing Savings Plans eligible
* workloads.
*
*
* @param savingsPlansPurchaseRecommendationDetails
* Details for the Savings Plans that we recommend that you purchase to cover existing Savings Plans eligible
* workloads.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SavingsPlansPurchaseRecommendation withSavingsPlansPurchaseRecommendationDetails(
java.util.Collection savingsPlansPurchaseRecommendationDetails) {
setSavingsPlansPurchaseRecommendationDetails(savingsPlansPurchaseRecommendationDetails);
return this;
}
/**
*
* Summary metrics for your Savings Plans Recommendations.
*
*
* @param savingsPlansPurchaseRecommendationSummary
* Summary metrics for your Savings Plans Recommendations.
*/
public void setSavingsPlansPurchaseRecommendationSummary(SavingsPlansPurchaseRecommendationSummary savingsPlansPurchaseRecommendationSummary) {
this.savingsPlansPurchaseRecommendationSummary = savingsPlansPurchaseRecommendationSummary;
}
/**
*
* Summary metrics for your Savings Plans Recommendations.
*
*
* @return Summary metrics for your Savings Plans Recommendations.
*/
public SavingsPlansPurchaseRecommendationSummary getSavingsPlansPurchaseRecommendationSummary() {
return this.savingsPlansPurchaseRecommendationSummary;
}
/**
*
* Summary metrics for your Savings Plans Recommendations.
*
*
* @param savingsPlansPurchaseRecommendationSummary
* Summary metrics for your Savings Plans Recommendations.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SavingsPlansPurchaseRecommendation withSavingsPlansPurchaseRecommendationSummary(
SavingsPlansPurchaseRecommendationSummary savingsPlansPurchaseRecommendationSummary) {
setSavingsPlansPurchaseRecommendationSummary(savingsPlansPurchaseRecommendationSummary);
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 (getAccountScope() != null)
sb.append("AccountScope: ").append(getAccountScope()).append(",");
if (getSavingsPlansType() != null)
sb.append("SavingsPlansType: ").append(getSavingsPlansType()).append(",");
if (getTermInYears() != null)
sb.append("TermInYears: ").append(getTermInYears()).append(",");
if (getPaymentOption() != null)
sb.append("PaymentOption: ").append(getPaymentOption()).append(",");
if (getLookbackPeriodInDays() != null)
sb.append("LookbackPeriodInDays: ").append(getLookbackPeriodInDays()).append(",");
if (getSavingsPlansPurchaseRecommendationDetails() != null)
sb.append("SavingsPlansPurchaseRecommendationDetails: ").append(getSavingsPlansPurchaseRecommendationDetails()).append(",");
if (getSavingsPlansPurchaseRecommendationSummary() != null)
sb.append("SavingsPlansPurchaseRecommendationSummary: ").append(getSavingsPlansPurchaseRecommendationSummary());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof SavingsPlansPurchaseRecommendation == false)
return false;
SavingsPlansPurchaseRecommendation other = (SavingsPlansPurchaseRecommendation) obj;
if (other.getAccountScope() == null ^ this.getAccountScope() == null)
return false;
if (other.getAccountScope() != null && other.getAccountScope().equals(this.getAccountScope()) == false)
return false;
if (other.getSavingsPlansType() == null ^ this.getSavingsPlansType() == null)
return false;
if (other.getSavingsPlansType() != null && other.getSavingsPlansType().equals(this.getSavingsPlansType()) == false)
return false;
if (other.getTermInYears() == null ^ this.getTermInYears() == null)
return false;
if (other.getTermInYears() != null && other.getTermInYears().equals(this.getTermInYears()) == false)
return false;
if (other.getPaymentOption() == null ^ this.getPaymentOption() == null)
return false;
if (other.getPaymentOption() != null && other.getPaymentOption().equals(this.getPaymentOption()) == false)
return false;
if (other.getLookbackPeriodInDays() == null ^ this.getLookbackPeriodInDays() == null)
return false;
if (other.getLookbackPeriodInDays() != null && other.getLookbackPeriodInDays().equals(this.getLookbackPeriodInDays()) == false)
return false;
if (other.getSavingsPlansPurchaseRecommendationDetails() == null ^ this.getSavingsPlansPurchaseRecommendationDetails() == null)
return false;
if (other.getSavingsPlansPurchaseRecommendationDetails() != null
&& other.getSavingsPlansPurchaseRecommendationDetails().equals(this.getSavingsPlansPurchaseRecommendationDetails()) == false)
return false;
if (other.getSavingsPlansPurchaseRecommendationSummary() == null ^ this.getSavingsPlansPurchaseRecommendationSummary() == null)
return false;
if (other.getSavingsPlansPurchaseRecommendationSummary() != null
&& other.getSavingsPlansPurchaseRecommendationSummary().equals(this.getSavingsPlansPurchaseRecommendationSummary()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAccountScope() == null) ? 0 : getAccountScope().hashCode());
hashCode = prime * hashCode + ((getSavingsPlansType() == null) ? 0 : getSavingsPlansType().hashCode());
hashCode = prime * hashCode + ((getTermInYears() == null) ? 0 : getTermInYears().hashCode());
hashCode = prime * hashCode + ((getPaymentOption() == null) ? 0 : getPaymentOption().hashCode());
hashCode = prime * hashCode + ((getLookbackPeriodInDays() == null) ? 0 : getLookbackPeriodInDays().hashCode());
hashCode = prime * hashCode
+ ((getSavingsPlansPurchaseRecommendationDetails() == null) ? 0 : getSavingsPlansPurchaseRecommendationDetails().hashCode());
hashCode = prime * hashCode
+ ((getSavingsPlansPurchaseRecommendationSummary() == null) ? 0 : getSavingsPlansPurchaseRecommendationSummary().hashCode());
return hashCode;
}
@Override
public SavingsPlansPurchaseRecommendation clone() {
try {
return (SavingsPlansPurchaseRecommendation) 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.SavingsPlansPurchaseRecommendationMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}