com.amazonaws.services.rds.model

Class DescribeReservedDBInstancesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rds.model.DescribeReservedDBInstancesRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeReservedDBInstancesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DescribeReservedDBInstances operation.

Returns information about reserved DB instances for this account, or about a specified reserved DB instance.

See Also:

AmazonRDS.describeReservedDBInstances(DescribeReservedDBInstancesRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeReservedDBInstancesRequest() Default constructor for a new DescribeReservedDBInstancesRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
DescribeReservedDBInstancesRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getDBInstanceClass() The DB instance class filter value.
String	getDuration() The duration filter value, specified in years or seconds.
List<Filter>	getFilters() This parameter is not currently supported.
String	getMarker() An optional pagination token provided by a previous request.
Integer	getMaxRecords() The maximum number of records to include in the response.
Boolean	getMultiAZ() The Multi-AZ filter value.
String	getOfferingType() The offering type filter value.
String	getProductDescription() The product description filter value.
String	getReservedDBInstanceId() The reserved DB instance identifier filter value.
String	getReservedDBInstancesOfferingId() The offering identifier filter value.
int	hashCode()
Boolean	isMultiAZ() The Multi-AZ filter value.
void	setDBInstanceClass(String dBInstanceClass) The DB instance class filter value.
void	setDuration(String duration) The duration filter value, specified in years or seconds.
void	setFilters(Collection<Filter> filters) This parameter is not currently supported.
void	setMarker(String marker) An optional pagination token provided by a previous request.
void	setMaxRecords(Integer maxRecords) The maximum number of records to include in the response.
void	setMultiAZ(Boolean multiAZ) The Multi-AZ filter value.
void	setOfferingType(String offeringType) The offering type filter value.
void	setProductDescription(String productDescription) The product description filter value.
void	setReservedDBInstanceId(String reservedDBInstanceId) The reserved DB instance identifier filter value.
void	setReservedDBInstancesOfferingId(String reservedDBInstancesOfferingId) The offering identifier filter value.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeReservedDBInstancesRequest	withDBInstanceClass(String dBInstanceClass) The DB instance class filter value.
DescribeReservedDBInstancesRequest	withDuration(String duration) The duration filter value, specified in years or seconds.
DescribeReservedDBInstancesRequest	withFilters(Collection<Filter> filters) This parameter is not currently supported.
DescribeReservedDBInstancesRequest	withFilters(Filter... filters) This parameter is not currently supported.
DescribeReservedDBInstancesRequest	withMarker(String marker) An optional pagination token provided by a previous request.
DescribeReservedDBInstancesRequest	withMaxRecords(Integer maxRecords) The maximum number of records to include in the response.
DescribeReservedDBInstancesRequest	withMultiAZ(Boolean multiAZ) The Multi-AZ filter value.
DescribeReservedDBInstancesRequest	withOfferingType(String offeringType) The offering type filter value.
DescribeReservedDBInstancesRequest	withProductDescription(String productDescription) The product description filter value.
DescribeReservedDBInstancesRequest	withReservedDBInstanceId(String reservedDBInstanceId) The reserved DB instance identifier filter value.
DescribeReservedDBInstancesRequest	withReservedDBInstancesOfferingId(String reservedDBInstancesOfferingId) The offering identifier filter value.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeReservedDBInstancesRequest

public DescribeReservedDBInstancesRequest()

Default constructor for a new DescribeReservedDBInstancesRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

Method Detail

getReservedDBInstanceId

public String getReservedDBInstanceId()

The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.

Returns:

The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.

setReservedDBInstanceId

public void setReservedDBInstanceId(String reservedDBInstanceId)

The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.

Parameters:

reservedDBInstanceId - The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.

withReservedDBInstanceId

public DescribeReservedDBInstancesRequest withReservedDBInstanceId(String reservedDBInstanceId)

The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.

Returns a reference to this object so that method calls can be chained together.

Parameters:

reservedDBInstanceId - The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.

Returns:

A reference to this updated object so that method calls can be chained together.

getReservedDBInstancesOfferingId

public String getReservedDBInstancesOfferingId()

The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.

Returns:

The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.

setReservedDBInstancesOfferingId

public void setReservedDBInstancesOfferingId(String reservedDBInstancesOfferingId)

The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.

Parameters:

reservedDBInstancesOfferingId - The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.

withReservedDBInstancesOfferingId

public DescribeReservedDBInstancesRequest withReservedDBInstancesOfferingId(String reservedDBInstancesOfferingId)

The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.

Returns a reference to this object so that method calls can be chained together.

Parameters:

reservedDBInstancesOfferingId - The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.

Returns:

A reference to this updated object so that method calls can be chained together.

getDBInstanceClass

public String getDBInstanceClass()

The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.

Returns:

The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.

setDBInstanceClass

public void setDBInstanceClass(String dBInstanceClass)

The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.

Parameters:

dBInstanceClass - The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.

withDBInstanceClass

public DescribeReservedDBInstancesRequest withDBInstanceClass(String dBInstanceClass)

The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.

Returns a reference to this object so that method calls can be chained together.

Parameters:

dBInstanceClass - The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.

Returns:

A reference to this updated object so that method calls can be chained together.

getDuration

public String getDuration()

The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

Returns:

The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

setDuration

public void setDuration(String duration)

The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

Parameters:

duration - The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

withDuration

public DescribeReservedDBInstancesRequest withDuration(String duration)

The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

Returns a reference to this object so that method calls can be chained together.

Parameters:

duration - The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

Returns:

A reference to this updated object so that method calls can be chained together.

getProductDescription

public String getProductDescription()

The product description filter value. Specify this parameter to show only those reservations matching the specified product description.

Returns:

The product description filter value. Specify this parameter to show only those reservations matching the specified product description.

setProductDescription

public void setProductDescription(String productDescription)

The product description filter value. Specify this parameter to show only those reservations matching the specified product description.

Parameters:

productDescription - The product description filter value. Specify this parameter to show only those reservations matching the specified product description.

withProductDescription

public DescribeReservedDBInstancesRequest withProductDescription(String productDescription)

The product description filter value. Specify this parameter to show only those reservations matching the specified product description.

Returns a reference to this object so that method calls can be chained together.

Parameters:

productDescription - The product description filter value. Specify this parameter to show only those reservations matching the specified product description.

Returns:

A reference to this updated object so that method calls can be chained together.

getOfferingType

public String getOfferingType()

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"

Returns:

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"

setOfferingType

public void setOfferingType(String offeringType)

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"

Parameters:

offeringType - The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"

withOfferingType

public DescribeReservedDBInstancesRequest withOfferingType(String offeringType)

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"

Returns a reference to this object so that method calls can be chained together.

Parameters:

offeringType - The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"

Returns:

A reference to this updated object so that method calls can be chained together.

isMultiAZ

public Boolean isMultiAZ()

The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter.

Returns:

The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter.

setMultiAZ

public void setMultiAZ(Boolean multiAZ)

The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter.

Parameters:

multiAZ - The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter.

withMultiAZ

public DescribeReservedDBInstancesRequest withMultiAZ(Boolean multiAZ)

The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter.

Returns a reference to this object so that method calls can be chained together.

Parameters:

multiAZ - The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter.

Returns:

A reference to this updated object so that method calls can be chained together.

getMultiAZ

public Boolean getMultiAZ()

The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter.

Returns:

The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter.

getFilters

public List<Filter> getFilters()

This parameter is not currently supported.

Returns:

This parameter is not currently supported.

setFilters

public void setFilters(Collection<Filter> filters)

This parameter is not currently supported.

Parameters:

filters - This parameter is not currently supported.

withFilters

public DescribeReservedDBInstancesRequest withFilters(Filter... filters)

This parameter is not currently supported.

NOTE: This method appends the values to the existing list (if any). Use setFilters(java.util.Collection) or withFilters(java.util.Collection) if you want to override the existing values.

Returns a reference to this object so that method calls can be chained together.

Parameters:

filters - This parameter is not currently supported.

Returns:

A reference to this updated object so that method calls can be chained together.

withFilters

public DescribeReservedDBInstancesRequest withFilters(Collection<Filter> filters)

This parameter is not currently supported.

Returns a reference to this object so that method calls can be chained together.

Parameters:

filters - This parameter is not currently supported.

Returns:

A reference to this updated object so that method calls can be chained together.

getMaxRecords

public Integer getMaxRecords()

The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Returns:

The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

setMaxRecords

public void setMaxRecords(Integer maxRecords)

The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Parameters:

maxRecords - The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

withMaxRecords

public DescribeReservedDBInstancesRequest withMaxRecords(Integer maxRecords)

The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Returns a reference to this object so that method calls can be chained together.

Parameters:

maxRecords - The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Returns:

A reference to this updated object so that method calls can be chained together.

getMarker

public String getMarker()

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Returns:

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

setMarker

public void setMarker(String marker)

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Parameters:

marker - An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

withMarker

public DescribeReservedDBInstancesRequest withMarker(String marker)

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Returns a reference to this object so that method calls can be chained together.

Parameters:

marker - An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public DescribeReservedDBInstancesRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()