com.amazonaws.services.ec2.model.DescribeReservedInstancesOfferingsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2011-2016 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.DescribeReservedInstancesOfferingsRequestMarshaller;
/**
*
* Contains the parameters for DescribeReservedInstancesOfferings.
*
*/
public class DescribeReservedInstancesOfferingsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable,
DryRunSupportedRequest {
/**
*
* One or more Reserved Instances offering IDs.
*
*/
private com.amazonaws.internal.SdkInternalList reservedInstancesOfferingIds;
/**
*
* The instance type that the reservation will cover (for example, m1.small). For more information, see
* Instance Types in the
* Amazon Elastic Compute Cloud User Guide.
*
*/
private String instanceType;
/**
*
* The Availability Zone in which the Reserved Instance can be used.
*
*/
private String availabilityZone;
/**
*
* The Reserved Instance product platform description. Instances that include (Amazon VPC) in the
* description are for use with Amazon VPC.
*
*/
private String productDescription;
/**
*
* One or more filters.
*
*
* -
*
* availability-zone - The Availability Zone where the Reserved Instance can be used.
*
*
* -
*
* duration - The duration of the Reserved Instance (for example, one year or three years), in seconds
* (31536000 | 94608000).
*
*
* -
*
* fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
*
*
* -
*
* instance-type - The instance type that is covered by the reservation.
*
*
* -
*
* marketplace - Set to true to show only Reserved Instance Marketplace offerings. When
* this filter is not used, which is the default behavior, all offerings from both AWS and the Reserved Instance
* Marketplace are listed.
*
*
* -
*
* 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-offering-id - The Reserved Instances offering ID.
*
*
* -
*
* scope - The scope of the Reserved Instance (Availability Zone or Region).
*
*
* -
*
* usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).
*
*
*
*/
private com.amazonaws.internal.SdkInternalList filters;
/**
*
* The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of
* dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated
* Instances).
*
*
* Default: default
*
*/
private String instanceTenancy;
/**
*
* 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;
/**
*
* The token to retrieve the next page of results.
*
*/
private String nextToken;
/**
*
* The maximum number of results to return for the request in a single page. The remaining results of the initial
* request can be seen by sending another request with the returned NextToken value. The maximum is
* 100.
*
*
* Default: 100
*
*/
private Integer maxResults;
/**
*
* Include Reserved Instance Marketplace offerings in the response.
*
*/
private Boolean includeMarketplace;
/**
*
* The minimum duration (in seconds) to filter when searching for offerings.
*
*
* Default: 2592000 (1 month)
*
*/
private Long minDuration;
/**
*
* The maximum duration (in seconds) to filter when searching for offerings.
*
*
* Default: 94608000 (3 years)
*
*/
private Long maxDuration;
/**
*
* The maximum number of instances to filter when searching for offerings.
*
*
* Default: 20
*
*/
private Integer maxInstanceCount;
/**
*
* The offering class of the Reserved Instance. Can be standard or convertible.
*
*/
private String offeringClass;
/**
*
* One or more Reserved Instances offering IDs.
*
*
* @return One or more Reserved Instances offering IDs.
*/
public java.util.List getReservedInstancesOfferingIds() {
if (reservedInstancesOfferingIds == null) {
reservedInstancesOfferingIds = new com.amazonaws.internal.SdkInternalList();
}
return reservedInstancesOfferingIds;
}
/**
*
* One or more Reserved Instances offering IDs.
*
*
* @param reservedInstancesOfferingIds
* One or more Reserved Instances offering IDs.
*/
public void setReservedInstancesOfferingIds(java.util.Collection reservedInstancesOfferingIds) {
if (reservedInstancesOfferingIds == null) {
this.reservedInstancesOfferingIds = null;
return;
}
this.reservedInstancesOfferingIds = new com.amazonaws.internal.SdkInternalList(reservedInstancesOfferingIds);
}
/**
*
* One or more Reserved Instances offering IDs.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setReservedInstancesOfferingIds(java.util.Collection)} or
* {@link #withReservedInstancesOfferingIds(java.util.Collection)} if you want to override the existing values.
*
*
* @param reservedInstancesOfferingIds
* One or more Reserved Instances offering IDs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeReservedInstancesOfferingsRequest withReservedInstancesOfferingIds(String... reservedInstancesOfferingIds) {
if (this.reservedInstancesOfferingIds == null) {
setReservedInstancesOfferingIds(new com.amazonaws.internal.SdkInternalList(reservedInstancesOfferingIds.length));
}
for (String ele : reservedInstancesOfferingIds) {
this.reservedInstancesOfferingIds.add(ele);
}
return this;
}
/**
*
* One or more Reserved Instances offering IDs.
*
*
* @param reservedInstancesOfferingIds
* One or more Reserved Instances offering IDs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeReservedInstancesOfferingsRequest withReservedInstancesOfferingIds(java.util.Collection reservedInstancesOfferingIds) {
setReservedInstancesOfferingIds(reservedInstancesOfferingIds);
return this;
}
/**
*
* The instance type that the reservation will cover (for example, m1.small). For more information, see
* Instance Types in the
* Amazon Elastic Compute Cloud User Guide.
*
*
* @param instanceType
* The instance type that the reservation will cover (for example, m1.small). For more
* information, see Instance
* Types in the Amazon Elastic Compute Cloud User Guide.
* @see InstanceType
*/
public void setInstanceType(String instanceType) {
this.instanceType = instanceType;
}
/**
*
* The instance type that the reservation will cover (for example, m1.small). For more information, see
* Instance Types in the
* Amazon Elastic Compute Cloud User Guide.
*
*
* @return The instance type that the reservation will cover (for example, m1.small). For more
* information, see Instance Types in the
* Amazon Elastic Compute Cloud User Guide.
* @see InstanceType
*/
public String getInstanceType() {
return this.instanceType;
}
/**
*
* The instance type that the reservation will cover (for example, m1.small). For more information, see
* Instance Types in the
* Amazon Elastic Compute Cloud User Guide.
*
*
* @param instanceType
* The instance type that the reservation will cover (for example, m1.small). For more
* information, see Instance
* Types in the Amazon Elastic Compute Cloud User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
* @see InstanceType
*/
public DescribeReservedInstancesOfferingsRequest withInstanceType(String instanceType) {
setInstanceType(instanceType);
return this;
}
/**
*
* The instance type that the reservation will cover (for example, m1.small). For more information, see
* Instance Types in the
* Amazon Elastic Compute Cloud User Guide.
*
*
* @param instanceType
* The instance type that the reservation will cover (for example, m1.small). For more
* information, see Instance
* Types in the Amazon Elastic Compute Cloud User Guide.
* @see InstanceType
*/
public void setInstanceType(InstanceType instanceType) {
this.instanceType = instanceType.toString();
}
/**
*
* The instance type that the reservation will cover (for example, m1.small). For more information, see
* Instance Types in the
* Amazon Elastic Compute Cloud User Guide.
*
*
* @param instanceType
* The instance type that the reservation will cover (for example, m1.small). For more
* information, see Instance
* Types in the Amazon Elastic Compute Cloud User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
* @see InstanceType
*/
public DescribeReservedInstancesOfferingsRequest withInstanceType(InstanceType instanceType) {
setInstanceType(instanceType);
return this;
}
/**
*
* The Availability Zone in which the Reserved Instance can be used.
*
*
* @param availabilityZone
* The Availability Zone in which the Reserved Instance can be used.
*/
public void setAvailabilityZone(String availabilityZone) {
this.availabilityZone = availabilityZone;
}
/**
*
* The Availability Zone in which the Reserved Instance can be used.
*
*
* @return The Availability Zone in which the Reserved Instance can be used.
*/
public String getAvailabilityZone() {
return this.availabilityZone;
}
/**
*
* The Availability Zone in which the Reserved Instance can be used.
*
*
* @param availabilityZone
* The Availability Zone in which the Reserved Instance can be used.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeReservedInstancesOfferingsRequest withAvailabilityZone(String availabilityZone) {
setAvailabilityZone(availabilityZone);
return this;
}
/**
*
* The Reserved Instance product platform description. Instances that include (Amazon VPC) in the
* description are for use with Amazon VPC.
*
*
* @param productDescription
* The Reserved Instance product platform description. Instances that include (Amazon VPC) in
* the description are for use with Amazon VPC.
* @see RIProductDescription
*/
public void setProductDescription(String productDescription) {
this.productDescription = productDescription;
}
/**
*
* The Reserved Instance product platform description. Instances that include (Amazon VPC) in the
* description are for use with Amazon VPC.
*
*
* @return The Reserved Instance product platform description. Instances that include (Amazon VPC) in
* the description are for use with Amazon VPC.
* @see RIProductDescription
*/
public String getProductDescription() {
return this.productDescription;
}
/**
*
* The Reserved Instance product platform description. Instances that include (Amazon VPC) in the
* description are for use with Amazon VPC.
*
*
* @param productDescription
* The Reserved Instance product platform description. Instances that include (Amazon VPC) in
* the description are for use with Amazon VPC.
* @return Returns a reference to this object so that method calls can be chained together.
* @see RIProductDescription
*/
public DescribeReservedInstancesOfferingsRequest withProductDescription(String productDescription) {
setProductDescription(productDescription);
return this;
}
/**
*
* The Reserved Instance product platform description. Instances that include (Amazon VPC) in the
* description are for use with Amazon VPC.
*
*
* @param productDescription
* The Reserved Instance product platform description. Instances that include (Amazon VPC) in
* the description are for use with Amazon VPC.
* @see RIProductDescription
*/
public void setProductDescription(RIProductDescription productDescription) {
this.productDescription = productDescription.toString();
}
/**
*
* The Reserved Instance product platform description. Instances that include (Amazon VPC) in the
* description are for use with Amazon VPC.
*
*
* @param productDescription
* The Reserved Instance product platform description. Instances that include (Amazon VPC) in
* the description are for use with Amazon VPC.
* @return Returns a reference to this object so that method calls can be chained together.
* @see RIProductDescription
*/
public DescribeReservedInstancesOfferingsRequest withProductDescription(RIProductDescription productDescription) {
setProductDescription(productDescription);
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 (for example, one year or three years), in seconds
* (31536000 | 94608000).
*
*
* -
*
* fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
*
*
* -
*
* instance-type - The instance type that is covered by the reservation.
*
*
* -
*
* marketplace - Set to true to show only Reserved Instance Marketplace offerings. When
* this filter is not used, which is the default behavior, all offerings from both AWS and the Reserved Instance
* Marketplace are listed.
*
*
* -
*
* 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-offering-id - The Reserved Instances offering ID.
*
*
* -
*
* scope - The scope of the Reserved Instance (Availability Zone or Region).
*
*
* -
*
* 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 (for example, one year or three years), in
* seconds (31536000 | 94608000).
*
*
* -
*
* fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
*
*
* -
*
* instance-type - The instance type that is covered by the reservation.
*
*
* -
*
* marketplace - Set to true to show only Reserved Instance Marketplace offerings.
* When this filter is not used, which is the default behavior, all offerings from both AWS and the Reserved
* Instance Marketplace are listed.
*
*
* -
*
* 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-offering-id - The Reserved Instances offering ID.
*
*
* -
*
* scope - The scope of the Reserved Instance (Availability Zone or
* Region).
*
*
* -
*
* 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 (for example, one year or three years), in seconds
* (31536000 | 94608000).
*
*
* -
*
* fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
*
*
* -
*
* instance-type - The instance type that is covered by the reservation.
*
*
* -
*
* marketplace - Set to true to show only Reserved Instance Marketplace offerings. When
* this filter is not used, which is the default behavior, all offerings from both AWS and the Reserved Instance
* Marketplace are listed.
*
*
* -
*
* 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-offering-id - The Reserved Instances offering ID.
*
*
* -
*
* scope - The scope of the Reserved Instance (Availability Zone or Region).
*
*
* -
*
* 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 (for example, one year or three years), in
* seconds (31536000 | 94608000).
*
*
* -
*
* fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
*
*
* -
*
* instance-type - The instance type that is covered by the reservation.
*
*
* -
*
* marketplace - Set to true to show only Reserved Instance Marketplace offerings.
* When this filter is not used, which is the default behavior, all offerings from both AWS and the Reserved
* Instance Marketplace are listed.
*
*
* -
*
* 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-offering-id - The Reserved Instances offering ID.
*
*
* -
*
* scope - The scope of the Reserved Instance (Availability Zone or
* Region).
*
*
* -
*
* 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 (for example, one year or three years), in seconds
* (31536000 | 94608000).
*
*
* -
*
* fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
*
*
* -
*
* instance-type - The instance type that is covered by the reservation.
*
*
* -
*
* marketplace - Set to true to show only Reserved Instance Marketplace offerings. When
* this filter is not used, which is the default behavior, all offerings from both AWS and the Reserved Instance
* Marketplace are listed.
*
*
* -
*
* 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-offering-id - The Reserved Instances offering ID.
*
*
* -
*
* scope - The scope of the Reserved Instance (Availability Zone or Region).
*
*
* -
*
* 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 (for example, one year or three years), in
* seconds (31536000 | 94608000).
*
*
* -
*
* fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
*
*
* -
*
* instance-type - The instance type that is covered by the reservation.
*
*
* -
*
* marketplace - Set to true to show only Reserved Instance Marketplace offerings.
* When this filter is not used, which is the default behavior, all offerings from both AWS and the Reserved
* Instance Marketplace are listed.
*
*
* -
*
* 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-offering-id - The Reserved Instances offering ID.
*
*
* -
*
* scope - The scope of the Reserved Instance (Availability Zone or
* Region).
*
*
* -
*
* 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 DescribeReservedInstancesOfferingsRequest 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 (for example, one year or three years), in seconds
* (31536000 | 94608000).
*
*
* -
*
* fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
*
*
* -
*
* instance-type - The instance type that is covered by the reservation.
*
*
* -
*
* marketplace - Set to true to show only Reserved Instance Marketplace offerings. When
* this filter is not used, which is the default behavior, all offerings from both AWS and the Reserved Instance
* Marketplace are listed.
*
*
* -
*
* 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-offering-id - The Reserved Instances offering ID.
*
*
* -
*
* scope - The scope of the Reserved Instance (Availability Zone or Region).
*
*
* -
*
* 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 (for example, one year or three years), in
* seconds (31536000 | 94608000).
*
*
* -
*
* fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
*
*
* -
*
* instance-type - The instance type that is covered by the reservation.
*
*
* -
*
* marketplace - Set to true to show only Reserved Instance Marketplace offerings.
* When this filter is not used, which is the default behavior, all offerings from both AWS and the Reserved
* Instance Marketplace are listed.
*
*
* -
*
* 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-offering-id - The Reserved Instances offering ID.
*
*
* -
*
* scope - The scope of the Reserved Instance (Availability Zone or
* Region).
*
*
* -
*
* 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 DescribeReservedInstancesOfferingsRequest withFilters(java.util.Collection filters) {
setFilters(filters);
return this;
}
/**
*
* The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of
* dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated
* Instances).
*
*
* Default: default
*
*
* @param instanceTenancy
* The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of
* dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e.,
* Dedicated Instances).
*
* Default: default
* @see Tenancy
*/
public void setInstanceTenancy(String instanceTenancy) {
this.instanceTenancy = instanceTenancy;
}
/**
*
* The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of
* dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated
* Instances).
*
*
* Default: default
*
*
* @return The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of
* dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e.,
* Dedicated Instances).
*
* Default: default
* @see Tenancy
*/
public String getInstanceTenancy() {
return this.instanceTenancy;
}
/**
*
* The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of
* dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated
* Instances).
*
*
* Default: default
*
*
* @param instanceTenancy
* The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of
* dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e.,
* Dedicated Instances).
*
* Default: default
* @return Returns a reference to this object so that method calls can be chained together.
* @see Tenancy
*/
public DescribeReservedInstancesOfferingsRequest withInstanceTenancy(String instanceTenancy) {
setInstanceTenancy(instanceTenancy);
return this;
}
/**
*
* The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of
* dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated
* Instances).
*
*
* Default: default
*
*
* @param instanceTenancy
* The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of
* dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e.,
* Dedicated Instances).
*
* Default: default
* @see Tenancy
*/
public void setInstanceTenancy(Tenancy instanceTenancy) {
this.instanceTenancy = instanceTenancy.toString();
}
/**
*
* The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of
* dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated
* Instances).
*
*
* Default: default
*
*
* @param instanceTenancy
* The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of
* dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e.,
* Dedicated Instances).
*
* Default: default
* @return Returns a reference to this object so that method calls can be chained together.
* @see Tenancy
*/
public DescribeReservedInstancesOfferingsRequest withInstanceTenancy(Tenancy instanceTenancy) {
setInstanceTenancy(instanceTenancy);
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 DescribeReservedInstancesOfferingsRequest 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 DescribeReservedInstancesOfferingsRequest withOfferingType(OfferingTypeValues offeringType) {
setOfferingType(offeringType);
return this;
}
/**
*
* The token to retrieve the next page of results.
*
*
* @param nextToken
* The token to retrieve the next page of results.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* The token to retrieve the next page of results.
*
*
* @return The token to retrieve the next page of results.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* The token to retrieve the next page of results.
*
*
* @param nextToken
* The token to retrieve the next page of results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeReservedInstancesOfferingsRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* The maximum number of results to return for the request in a single page. The remaining results of the initial
* request can be seen by sending another request with the returned NextToken value. The maximum is
* 100.
*
*
* Default: 100
*
*
* @param maxResults
* The maximum number of results to return for the request in a single page. The remaining results of the
* initial request can be seen by sending another request with the returned NextToken value. The
* maximum is 100.
*
* Default: 100
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of results to return for the request in a single page. The remaining results of the initial
* request can be seen by sending another request with the returned NextToken value. The maximum is
* 100.
*
*
* Default: 100
*
*
* @return The maximum number of results to return for the request in a single page. The remaining results of the
* initial request can be seen by sending another request with the returned NextToken value.
* The maximum is 100.
*
* Default: 100
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of results to return for the request in a single page. The remaining results of the initial
* request can be seen by sending another request with the returned NextToken value. The maximum is
* 100.
*
*
* Default: 100
*
*
* @param maxResults
* The maximum number of results to return for the request in a single page. The remaining results of the
* initial request can be seen by sending another request with the returned NextToken value. The
* maximum is 100.
*
* Default: 100
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeReservedInstancesOfferingsRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* Include Reserved Instance Marketplace offerings in the response.
*
*
* @param includeMarketplace
* Include Reserved Instance Marketplace offerings in the response.
*/
public void setIncludeMarketplace(Boolean includeMarketplace) {
this.includeMarketplace = includeMarketplace;
}
/**
*
* Include Reserved Instance Marketplace offerings in the response.
*
*
* @return Include Reserved Instance Marketplace offerings in the response.
*/
public Boolean getIncludeMarketplace() {
return this.includeMarketplace;
}
/**
*
* Include Reserved Instance Marketplace offerings in the response.
*
*
* @param includeMarketplace
* Include Reserved Instance Marketplace offerings in the response.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeReservedInstancesOfferingsRequest withIncludeMarketplace(Boolean includeMarketplace) {
setIncludeMarketplace(includeMarketplace);
return this;
}
/**
*
* Include Reserved Instance Marketplace offerings in the response.
*
*
* @return Include Reserved Instance Marketplace offerings in the response.
*/
public Boolean isIncludeMarketplace() {
return this.includeMarketplace;
}
/**
*
* The minimum duration (in seconds) to filter when searching for offerings.
*
*
* Default: 2592000 (1 month)
*
*
* @param minDuration
* The minimum duration (in seconds) to filter when searching for offerings.
*
* Default: 2592000 (1 month)
*/
public void setMinDuration(Long minDuration) {
this.minDuration = minDuration;
}
/**
*
* The minimum duration (in seconds) to filter when searching for offerings.
*
*
* Default: 2592000 (1 month)
*
*
* @return The minimum duration (in seconds) to filter when searching for offerings.
*
* Default: 2592000 (1 month)
*/
public Long getMinDuration() {
return this.minDuration;
}
/**
*
* The minimum duration (in seconds) to filter when searching for offerings.
*
*
* Default: 2592000 (1 month)
*
*
* @param minDuration
* The minimum duration (in seconds) to filter when searching for offerings.
*
* Default: 2592000 (1 month)
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeReservedInstancesOfferingsRequest withMinDuration(Long minDuration) {
setMinDuration(minDuration);
return this;
}
/**
*
* The maximum duration (in seconds) to filter when searching for offerings.
*
*
* Default: 94608000 (3 years)
*
*
* @param maxDuration
* The maximum duration (in seconds) to filter when searching for offerings.
*
* Default: 94608000 (3 years)
*/
public void setMaxDuration(Long maxDuration) {
this.maxDuration = maxDuration;
}
/**
*
* The maximum duration (in seconds) to filter when searching for offerings.
*
*
* Default: 94608000 (3 years)
*
*
* @return The maximum duration (in seconds) to filter when searching for offerings.
*
* Default: 94608000 (3 years)
*/
public Long getMaxDuration() {
return this.maxDuration;
}
/**
*
* The maximum duration (in seconds) to filter when searching for offerings.
*
*
* Default: 94608000 (3 years)
*
*
* @param maxDuration
* The maximum duration (in seconds) to filter when searching for offerings.
*
* Default: 94608000 (3 years)
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeReservedInstancesOfferingsRequest withMaxDuration(Long maxDuration) {
setMaxDuration(maxDuration);
return this;
}
/**
*
* The maximum number of instances to filter when searching for offerings.
*
*
* Default: 20
*
*
* @param maxInstanceCount
* The maximum number of instances to filter when searching for offerings.
*
* Default: 20
*/
public void setMaxInstanceCount(Integer maxInstanceCount) {
this.maxInstanceCount = maxInstanceCount;
}
/**
*
* The maximum number of instances to filter when searching for offerings.
*
*
* Default: 20
*
*
* @return The maximum number of instances to filter when searching for offerings.
*
* Default: 20
*/
public Integer getMaxInstanceCount() {
return this.maxInstanceCount;
}
/**
*
* The maximum number of instances to filter when searching for offerings.
*
*
* Default: 20
*
*
* @param maxInstanceCount
* The maximum number of instances to filter when searching for offerings.
*
* Default: 20
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeReservedInstancesOfferingsRequest withMaxInstanceCount(Integer maxInstanceCount) {
setMaxInstanceCount(maxInstanceCount);
return this;
}
/**
*
* The offering class of the Reserved Instance. Can be standard or convertible.
*
*
* @param offeringClass
* The offering class of the Reserved Instance. Can be standard or convertible.
* @see OfferingClassType
*/
public void setOfferingClass(String offeringClass) {
this.offeringClass = offeringClass;
}
/**
*
* The offering class of the Reserved Instance. Can be standard or convertible.
*
*
* @return The offering class of the Reserved Instance. Can be standard or convertible.
* @see OfferingClassType
*/
public String getOfferingClass() {
return this.offeringClass;
}
/**
*
* The offering class of the Reserved Instance. Can be standard or convertible.
*
*
* @param offeringClass
* The offering class of the Reserved Instance. Can be standard or convertible.
* @return Returns a reference to this object so that method calls can be chained together.
* @see OfferingClassType
*/
public DescribeReservedInstancesOfferingsRequest withOfferingClass(String offeringClass) {
setOfferingClass(offeringClass);
return this;
}
/**
*
* The offering class of the Reserved Instance. Can be standard or convertible.
*
*
* @param offeringClass
* The offering class of the Reserved Instance. Can be standard or convertible.
* @see OfferingClassType
*/
public void setOfferingClass(OfferingClassType offeringClass) {
this.offeringClass = offeringClass.toString();
}
/**
*
* The offering class of the Reserved Instance. Can be standard or convertible.
*
*
* @param offeringClass
* The offering class of the Reserved Instance. Can be standard or convertible.
* @return Returns a reference to this object so that method calls can be chained together.
* @see OfferingClassType
*/
public DescribeReservedInstancesOfferingsRequest 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 DescribeReservedInstancesOfferingsRequestMarshaller().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 (getReservedInstancesOfferingIds() != null)
sb.append("ReservedInstancesOfferingIds: " + getReservedInstancesOfferingIds() + ",");
if (getInstanceType() != null)
sb.append("InstanceType: " + getInstanceType() + ",");
if (getAvailabilityZone() != null)
sb.append("AvailabilityZone: " + getAvailabilityZone() + ",");
if (getProductDescription() != null)
sb.append("ProductDescription: " + getProductDescription() + ",");
if (getFilters() != null)
sb.append("Filters: " + getFilters() + ",");
if (getInstanceTenancy() != null)
sb.append("InstanceTenancy: " + getInstanceTenancy() + ",");
if (getOfferingType() != null)
sb.append("OfferingType: " + getOfferingType() + ",");
if (getNextToken() != null)
sb.append("NextToken: " + getNextToken() + ",");
if (getMaxResults() != null)
sb.append("MaxResults: " + getMaxResults() + ",");
if (getIncludeMarketplace() != null)
sb.append("IncludeMarketplace: " + getIncludeMarketplace() + ",");
if (getMinDuration() != null)
sb.append("MinDuration: " + getMinDuration() + ",");
if (getMaxDuration() != null)
sb.append("MaxDuration: " + getMaxDuration() + ",");
if (getMaxInstanceCount() != null)
sb.append("MaxInstanceCount: " + getMaxInstanceCount() + ",");
if (getOfferingClass() != null)
sb.append("OfferingClass: " + 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 DescribeReservedInstancesOfferingsRequest == false)
return false;
DescribeReservedInstancesOfferingsRequest other = (DescribeReservedInstancesOfferingsRequest) obj;
if (other.getReservedInstancesOfferingIds() == null ^ this.getReservedInstancesOfferingIds() == null)
return false;
if (other.getReservedInstancesOfferingIds() != null && other.getReservedInstancesOfferingIds().equals(this.getReservedInstancesOfferingIds()) == false)
return false;
if (other.getInstanceType() == null ^ this.getInstanceType() == null)
return false;
if (other.getInstanceType() != null && other.getInstanceType().equals(this.getInstanceType()) == false)
return false;
if (other.getAvailabilityZone() == null ^ this.getAvailabilityZone() == null)
return false;
if (other.getAvailabilityZone() != null && other.getAvailabilityZone().equals(this.getAvailabilityZone()) == false)
return false;
if (other.getProductDescription() == null ^ this.getProductDescription() == null)
return false;
if (other.getProductDescription() != null && other.getProductDescription().equals(this.getProductDescription()) == 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.getInstanceTenancy() == null ^ this.getInstanceTenancy() == null)
return false;
if (other.getInstanceTenancy() != null && other.getInstanceTenancy().equals(this.getInstanceTenancy()) == 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.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
if (other.getMaxResults() == null ^ this.getMaxResults() == null)
return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false)
return false;
if (other.getIncludeMarketplace() == null ^ this.getIncludeMarketplace() == null)
return false;
if (other.getIncludeMarketplace() != null && other.getIncludeMarketplace().equals(this.getIncludeMarketplace()) == false)
return false;
if (other.getMinDuration() == null ^ this.getMinDuration() == null)
return false;
if (other.getMinDuration() != null && other.getMinDuration().equals(this.getMinDuration()) == false)
return false;
if (other.getMaxDuration() == null ^ this.getMaxDuration() == null)
return false;
if (other.getMaxDuration() != null && other.getMaxDuration().equals(this.getMaxDuration()) == false)
return false;
if (other.getMaxInstanceCount() == null ^ this.getMaxInstanceCount() == null)
return false;
if (other.getMaxInstanceCount() != null && other.getMaxInstanceCount().equals(this.getMaxInstanceCount()) == 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 + ((getReservedInstancesOfferingIds() == null) ? 0 : getReservedInstancesOfferingIds().hashCode());
hashCode = prime * hashCode + ((getInstanceType() == null) ? 0 : getInstanceType().hashCode());
hashCode = prime * hashCode + ((getAvailabilityZone() == null) ? 0 : getAvailabilityZone().hashCode());
hashCode = prime * hashCode + ((getProductDescription() == null) ? 0 : getProductDescription().hashCode());
hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode());
hashCode = prime * hashCode + ((getInstanceTenancy() == null) ? 0 : getInstanceTenancy().hashCode());
hashCode = prime * hashCode + ((getOfferingType() == null) ? 0 : getOfferingType().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getIncludeMarketplace() == null) ? 0 : getIncludeMarketplace().hashCode());
hashCode = prime * hashCode + ((getMinDuration() == null) ? 0 : getMinDuration().hashCode());
hashCode = prime * hashCode + ((getMaxDuration() == null) ? 0 : getMaxDuration().hashCode());
hashCode = prime * hashCode + ((getMaxInstanceCount() == null) ? 0 : getMaxInstanceCount().hashCode());
hashCode = prime * hashCode + ((getOfferingClass() == null) ? 0 : getOfferingClass().hashCode());
return hashCode;
}
@Override
public DescribeReservedInstancesOfferingsRequest clone() {
return (DescribeReservedInstancesOfferingsRequest) super.clone();
}
}