/*
* Copyright 2010-2018 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.ec2.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.Request;
import com.amazonaws.services.ec2.model.transform.PurchaseReservedInstancesOfferingRequestMarshaller;
/**
* Container for the parameters to the {@link com.amazonaws.services.ec2.AmazonEC2#purchaseReservedInstancesOffering(PurchaseReservedInstancesOfferingRequest) PurchaseReservedInstancesOffering operation}.
* <p>
* Purchases a Reserved Instance for use with your account. With Reserved
* Instances, you obtain a capacity reservation for a certain instance
* configuration over a specified period of time and pay a lower hourly
* rate compared to On-Demand instance pricing.
* </p>
* <p>
* Use DescribeReservedInstancesOfferings to get a list of Reserved
* Instance offerings that match your specifications. After you've
* purchased a Reserved Instance, you can check for your new Reserved
* Instance with DescribeReservedInstances.
* </p>
* <p>
* For more information, see
* <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts-on-demand-reserved-instances.html"> Reserved Instances </a> and <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html"> Reserved Instance Marketplace </a>
* in the <i>Amazon Elastic Compute Cloud User Guide</i> .
* </p>
*
* @see com.amazonaws.services.ec2.AmazonEC2#purchaseReservedInstancesOffering(PurchaseReservedInstancesOfferingRequest)
*/
public class PurchaseReservedInstancesOfferingRequest extends AmazonWebServiceRequest implements Serializable, DryRunSupportedRequest<PurchaseReservedInstancesOfferingRequest> {
/**
* The ID of the Reserved Instance offering to purchase.
*/
private String reservedInstancesOfferingId;
/**
* The number of Reserved Instances to purchase.
*/
private Integer instanceCount;
/**
* Specified for Reserved Instance Marketplace offerings to limit the
* total order and ensure that the Reserved Instances are not purchased
* at unexpected prices.
*/
private ReservedInstanceLimitPrice limitPrice;
/**
* Default constructor for a new PurchaseReservedInstancesOfferingRequest object. Callers should use the
* setter or fluent setter (with...) methods to initialize this object after creating it.
*/
public PurchaseReservedInstancesOfferingRequest() {}
/**
* Constructs a new PurchaseReservedInstancesOfferingRequest object.
* Callers should use the setter or fluent setter (with...) methods to
* initialize any additional object members.
*
* @param reservedInstancesOfferingId The ID of the Reserved Instance
* offering to purchase.
* @param instanceCount The number of Reserved Instances to purchase.
*/
public PurchaseReservedInstancesOfferingRequest(String reservedInstancesOfferingId, Integer instanceCount) {
setReservedInstancesOfferingId(reservedInstancesOfferingId);
setInstanceCount(instanceCount);
}
/**
* The ID of the Reserved Instance offering to purchase.
*
* @return The ID of the Reserved Instance offering to purchase.
*/
public String getReservedInstancesOfferingId() {
return reservedInstancesOfferingId;
}
/**
* The ID of the Reserved Instance offering to purchase.
*
* @param reservedInstancesOfferingId The ID of the Reserved Instance offering to purchase.
*/
public void setReservedInstancesOfferingId(String reservedInstancesOfferingId) {
this.reservedInstancesOfferingId = reservedInstancesOfferingId;
}
/**
* The ID of the Reserved Instance offering to purchase.
* <p>
* Returns a reference to this object so that method calls can be chained together.
*
* @param reservedInstancesOfferingId The ID of the Reserved Instance offering to purchase.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public PurchaseReservedInstancesOfferingRequest withReservedInstancesOfferingId(String reservedInstancesOfferingId) {
this.reservedInstancesOfferingId = reservedInstancesOfferingId;
return this;
}
/**
* The number of Reserved Instances to purchase.
*
* @return The number of Reserved Instances to purchase.
*/
public Integer getInstanceCount() {
return instanceCount;
}
/**
* The number of Reserved Instances to purchase.
*
* @param instanceCount The number of Reserved Instances to purchase.
*/
public void setInstanceCount(Integer instanceCount) {
this.instanceCount = instanceCount;
}
/**
* The number of Reserved Instances to purchase.
* <p>
* Returns a reference to this object so that method calls can be chained together.
*
* @param instanceCount The number of Reserved Instances to purchase.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public PurchaseReservedInstancesOfferingRequest withInstanceCount(Integer instanceCount) {
this.instanceCount = instanceCount;
return this;
}
/**
* Specified for Reserved Instance Marketplace offerings to limit the
* total order and ensure that the Reserved Instances are not purchased
* at unexpected prices.
*
* @return Specified for Reserved Instance Marketplace offerings to limit the
* total order and ensure that the Reserved Instances are not purchased
* at unexpected prices.
*/
public ReservedInstanceLimitPrice getLimitPrice() {
return limitPrice;
}
/**
* Specified for Reserved Instance Marketplace offerings to limit the
* total order and ensure that the Reserved Instances are not purchased
* at unexpected prices.
*
* @param limitPrice Specified for Reserved Instance Marketplace offerings to limit the
* total order and ensure that the Reserved Instances are not purchased
* at unexpected prices.
*/
public void setLimitPrice(ReservedInstanceLimitPrice limitPrice) {
this.limitPrice = limitPrice;
}
/**
* Specified for Reserved Instance Marketplace offerings to limit the
* total order and ensure that the Reserved Instances are not purchased
* at unexpected prices.
* <p>
* Returns a reference to this object so that method calls can be chained together.
*
* @param limitPrice Specified for Reserved Instance Marketplace offerings to limit the
* total order and ensure that the Reserved Instances are not purchased
* at unexpected prices.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public PurchaseReservedInstancesOfferingRequest withLimitPrice(ReservedInstanceLimitPrice limitPrice) {
this.limitPrice = limitPrice;
return this;
}
/**
* This method is intended for internal use only.
* Returns the marshaled request configured with additional parameters to
* enable operation dry-run.
*/
@Override
public Request<PurchaseReservedInstancesOfferingRequest> getDryRunRequest() {
Request<PurchaseReservedInstancesOfferingRequest> request = new PurchaseReservedInstancesOfferingRequestMarshaller().marshall(this);
request.addParameter("DryRun", Boolean.toString(true));
return request;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getReservedInstancesOfferingId() != null) sb.append("ReservedInstancesOfferingId: " + getReservedInstancesOfferingId() + ",");
if (getInstanceCount() != null) sb.append("InstanceCount: " + getInstanceCount() + ",");
if (getLimitPrice() != null) sb.append("LimitPrice: " + getLimitPrice() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getReservedInstancesOfferingId() == null) ? 0 : getReservedInstancesOfferingId().hashCode());
hashCode = prime * hashCode + ((getInstanceCount() == null) ? 0 : getInstanceCount().hashCode());
hashCode = prime * hashCode + ((getLimitPrice() == null) ? 0 : getLimitPrice().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof PurchaseReservedInstancesOfferingRequest == false) return false;
PurchaseReservedInstancesOfferingRequest other = (PurchaseReservedInstancesOfferingRequest)obj;
if (other.getReservedInstancesOfferingId() == null ^ this.getReservedInstancesOfferingId() == null) return false;
if (other.getReservedInstancesOfferingId() != null && other.getReservedInstancesOfferingId().equals(this.getReservedInstancesOfferingId()) == false) return false;
if (other.getInstanceCount() == null ^ this.getInstanceCount() == null) return false;
if (other.getInstanceCount() != null && other.getInstanceCount().equals(this.getInstanceCount()) == false) return false;
if (other.getLimitPrice() == null ^ this.getLimitPrice() == null) return false;
if (other.getLimitPrice() != null && other.getLimitPrice().equals(this.getLimitPrice()) == false) return false;
return true;
}
}