com.amazonaws.services.rds.model.DescribeReservedDBInstancesRequest Maven / Gradle / Ivy
/*
* Copyright 2010-2011 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.rds.model;
import com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.rds.AmazonRDS#describeReservedDBInstances(DescribeReservedDBInstancesRequest) DescribeReservedDBInstances operation}.
*
* Returns information about reserved DB Instances for this account, or
* about a specified reserved DB Instance.
*
*
* @see com.amazonaws.services.rds.AmazonRDS#describeReservedDBInstances(DescribeReservedDBInstancesRequest)
*/
public class DescribeReservedDBInstancesRequest extends AmazonWebServiceRequest {
/**
* The reserved DB Instance identifier filter value. Specify this
* parameter to show only the reservation that matches the specified
* reservation ID.
*/
private String reservedDBInstanceId;
/**
* The offering identifier filter value. Specify this parameter to show
* only purchased reservations matching the specified offering
* identifier.
*/
private String reservedDBInstancesOfferingId;
/**
* The DB Instance class filter value. Specify this parameter to show
* only those reservations matching the specified DB Instances class.
*/
private String dBInstanceClass;
/**
* The duration filter value, specified in years or seconds. Specify this
* parameter to show only reservations for this duration.
*/
private String duration;
/**
* The product description filter value. Specify this parameter to show
* only those reservations matching the specified product description.
*/
private String productDescription;
/**
* The Multi-AZ filter value. Specify this parameter to show only those
* reservations matching the specified Multi-AZ parameter.
*/
private Boolean multiAZ;
/**
* The maximum number of records to include in the response. If more than
* the MaxRecords value is available, a marker is included
* in the response so that the following results can be retrieved.
*/
private Integer maxRecords;
/**
* The marker provided in the previous request. If this parameter is
* specified, the response includes records beyond the marker only, up to
* MaxRecords.
*/
private String marker;
/**
* Default constructor for a new DescribeReservedDBInstancesRequest object. Callers should use the
* setter or fluent setter (with...) methods to initialize this object after creating it.
*/
public DescribeReservedDBInstancesRequest() {}
/**
* The reserved DB Instance identifier filter value. Specify this
* parameter to show only the reservation that matches the specified
* reservation ID.
*
* @return The reserved DB Instance identifier filter value. Specify this
* parameter to show only the reservation that matches the specified
* reservation ID.
*/
public String getReservedDBInstanceId() {
return reservedDBInstanceId;
}
/**
* The reserved DB Instance identifier filter value. Specify this
* parameter to show only the reservation that matches the specified
* reservation ID.
*
* @param reservedDBInstanceId The reserved DB Instance identifier filter value. Specify this
* parameter to show only the reservation that matches the specified
* reservation ID.
*/
public void setReservedDBInstanceId(String reservedDBInstanceId) {
this.reservedDBInstanceId = 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.
*
* @param reservedDBInstanceId The reserved DB Instance identifier filter value. Specify this
* parameter to show only the reservation that matches the specified
* reservation ID.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeReservedDBInstancesRequest withReservedDBInstanceId(String reservedDBInstanceId) {
this.reservedDBInstanceId = reservedDBInstanceId;
return this;
}
/**
* The offering identifier filter value. Specify this parameter to show
* only purchased reservations matching the specified offering
* identifier.
*
* @return The offering identifier filter value. Specify this parameter to show
* only purchased reservations matching the specified offering
* identifier.
*/
public String getReservedDBInstancesOfferingId() {
return reservedDBInstancesOfferingId;
}
/**
* The offering identifier filter value. Specify this parameter to show
* only purchased reservations matching the specified offering
* identifier.
*
* @param reservedDBInstancesOfferingId The offering identifier filter value. Specify this parameter to show
* only purchased reservations matching the specified offering
* identifier.
*/
public void setReservedDBInstancesOfferingId(String reservedDBInstancesOfferingId) {
this.reservedDBInstancesOfferingId = 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.
*
* @param reservedDBInstancesOfferingId The offering identifier filter value. Specify this parameter to show
* only purchased reservations matching the specified offering
* identifier.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeReservedDBInstancesRequest withReservedDBInstancesOfferingId(String reservedDBInstancesOfferingId) {
this.reservedDBInstancesOfferingId = reservedDBInstancesOfferingId;
return this;
}
/**
* The DB Instance class filter value. Specify this parameter to show
* only those reservations matching the specified DB Instances class.
*
* @return The DB Instance class filter value. Specify this parameter to show
* only those reservations matching the specified DB Instances class.
*/
public String getDBInstanceClass() {
return dBInstanceClass;
}
/**
* The DB Instance class filter value. Specify this parameter to show
* only those reservations matching the specified DB Instances class.
*
* @param dBInstanceClass The DB Instance class filter value. Specify this parameter to show
* only those reservations matching the specified DB Instances class.
*/
public void setDBInstanceClass(String dBInstanceClass) {
this.dBInstanceClass = 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.
*
* @param dBInstanceClass The DB Instance class filter value. Specify this parameter to show
* only those reservations matching the specified DB Instances class.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeReservedDBInstancesRequest withDBInstanceClass(String dBInstanceClass) {
this.dBInstanceClass = dBInstanceClass;
return this;
}
/**
* The duration filter value, specified in years or seconds. Specify this
* parameter to show only reservations for this duration.
*
* @return The duration filter value, specified in years or seconds. Specify this
* parameter to show only reservations for this duration.
*/
public String getDuration() {
return duration;
}
/**
* The duration filter value, specified in years or seconds. Specify this
* parameter to show only reservations for this duration.
*
* @param duration The duration filter value, specified in years or seconds. Specify this
* parameter to show only reservations for this duration.
*/
public void setDuration(String duration) {
this.duration = duration;
}
/**
* The duration filter value, specified in years or seconds. Specify this
* parameter to show only reservations for this duration.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param duration The duration filter value, specified in years or seconds. Specify this
* parameter to show only reservations for this duration.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeReservedDBInstancesRequest withDuration(String duration) {
this.duration = duration;
return this;
}
/**
* The product description filter value. Specify this parameter to show
* only those reservations matching the specified product description.
*
* @return The product description filter value. Specify this parameter to show
* only those reservations matching the specified product description.
*/
public String getProductDescription() {
return productDescription;
}
/**
* The product description filter value. Specify this parameter to show
* only those reservations matching the specified product description.
*
* @param productDescription The product description filter value. Specify this parameter to show
* only those reservations matching the specified product description.
*/
public void setProductDescription(String productDescription) {
this.productDescription = 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.
*
* @param productDescription The product description filter value. Specify this parameter to show
* only those reservations matching the specified product description.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeReservedDBInstancesRequest withProductDescription(String productDescription) {
this.productDescription = productDescription;
return this;
}
/**
* The Multi-AZ filter value. Specify this parameter to show only those
* reservations matching the specified Multi-AZ parameter.
*
* @return The Multi-AZ filter value. Specify this parameter to show only those
* reservations matching the specified Multi-AZ parameter.
*/
public Boolean isMultiAZ() {
return multiAZ;
}
/**
* The Multi-AZ filter value. Specify this parameter to show only those
* reservations matching the specified Multi-AZ parameter.
*
* @param multiAZ The Multi-AZ filter value. Specify this parameter to show only those
* reservations matching the specified Multi-AZ parameter.
*/
public void setMultiAZ(Boolean multiAZ) {
this.multiAZ = 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.
*
* @param multiAZ The Multi-AZ filter value. Specify this parameter to show only those
* reservations matching the specified Multi-AZ parameter.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeReservedDBInstancesRequest withMultiAZ(Boolean multiAZ) {
this.multiAZ = multiAZ;
return this;
}
/**
* The Multi-AZ filter value. Specify this parameter to show only those
* reservations matching the specified Multi-AZ parameter.
*
* @return The Multi-AZ filter value. Specify this parameter to show only those
* reservations matching the specified Multi-AZ parameter.
*/
public Boolean getMultiAZ() {
return multiAZ;
}
/**
* The maximum number of records to include in the response. If more than
* the MaxRecords value is available, a marker is included
* in the response so that the following results can be retrieved.
*
* @return The maximum number of records to include in the response. If more than
* the MaxRecords value is available, a marker is included
* in the response so that the following results can be retrieved.
*/
public Integer getMaxRecords() {
return maxRecords;
}
/**
* The maximum number of records to include in the response. If more than
* the MaxRecords value is available, a marker is included
* in the response so that the following results can be retrieved.
*
* @param maxRecords The maximum number of records to include in the response. If more than
* the MaxRecords value is available, a marker is included
* in the response so that the following results can be retrieved.
*/
public void setMaxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
}
/**
* The maximum number of records to include in the response. If more than
* the MaxRecords value is available, a marker is included
* in the response so that the following results can be retrieved.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param maxRecords The maximum number of records to include in the response. If more than
* the MaxRecords value is available, a marker is included
* in the response so that the following results can be retrieved.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeReservedDBInstancesRequest withMaxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
return this;
}
/**
* The marker provided in the previous request. If this parameter is
* specified, the response includes records beyond the marker only, up to
* MaxRecords.
*
* @return The marker provided in the previous request. If this parameter is
* specified, the response includes records beyond the marker only, up to
* MaxRecords.
*/
public String getMarker() {
return marker;
}
/**
* The marker provided in the previous request. If this parameter is
* specified, the response includes records beyond the marker only, up to
* MaxRecords.
*
* @param marker The marker provided in the previous request. If this parameter is
* specified, the response includes records beyond the marker only, up to
* MaxRecords.
*/
public void setMarker(String marker) {
this.marker = marker;
}
/**
* The marker provided in the previous request. If this parameter is
* specified, the response includes records beyond the marker only, up to
* MaxRecords.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param marker The marker provided in the previous request. If this parameter is
* specified, the response includes records beyond the marker only, up to
* MaxRecords.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeReservedDBInstancesRequest withMarker(String marker) {
this.marker = marker;
return this;
}
/**
* 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("{");
sb.append("ReservedDBInstanceId: " + reservedDBInstanceId + ", ");
sb.append("ReservedDBInstancesOfferingId: " + reservedDBInstancesOfferingId + ", ");
sb.append("DBInstanceClass: " + dBInstanceClass + ", ");
sb.append("Duration: " + duration + ", ");
sb.append("ProductDescription: " + productDescription + ", ");
sb.append("MultiAZ: " + multiAZ + ", ");
sb.append("MaxRecords: " + maxRecords + ", ");
sb.append("Marker: " + marker + ", ");
sb.append("}");
return sb.toString();
}
}