com.amazonaws.services.ec2.model.DescribeReservedInstancesRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2010-2014 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.DescribeReservedInstancesRequestMarshaller;
/**
* Container for the parameters to the {@link com.amazonaws.services.ec2.AmazonEC2#describeReservedInstances(DescribeReservedInstancesRequest) DescribeReservedInstances operation}.
*
* Describes one or more of the Reserved Instances that you purchased.
*
*
* For more information about Reserved Instances, see
* Reserved Instances
* in the Amazon Elastic Compute Cloud User Guide .
*
*
* @see com.amazonaws.services.ec2.AmazonEC2#describeReservedInstances(DescribeReservedInstancesRequest)
*/
public class DescribeReservedInstancesRequest extends AmazonWebServiceRequest implements Serializable, DryRunSupportedRequest {
/**
* One or more Reserved Instance IDs. Default: Describes all your
* Reserved Instances, or only those otherwise specified.
*/
private com.amazonaws.internal.ListWithAutoConstructFlag reservedInstancesIds;
/**
* One or more filters. -
availability-zone - The
* Availability Zone where the Reserved Instance can be used.
-
*
duration - The duration of the Reserved Instance (one
* year or three years), in seconds (31536000 |
* 94608000).
-
end - The time when
* the Reserved Instance expires.
-
fixed-price
* - The purchase price of the Reserved Instance (for example, 9800.0).
*
-
instance-type - The instance type on which
* the Reserved Instance can be used.
-
*
product-description - The product description of the
* Reserved Instance (Linux/UNIX | Linux/UNIX (Amazon
* VPC) | Windows | Windows (Amazon
* VPC)).
-
reserved-instances-id - The
* ID of the Reserved Instance.
-
start - The
* time at which the Reserved Instance purchase request was placed.
* -
state - The state of the Reserved Instance
* (pending-payment | active |
* payment-failed | retired).
-
*
tag:key=value - The key/value
* combination of a tag assigned to the resource.
-
*
tag-key - The key of a tag assigned to the resource.
* This filter is independent of the tag-value filter. For
* example, if you use both the filter "tag-key=Purpose" and the filter
* "tag-value=X", you get any resources assigned both the tag key Purpose
* (regardless of what the tag's value is), and the tag value X
* (regardless of what the tag's key is). If you want to list only
* resources where Purpose is X, see the
* tag:key=value filter.
-
*
tag-value - The value of a tag assigned to the
* resource. This filter is independent of the tag-key
* filter.
-
usage-price - The usage price of
* the Reserved Instance, per hour (for example, 0.84).
*/
private com.amazonaws.internal.ListWithAutoConstructFlag filters;
/**
* The Reserved Instance offering type.
*
* Constraints:
* Allowed Values: Heavy Utilization, Medium Utilization, Light Utilization
*/
private String offeringType;
/**
* One or more Reserved Instance IDs.
Default: Describes all your
* Reserved Instances, or only those otherwise specified.
*
* @return One or more Reserved Instance IDs.
Default: Describes all your
* Reserved Instances, or only those otherwise specified.
*/
public java.util.List getReservedInstancesIds() {
if (reservedInstancesIds == null) {
reservedInstancesIds = new com.amazonaws.internal.ListWithAutoConstructFlag();
reservedInstancesIds.setAutoConstruct(true);
}
return reservedInstancesIds;
}
/**
* One or more Reserved Instance IDs. Default: Describes all your
* Reserved Instances, or only those otherwise specified.
*
* @param reservedInstancesIds One or more Reserved Instance IDs.
Default: Describes all your
* Reserved Instances, or only those otherwise specified.
*/
public void setReservedInstancesIds(java.util.Collection reservedInstancesIds) {
if (reservedInstancesIds == null) {
this.reservedInstancesIds = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag reservedInstancesIdsCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(reservedInstancesIds.size());
reservedInstancesIdsCopy.addAll(reservedInstancesIds);
this.reservedInstancesIds = reservedInstancesIdsCopy;
}
/**
* One or more Reserved Instance IDs. Default: Describes all your
* Reserved Instances, or only those otherwise specified.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param reservedInstancesIds One or more Reserved Instance IDs.
Default: Describes all your
* Reserved Instances, or only those otherwise specified.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeReservedInstancesRequest withReservedInstancesIds(String... reservedInstancesIds) {
if (getReservedInstancesIds() == null) setReservedInstancesIds(new java.util.ArrayList(reservedInstancesIds.length));
for (String value : reservedInstancesIds) {
getReservedInstancesIds().add(value);
}
return this;
}
/**
* One or more Reserved Instance IDs. Default: Describes all your
* Reserved Instances, or only those otherwise specified.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param reservedInstancesIds One or more Reserved Instance IDs.
Default: Describes all your
* Reserved Instances, or only those otherwise specified.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeReservedInstancesRequest withReservedInstancesIds(java.util.Collection reservedInstancesIds) {
if (reservedInstancesIds == null) {
this.reservedInstancesIds = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag reservedInstancesIdsCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(reservedInstancesIds.size());
reservedInstancesIdsCopy.addAll(reservedInstancesIds);
this.reservedInstancesIds = reservedInstancesIdsCopy;
}
return this;
}
/**
* One or more filters. -
availability-zone - The
* Availability Zone where the Reserved Instance can be used.
-
*
duration - The duration of the Reserved Instance (one
* year or three years), in seconds (31536000 |
* 94608000).
-
end - The time when
* the Reserved Instance expires.
-
fixed-price
* - The purchase price of the Reserved Instance (for example, 9800.0).
*
-
instance-type - The instance type on which
* the Reserved Instance can be used.
-
*
product-description - The product description of the
* Reserved Instance (Linux/UNIX | Linux/UNIX (Amazon
* VPC) | Windows | Windows (Amazon
* VPC)).
-
reserved-instances-id - The
* ID of the Reserved Instance.
-
start - The
* time at which the Reserved Instance purchase request was placed.
* -
state - The state of the Reserved Instance
* (pending-payment | active |
* payment-failed | retired).
-
*
tag:key=value - The key/value
* combination of a tag assigned to the resource.
-
*
tag-key - The key of a tag assigned to the resource.
* This filter is independent of the tag-value filter. For
* example, if you use both the filter "tag-key=Purpose" and the filter
* "tag-value=X", you get any resources assigned both the tag key Purpose
* (regardless of what the tag's value is), and the tag value X
* (regardless of what the tag's key is). If you want to list only
* resources where Purpose is X, see the
* tag:key=value filter.
-
*
tag-value - The value of a tag assigned to the
* resource. This filter is independent of the tag-key
* filter.
-
usage-price - The usage price of
* the Reserved Instance, per hour (for example, 0.84).
*
* @return One or more filters. -
availability-zone - The
* Availability Zone where the Reserved Instance can be used.
-
*
duration - The duration of the Reserved Instance (one
* year or three years), in seconds (31536000 |
* 94608000).
-
end - The time when
* the Reserved Instance expires.
-
fixed-price
* - The purchase price of the Reserved Instance (for example, 9800.0).
*
-
instance-type - The instance type on which
* the Reserved Instance can be used.
-
*
product-description - The product description of the
* Reserved Instance (Linux/UNIX | Linux/UNIX (Amazon
* VPC) | Windows | Windows (Amazon
* VPC)).
-
reserved-instances-id - The
* ID of the Reserved Instance.
-
start - The
* time at which the Reserved Instance purchase request was placed.
* -
state - The state of the Reserved Instance
* (pending-payment | active |
* payment-failed | retired).
-
*
tag:key=value - The key/value
* combination of a tag assigned to the resource.
-
*
tag-key - The key of a tag assigned to the resource.
* This filter is independent of the tag-value filter. For
* example, if you use both the filter "tag-key=Purpose" and the filter
* "tag-value=X", you get any resources assigned both the tag key Purpose
* (regardless of what the tag's value is), and the tag value X
* (regardless of what the tag's key is). If you want to list only
* resources where Purpose is X, see the
* tag:key=value filter.
-
*
tag-value - The value of a tag assigned to the
* resource. This filter is independent of the tag-key
* filter.
-
usage-price - The usage price of
* the Reserved Instance, per hour (for example, 0.84).
*/
public java.util.List getFilters() {
if (filters == null) {
filters = new com.amazonaws.internal.ListWithAutoConstructFlag();
filters.setAutoConstruct(true);
}
return filters;
}
/**
* One or more filters. -
availability-zone - The
* Availability Zone where the Reserved Instance can be used.
-
*
duration - The duration of the Reserved Instance (one
* year or three years), in seconds (31536000 |
* 94608000).
-
end - The time when
* the Reserved Instance expires.
-
fixed-price
* - The purchase price of the Reserved Instance (for example, 9800.0).
*
-
instance-type - The instance type on which
* the Reserved Instance can be used.
-
*
product-description - The product description of the
* Reserved Instance (Linux/UNIX | Linux/UNIX (Amazon
* VPC) | Windows | Windows (Amazon
* VPC)).
-
reserved-instances-id - The
* ID of the Reserved Instance.
-
start - The
* time at which the Reserved Instance purchase request was placed.
* -
state - The state of the Reserved Instance
* (pending-payment | active |
* payment-failed | retired).
-
*
tag:key=value - The key/value
* combination of a tag assigned to the resource.
-
*
tag-key - The key of a tag assigned to the resource.
* This filter is independent of the tag-value filter. For
* example, if you use both the filter "tag-key=Purpose" and the filter
* "tag-value=X", you get any resources assigned both the tag key Purpose
* (regardless of what the tag's value is), and the tag value X
* (regardless of what the tag's key is). If you want to list only
* resources where Purpose is X, see the
* tag:key=value filter.
-
*
tag-value - The value of a tag assigned to the
* resource. This filter is independent of the tag-key
* filter.
-
usage-price - The usage price of
* the Reserved Instance, per hour (for example, 0.84).
*
* @param filters One or more filters. -
availability-zone - The
* Availability Zone where the Reserved Instance can be used.
-
*
duration - The duration of the Reserved Instance (one
* year or three years), in seconds (31536000 |
* 94608000).
-
end - The time when
* the Reserved Instance expires.
-
fixed-price
* - The purchase price of the Reserved Instance (for example, 9800.0).
*
-
instance-type - The instance type on which
* the Reserved Instance can be used.
-
*
product-description - The product description of the
* Reserved Instance (Linux/UNIX | Linux/UNIX (Amazon
* VPC) | Windows | Windows (Amazon
* VPC)).
-
reserved-instances-id - The
* ID of the Reserved Instance.
-
start - The
* time at which the Reserved Instance purchase request was placed.
* -
state - The state of the Reserved Instance
* (pending-payment | active |
* payment-failed | retired).
-
*
tag:key=value - The key/value
* combination of a tag assigned to the resource.
-
*
tag-key - The key of a tag assigned to the resource.
* This filter is independent of the tag-value filter. For
* example, if you use both the filter "tag-key=Purpose" and the filter
* "tag-value=X", you get any resources assigned both the tag key Purpose
* (regardless of what the tag's value is), and the tag value X
* (regardless of what the tag's key is). If you want to list only
* resources where Purpose is X, see the
* tag:key=value filter.
-
*
tag-value - The value of a tag assigned to the
* resource. This filter is independent of the tag-key
* filter.
-
usage-price - The usage price of
* the Reserved Instance, per hour (for example, 0.84).
*/
public void setFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag filtersCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(filters.size());
filtersCopy.addAll(filters);
this.filters = filtersCopy;
}
/**
* One or more filters. -
availability-zone - The
* Availability Zone where the Reserved Instance can be used.
-
*
duration - The duration of the Reserved Instance (one
* year or three years), in seconds (31536000 |
* 94608000).
-
end - The time when
* the Reserved Instance expires.
-
fixed-price
* - The purchase price of the Reserved Instance (for example, 9800.0).
*
-
instance-type - The instance type on which
* the Reserved Instance can be used.
-
*
product-description - The product description of the
* Reserved Instance (Linux/UNIX | Linux/UNIX (Amazon
* VPC) | Windows | Windows (Amazon
* VPC)).
-
reserved-instances-id - The
* ID of the Reserved Instance.
-
start - The
* time at which the Reserved Instance purchase request was placed.
* -
state - The state of the Reserved Instance
* (pending-payment | active |
* payment-failed | retired).
-
*
tag:key=value - The key/value
* combination of a tag assigned to the resource.
-
*
tag-key - The key of a tag assigned to the resource.
* This filter is independent of the tag-value filter. For
* example, if you use both the filter "tag-key=Purpose" and the filter
* "tag-value=X", you get any resources assigned both the tag key Purpose
* (regardless of what the tag's value is), and the tag value X
* (regardless of what the tag's key is). If you want to list only
* resources where Purpose is X, see the
* tag:key=value filter.
-
*
tag-value - The value of a tag assigned to the
* resource. This filter is independent of the tag-key
* filter.
-
usage-price - The usage price of
* the Reserved Instance, per hour (for example, 0.84).
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param filters One or more filters.
-
availability-zone - The
* Availability Zone where the Reserved Instance can be used.
-
*
duration - The duration of the Reserved Instance (one
* year or three years), in seconds (31536000 |
* 94608000).
-
end - The time when
* the Reserved Instance expires.
-
fixed-price
* - The purchase price of the Reserved Instance (for example, 9800.0).
*
-
instance-type - The instance type on which
* the Reserved Instance can be used.
-
*
product-description - The product description of the
* Reserved Instance (Linux/UNIX | Linux/UNIX (Amazon
* VPC) | Windows | Windows (Amazon
* VPC)).
-
reserved-instances-id - The
* ID of the Reserved Instance.
-
start - The
* time at which the Reserved Instance purchase request was placed.
* -
state - The state of the Reserved Instance
* (pending-payment | active |
* payment-failed | retired).
-
*
tag:key=value - The key/value
* combination of a tag assigned to the resource.
-
*
tag-key - The key of a tag assigned to the resource.
* This filter is independent of the tag-value filter. For
* example, if you use both the filter "tag-key=Purpose" and the filter
* "tag-value=X", you get any resources assigned both the tag key Purpose
* (regardless of what the tag's value is), and the tag value X
* (regardless of what the tag's key is). If you want to list only
* resources where Purpose is X, see the
* tag:key=value filter.
-
*
tag-value - The value of a tag assigned to the
* resource. This filter is independent of the tag-key
* filter.
-
usage-price - The usage price of
* the Reserved Instance, per hour (for example, 0.84).
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeReservedInstancesRequest withFilters(Filter... filters) {
if (getFilters() == null) setFilters(new java.util.ArrayList(filters.length));
for (Filter value : filters) {
getFilters().add(value);
}
return this;
}
/**
* One or more filters. -
availability-zone - The
* Availability Zone where the Reserved Instance can be used.
-
*
duration - The duration of the Reserved Instance (one
* year or three years), in seconds (31536000 |
* 94608000).
-
end - The time when
* the Reserved Instance expires.
-
fixed-price
* - The purchase price of the Reserved Instance (for example, 9800.0).
*
-
instance-type - The instance type on which
* the Reserved Instance can be used.
-
*
product-description - The product description of the
* Reserved Instance (Linux/UNIX | Linux/UNIX (Amazon
* VPC) | Windows | Windows (Amazon
* VPC)).
-
reserved-instances-id - The
* ID of the Reserved Instance.
-
start - The
* time at which the Reserved Instance purchase request was placed.
* -
state - The state of the Reserved Instance
* (pending-payment | active |
* payment-failed | retired).
-
*
tag:key=value - The key/value
* combination of a tag assigned to the resource.
-
*
tag-key - The key of a tag assigned to the resource.
* This filter is independent of the tag-value filter. For
* example, if you use both the filter "tag-key=Purpose" and the filter
* "tag-value=X", you get any resources assigned both the tag key Purpose
* (regardless of what the tag's value is), and the tag value X
* (regardless of what the tag's key is). If you want to list only
* resources where Purpose is X, see the
* tag:key=value filter.
-
*
tag-value - The value of a tag assigned to the
* resource. This filter is independent of the tag-key
* filter.
-
usage-price - The usage price of
* the Reserved Instance, per hour (for example, 0.84).
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param filters One or more filters.
-
availability-zone - The
* Availability Zone where the Reserved Instance can be used.
-
*
duration - The duration of the Reserved Instance (one
* year or three years), in seconds (31536000 |
* 94608000).
-
end - The time when
* the Reserved Instance expires.
-
fixed-price
* - The purchase price of the Reserved Instance (for example, 9800.0).
*
-
instance-type - The instance type on which
* the Reserved Instance can be used.
-
*
product-description - The product description of the
* Reserved Instance (Linux/UNIX | Linux/UNIX (Amazon
* VPC) | Windows | Windows (Amazon
* VPC)).
-
reserved-instances-id - The
* ID of the Reserved Instance.
-
start - The
* time at which the Reserved Instance purchase request was placed.
* -
state - The state of the Reserved Instance
* (pending-payment | active |
* payment-failed | retired).
-
*
tag:key=value - The key/value
* combination of a tag assigned to the resource.
-
*
tag-key - The key of a tag assigned to the resource.
* This filter is independent of the tag-value filter. For
* example, if you use both the filter "tag-key=Purpose" and the filter
* "tag-value=X", you get any resources assigned both the tag key Purpose
* (regardless of what the tag's value is), and the tag value X
* (regardless of what the tag's key is). If you want to list only
* resources where Purpose is X, see the
* tag:key=value filter.
-
*
tag-value - The value of a tag assigned to the
* resource. This filter is independent of the tag-key
* filter.
-
usage-price - The usage price of
* the Reserved Instance, per hour (for example, 0.84).
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeReservedInstancesRequest withFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag filtersCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(filters.size());
filtersCopy.addAll(filters);
this.filters = filtersCopy;
}
return this;
}
/**
* The Reserved Instance offering type.
*
* Constraints:
* Allowed Values: Heavy Utilization, Medium Utilization, Light Utilization
*
* @return The Reserved Instance offering type.
*
* @see OfferingTypeValues
*/
public String getOfferingType() {
return offeringType;
}
/**
* The Reserved Instance offering type.
*
* Constraints:
* Allowed Values: Heavy Utilization, Medium Utilization, Light Utilization
*
* @param offeringType The Reserved Instance offering type.
*
* @see OfferingTypeValues
*/
public void setOfferingType(String offeringType) {
this.offeringType = offeringType;
}
/**
* The Reserved Instance offering type.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Allowed Values: Heavy Utilization, Medium Utilization, Light Utilization
*
* @param offeringType The Reserved Instance offering type.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*
* @see OfferingTypeValues
*/
public DescribeReservedInstancesRequest withOfferingType(String offeringType) {
this.offeringType = offeringType;
return this;
}
/**
* The Reserved Instance offering type.
*
* Constraints:
* Allowed Values: Heavy Utilization, Medium Utilization, Light Utilization
*
* @param offeringType The Reserved Instance offering type.
*
* @see OfferingTypeValues
*/
public void setOfferingType(OfferingTypeValues offeringType) {
this.offeringType = offeringType.toString();
}
/**
* The Reserved Instance offering type.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Allowed Values: Heavy Utilization, Medium Utilization, Light Utilization
*
* @param offeringType The Reserved Instance offering type.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*
* @see OfferingTypeValues
*/
public DescribeReservedInstancesRequest withOfferingType(OfferingTypeValues offeringType) {
this.offeringType = offeringType.toString();
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 getDryRunRequest() {
Request request = new DescribeReservedInstancesRequestMarshaller().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 (getReservedInstancesIds() != null) sb.append("ReservedInstancesIds: " + getReservedInstancesIds() + ",");
if (getFilters() != null) sb.append("Filters: " + getFilters() + ",");
if (getOfferingType() != null) sb.append("OfferingType: " + getOfferingType() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getReservedInstancesIds() == null) ? 0 : getReservedInstancesIds().hashCode());
hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode());
hashCode = prime * hashCode + ((getOfferingType() == null) ? 0 : getOfferingType().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof DescribeReservedInstancesRequest == false) return false;
DescribeReservedInstancesRequest other = (DescribeReservedInstancesRequest)obj;
if (other.getReservedInstancesIds() == null ^ this.getReservedInstancesIds() == null) return false;
if (other.getReservedInstancesIds() != null && other.getReservedInstancesIds().equals(this.getReservedInstancesIds()) == false) return false;
if (other.getFilters() == null ^ this.getFilters() == null) return false;
if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == false) return false;
if (other.getOfferingType() == null ^ this.getOfferingType() == null) return false;
if (other.getOfferingType() != null && other.getOfferingType().equals(this.getOfferingType()) == false) return false;
return true;
}
}