com.amazonaws.services.ec2.model.DescribeReservedInstancesRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2012-2017 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 javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.Request;
import com.amazonaws.services.ec2.model.transform.DescribeReservedInstancesRequestMarshaller;
/**
*
* Contains the parameters for DescribeReservedInstances.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeReservedInstancesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable,
DryRunSupportedRequest {
/**
*
* One or more Reserved Instance IDs.
*
*
* Default: Describes all your Reserved Instances, or only those otherwise specified.
*
*/
private com.amazonaws.internal.SdkInternalList 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 (for example, 2015-08-07T11:54:42.000Z).
*
*
* -
*
* fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
*
*
* -
*
* instance-type - The instance type that is covered by the reservation.
*
*
* -
*
* scope - The scope of the Reserved Instance (Region or Availability Zone).
*
*
* -
*
* product-description - The Reserved Instance product platform description. Instances that include
* (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account
* holders and are for use with Amazon VPC (Linux/UNIX | Linux/UNIX (Amazon VPC) |
* SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux |
* Red Hat Enterprise Linux (Amazon VPC) | Windows | Windows (Amazon VPC) |
* Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) |
* Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) |
* Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC)).
*
*
* -
*
* reserved-instances-id - The ID of the Reserved Instance.
*
*
* -
*
* start - The time at which the Reserved Instance purchase request was placed (for example,
* 2014-08-07T11:54:42.000Z).
*
*
* -
*
* state - The state of the Reserved Instance (payment-pending | active |
* payment-failed | retired).
*
*
* -
*
* tag:key=value - The key/value combination of a tag assigned to the resource. Specify
* the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag
* Purpose=X, specify tag:Purpose for the filter name and X for the filter value.
*
*
* -
*
* 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.SdkInternalList filters;
/**
*
* The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only
* have access to the Medium Utilization Reserved Instance offering type.
*
*/
private String offeringType;
/**
*
* Describes whether the Reserved Instance is Standard or Convertible.
*
*/
private String offeringClass;
/**
*
* 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.SdkInternalList();
}
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;
}
this.reservedInstancesIds = new com.amazonaws.internal.SdkInternalList(reservedInstancesIds);
}
/**
*
* One or more Reserved Instance IDs.
*
*
* Default: Describes all your Reserved Instances, or only those otherwise specified.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setReservedInstancesIds(java.util.Collection)} or {@link #withReservedInstancesIds(java.util.Collection)}
* if you want to override the existing values.
*
*
* @param reservedInstancesIds
* One or more Reserved Instance IDs.
*
* Default: Describes all your Reserved Instances, or only those otherwise specified.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeReservedInstancesRequest withReservedInstancesIds(String... reservedInstancesIds) {
if (this.reservedInstancesIds == null) {
setReservedInstancesIds(new com.amazonaws.internal.SdkInternalList(reservedInstancesIds.length));
}
for (String ele : reservedInstancesIds) {
this.reservedInstancesIds.add(ele);
}
return this;
}
/**
*
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeReservedInstancesRequest withReservedInstancesIds(java.util.Collection reservedInstancesIds) {
setReservedInstancesIds(reservedInstancesIds);
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 (for example, 2015-08-07T11:54:42.000Z).
*
*
* -
*
* fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
*
*
* -
*
* instance-type - The instance type that is covered by the reservation.
*
*
* -
*
* scope - The scope of the Reserved Instance (Region or Availability Zone).
*
*
* -
*
* product-description - The Reserved Instance product platform description. Instances that include
* (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account
* holders and are for use with Amazon VPC (Linux/UNIX | Linux/UNIX (Amazon VPC) |
* SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux |
* Red Hat Enterprise Linux (Amazon VPC) | Windows | Windows (Amazon VPC) |
* Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) |
* Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) |
* Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC)).
*
*
* -
*
* reserved-instances-id - The ID of the Reserved Instance.
*
*
* -
*
* start - The time at which the Reserved Instance purchase request was placed (for example,
* 2014-08-07T11:54:42.000Z).
*
*
* -
*
* state - The state of the Reserved Instance (payment-pending | active |
* payment-failed | retired).
*
*
* -
*
* tag:key=value - The key/value combination of a tag assigned to the resource. Specify
* the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag
* Purpose=X, specify tag:Purpose for the filter name and X for the filter value.
*
*
* -
*
* 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 (for example, 2015-08-07T11:54:42.000Z).
*
*
* -
*
* fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
*
*
* -
*
* instance-type - The instance type that is covered by the reservation.
*
*
* -
*
* scope - The scope of the Reserved Instance (Region or
* Availability Zone).
*
*
* -
*
* product-description - The Reserved Instance product platform description. Instances that
* include (Amazon VPC) in the product platform description will only be displayed to
* EC2-Classic account holders and are for use with Amazon VPC (Linux/UNIX |
* Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) |
* Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) |
* Windows | Windows (Amazon VPC) | Windows with SQL Server Standard
* | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web |
* Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise |
* Windows with SQL Server Enterprise (Amazon VPC)).
*
*
* -
*
* reserved-instances-id - The ID of the Reserved Instance.
*
*
* -
*
* start - The time at which the Reserved Instance purchase request was placed (for example,
* 2014-08-07T11:54:42.000Z).
*
*
* -
*
* state - The state of the Reserved Instance (payment-pending |
* active | payment-failed | retired).
*
*
* -
*
* tag:key=value - The key/value combination of a tag assigned to the resource.
* Specify the key of the tag in the filter name and the value of the tag in the filter value. For example,
* for the tag Purpose=X, specify tag:Purpose for the filter name and X for the
* filter value.
*
*
* -
*
* 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.SdkInternalList();
}
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 (for example, 2015-08-07T11:54:42.000Z).
*
*
* -
*
* fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
*
*
* -
*
* instance-type - The instance type that is covered by the reservation.
*
*
* -
*
* scope - The scope of the Reserved Instance (Region or Availability Zone).
*
*
* -
*
* product-description - The Reserved Instance product platform description. Instances that include
* (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account
* holders and are for use with Amazon VPC (Linux/UNIX | Linux/UNIX (Amazon VPC) |
* SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux |
* Red Hat Enterprise Linux (Amazon VPC) | Windows | Windows (Amazon VPC) |
* Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) |
* Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) |
* Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC)).
*
*
* -
*
* reserved-instances-id - The ID of the Reserved Instance.
*
*
* -
*
* start - The time at which the Reserved Instance purchase request was placed (for example,
* 2014-08-07T11:54:42.000Z).
*
*
* -
*
* state - The state of the Reserved Instance (payment-pending | active |
* payment-failed | retired).
*
*
* -
*
* tag:key=value - The key/value combination of a tag assigned to the resource. Specify
* the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag
* Purpose=X, specify tag:Purpose for the filter name and X for the filter value.
*
*
* -
*
* 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 (for example, 2015-08-07T11:54:42.000Z).
*
*
* -
*
* fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
*
*
* -
*
* instance-type - The instance type that is covered by the reservation.
*
*
* -
*
* scope - The scope of the Reserved Instance (Region or
* Availability Zone).
*
*
* -
*
* product-description - The Reserved Instance product platform description. Instances that
* include (Amazon VPC) in the product platform description will only be displayed to
* EC2-Classic account holders and are for use with Amazon VPC (Linux/UNIX |
* Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) |
* Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) |
* Windows | Windows (Amazon VPC) | Windows with SQL Server Standard |
* Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web |
* Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise |
* Windows with SQL Server Enterprise (Amazon VPC)).
*
*
* -
*
* reserved-instances-id - The ID of the Reserved Instance.
*
*
* -
*
* start - The time at which the Reserved Instance purchase request was placed (for example,
* 2014-08-07T11:54:42.000Z).
*
*
* -
*
* state - The state of the Reserved Instance (payment-pending |
* active | payment-failed | retired).
*
*
* -
*
* tag:key=value - The key/value combination of a tag assigned to the resource.
* Specify the key of the tag in the filter name and the value of the tag in the filter value. For example,
* for the tag Purpose=X, specify tag:Purpose for the filter name and X for the
* filter value.
*
*
* -
*
* 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;
}
this.filters = new com.amazonaws.internal.SdkInternalList(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 (for example, 2015-08-07T11:54:42.000Z).
*
*
* -
*
* fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
*
*
* -
*
* instance-type - The instance type that is covered by the reservation.
*
*
* -
*
* scope - The scope of the Reserved Instance (Region or Availability Zone).
*
*
* -
*
* product-description - The Reserved Instance product platform description. Instances that include
* (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account
* holders and are for use with Amazon VPC (Linux/UNIX | Linux/UNIX (Amazon VPC) |
* SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux |
* Red Hat Enterprise Linux (Amazon VPC) | Windows | Windows (Amazon VPC) |
* Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) |
* Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) |
* Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC)).
*
*
* -
*
* reserved-instances-id - The ID of the Reserved Instance.
*
*
* -
*
* start - The time at which the Reserved Instance purchase request was placed (for example,
* 2014-08-07T11:54:42.000Z).
*
*
* -
*
* state - The state of the Reserved Instance (payment-pending | active |
* payment-failed | retired).
*
*
* -
*
* tag:key=value - The key/value combination of a tag assigned to the resource. Specify
* the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag
* Purpose=X, specify tag:Purpose for the filter name and X for the filter value.
*
*
* -
*
* 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).
*
*
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setFilters(java.util.Collection)} or {@link #withFilters(java.util.Collection)} if you want to override
* the existing values.
*
*
* @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 (for example, 2015-08-07T11:54:42.000Z).
*
*
* -
*
* fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
*
*
* -
*
* instance-type - The instance type that is covered by the reservation.
*
*
* -
*
* scope - The scope of the Reserved Instance (Region or
* Availability Zone).
*
*
* -
*
* product-description - The Reserved Instance product platform description. Instances that
* include (Amazon VPC) in the product platform description will only be displayed to
* EC2-Classic account holders and are for use with Amazon VPC (Linux/UNIX |
* Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) |
* Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) |
* Windows | Windows (Amazon VPC) | Windows with SQL Server Standard |
* Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web |
* Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise |
* Windows with SQL Server Enterprise (Amazon VPC)).
*
*
* -
*
* reserved-instances-id - The ID of the Reserved Instance.
*
*
* -
*
* start - The time at which the Reserved Instance purchase request was placed (for example,
* 2014-08-07T11:54:42.000Z).
*
*
* -
*
* state - The state of the Reserved Instance (payment-pending |
* active | payment-failed | retired).
*
*
* -
*
* tag:key=value - The key/value combination of a tag assigned to the resource.
* Specify the key of the tag in the filter name and the value of the tag in the filter value. For example,
* for the tag Purpose=X, specify tag:Purpose for the filter name and X for the
* filter value.
*
*
* -
*
* 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 Returns a reference to this object so that method calls can be chained together.
*/
public DescribeReservedInstancesRequest withFilters(Filter... filters) {
if (this.filters == null) {
setFilters(new com.amazonaws.internal.SdkInternalList(filters.length));
}
for (Filter ele : filters) {
this.filters.add(ele);
}
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 (for example, 2015-08-07T11:54:42.000Z).
*
*
* -
*
* fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
*
*
* -
*
* instance-type - The instance type that is covered by the reservation.
*
*
* -
*
* scope - The scope of the Reserved Instance (Region or Availability Zone).
*
*
* -
*
* product-description - The Reserved Instance product platform description. Instances that include
* (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account
* holders and are for use with Amazon VPC (Linux/UNIX | Linux/UNIX (Amazon VPC) |
* SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux |
* Red Hat Enterprise Linux (Amazon VPC) | Windows | Windows (Amazon VPC) |
* Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) |
* Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) |
* Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC)).
*
*
* -
*
* reserved-instances-id - The ID of the Reserved Instance.
*
*
* -
*
* start - The time at which the Reserved Instance purchase request was placed (for example,
* 2014-08-07T11:54:42.000Z).
*
*
* -
*
* state - The state of the Reserved Instance (payment-pending | active |
* payment-failed | retired).
*
*
* -
*
* tag:key=value - The key/value combination of a tag assigned to the resource. Specify
* the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag
* Purpose=X, specify tag:Purpose for the filter name and X for the filter value.
*
*
* -
*
* 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 (for example, 2015-08-07T11:54:42.000Z).
*
*
* -
*
* fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
*
*
* -
*
* instance-type - The instance type that is covered by the reservation.
*
*
* -
*
* scope - The scope of the Reserved Instance (Region or
* Availability Zone).
*
*
* -
*
* product-description - The Reserved Instance product platform description. Instances that
* include (Amazon VPC) in the product platform description will only be displayed to
* EC2-Classic account holders and are for use with Amazon VPC (Linux/UNIX |
* Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) |
* Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) |
* Windows | Windows (Amazon VPC) | Windows with SQL Server Standard |
* Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web |
* Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise |
* Windows with SQL Server Enterprise (Amazon VPC)).
*
*
* -
*
* reserved-instances-id - The ID of the Reserved Instance.
*
*
* -
*
* start - The time at which the Reserved Instance purchase request was placed (for example,
* 2014-08-07T11:54:42.000Z).
*
*
* -
*
* state - The state of the Reserved Instance (payment-pending |
* active | payment-failed | retired).
*
*
* -
*
* tag:key=value - The key/value combination of a tag assigned to the resource.
* Specify the key of the tag in the filter name and the value of the tag in the filter value. For example,
* for the tag Purpose=X, specify tag:Purpose for the filter name and X for the
* filter value.
*
*
* -
*
* 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 Returns a reference to this object so that method calls can be chained together.
*/
public DescribeReservedInstancesRequest withFilters(java.util.Collection filters) {
setFilters(filters);
return this;
}
/**
*
* The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only
* have access to the Medium Utilization Reserved Instance offering type.
*
*
* @param offeringType
* The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you
* only have access to the Medium Utilization Reserved Instance offering type.
* @see OfferingTypeValues
*/
public void setOfferingType(String offeringType) {
this.offeringType = offeringType;
}
/**
*
* The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only
* have access to the Medium Utilization Reserved Instance offering type.
*
*
* @return The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you
* only have access to the Medium Utilization Reserved Instance offering type.
* @see OfferingTypeValues
*/
public String getOfferingType() {
return this.offeringType;
}
/**
*
* The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only
* have access to the Medium Utilization Reserved Instance offering type.
*
*
* @param offeringType
* The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you
* only have access to the Medium Utilization Reserved Instance offering type.
* @return Returns a reference to this object so that method calls can be chained together.
* @see OfferingTypeValues
*/
public DescribeReservedInstancesRequest withOfferingType(String offeringType) {
setOfferingType(offeringType);
return this;
}
/**
*
* The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only
* have access to the Medium Utilization Reserved Instance offering type.
*
*
* @param offeringType
* The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you
* only have access to the Medium Utilization Reserved Instance offering type.
* @see OfferingTypeValues
*/
public void setOfferingType(OfferingTypeValues offeringType) {
this.offeringType = offeringType.toString();
}
/**
*
* The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only
* have access to the Medium Utilization Reserved Instance offering type.
*
*
* @param offeringType
* The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you
* only have access to the Medium Utilization Reserved Instance offering type.
* @return Returns a reference to this object so that method calls can be chained together.
* @see OfferingTypeValues
*/
public DescribeReservedInstancesRequest withOfferingType(OfferingTypeValues offeringType) {
setOfferingType(offeringType);
return this;
}
/**
*
* Describes whether the Reserved Instance is Standard or Convertible.
*
*
* @param offeringClass
* Describes whether the Reserved Instance is Standard or Convertible.
* @see OfferingClassType
*/
public void setOfferingClass(String offeringClass) {
this.offeringClass = offeringClass;
}
/**
*
* Describes whether the Reserved Instance is Standard or Convertible.
*
*
* @return Describes whether the Reserved Instance is Standard or Convertible.
* @see OfferingClassType
*/
public String getOfferingClass() {
return this.offeringClass;
}
/**
*
* Describes whether the Reserved Instance is Standard or Convertible.
*
*
* @param offeringClass
* Describes whether the Reserved Instance is Standard or Convertible.
* @return Returns a reference to this object so that method calls can be chained together.
* @see OfferingClassType
*/
public DescribeReservedInstancesRequest withOfferingClass(String offeringClass) {
setOfferingClass(offeringClass);
return this;
}
/**
*
* Describes whether the Reserved Instance is Standard or Convertible.
*
*
* @param offeringClass
* Describes whether the Reserved Instance is Standard or Convertible.
* @see OfferingClassType
*/
public void setOfferingClass(OfferingClassType offeringClass) {
this.offeringClass = offeringClass.toString();
}
/**
*
* Describes whether the Reserved Instance is Standard or Convertible.
*
*
* @param offeringClass
* Describes whether the Reserved Instance is Standard or Convertible.
* @return Returns a reference to this object so that method calls can be chained together.
* @see OfferingClassType
*/
public DescribeReservedInstancesRequest withOfferingClass(OfferingClassType offeringClass) {
setOfferingClass(offeringClass);
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: ").append(getReservedInstancesIds()).append(",");
if (getFilters() != null)
sb.append("Filters: ").append(getFilters()).append(",");
if (getOfferingType() != null)
sb.append("OfferingType: ").append(getOfferingType()).append(",");
if (getOfferingClass() != null)
sb.append("OfferingClass: ").append(getOfferingClass());
sb.append("}");
return sb.toString();
}
@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;
if (other.getOfferingClass() == null ^ this.getOfferingClass() == null)
return false;
if (other.getOfferingClass() != null && other.getOfferingClass().equals(this.getOfferingClass()) == false)
return false;
return true;
}
@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());
hashCode = prime * hashCode + ((getOfferingClass() == null) ? 0 : getOfferingClass().hashCode());
return hashCode;
}
@Override
public DescribeReservedInstancesRequest clone() {
return (DescribeReservedInstancesRequest) super.clone();
}
}