com.amazonaws.services.rds.model.DescribeDBInstancesRequest 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#describeDBInstances(DescribeDBInstancesRequest) DescribeDBInstances operation}.
*
* This API is used to retrieve information about provisioned RDS
* instances. DescribeDBInstances supports pagination.
*
*
* @see com.amazonaws.services.rds.AmazonRDS#describeDBInstances(DescribeDBInstancesRequest)
*/
public class DescribeDBInstancesRequest extends AmazonWebServiceRequest {
/**
* The user-supplied instance identifier. If this parameter is specified,
* information from only the specific DB Instance is returned. This
* parameter isn't case sensitive.
*/
private String dBInstanceIdentifier;
/**
* The maximum number of records to include in the response. If more
* records exist than the specified MaxRecords value, a marker is
* included in the response so that the remaining results may be
* retrieved.
*/
private Integer maxRecords;
/**
* An optional marker provided in the previous DescribeDBInstances
* request. If this parameter is specified, the response includes only
* records beyond the marker, up to the value specified by
* MaxRecords.
*/
private String marker;
/**
* Default constructor for a new DescribeDBInstancesRequest object. Callers should use the
* setter or fluent setter (with...) methods to initialize this object after creating it.
*/
public DescribeDBInstancesRequest() {}
/**
* The user-supplied instance identifier. If this parameter is specified,
* information from only the specific DB Instance is returned. This
* parameter isn't case sensitive.
*
* @return The user-supplied instance identifier. If this parameter is specified,
* information from only the specific DB Instance is returned. This
* parameter isn't case sensitive.
*/
public String getDBInstanceIdentifier() {
return dBInstanceIdentifier;
}
/**
* The user-supplied instance identifier. If this parameter is specified,
* information from only the specific DB Instance is returned. This
* parameter isn't case sensitive.
*
* @param dBInstanceIdentifier The user-supplied instance identifier. If this parameter is specified,
* information from only the specific DB Instance is returned. This
* parameter isn't case sensitive.
*/
public void setDBInstanceIdentifier(String dBInstanceIdentifier) {
this.dBInstanceIdentifier = dBInstanceIdentifier;
}
/**
* The user-supplied instance identifier. If this parameter is specified,
* information from only the specific DB Instance is returned. This
* parameter isn't case sensitive.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param dBInstanceIdentifier The user-supplied instance identifier. If this parameter is specified,
* information from only the specific DB Instance is returned. This
* parameter isn't case sensitive.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeDBInstancesRequest withDBInstanceIdentifier(String dBInstanceIdentifier) {
this.dBInstanceIdentifier = dBInstanceIdentifier;
return this;
}
/**
* The maximum number of records to include in the response. If more
* records exist than the specified MaxRecords value, a marker is
* included in the response so that the remaining results may be
* retrieved.
*
* @return The maximum number of records to include in the response. If more
* records exist than the specified MaxRecords value, a marker is
* included in the response so that the remaining results may be
* retrieved.
*/
public Integer getMaxRecords() {
return maxRecords;
}
/**
* The maximum number of records to include in the response. If more
* records exist than the specified MaxRecords value, a marker is
* included in the response so that the remaining results may be
* retrieved.
*
* @param maxRecords The maximum number of records to include in the response. If more
* records exist than the specified MaxRecords value, a marker is
* included in the response so that the remaining results may be
* retrieved.
*/
public void setMaxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
}
/**
* The maximum number of records to include in the response. If more
* records exist than the specified MaxRecords value, a marker is
* included in the response so that the remaining results may 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
* records exist than the specified MaxRecords value, a marker is
* included in the response so that the remaining results may be
* retrieved.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeDBInstancesRequest withMaxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
return this;
}
/**
* An optional marker provided in the previous DescribeDBInstances
* request. If this parameter is specified, the response includes only
* records beyond the marker, up to the value specified by
* MaxRecords.
*
* @return An optional marker provided in the previous DescribeDBInstances
* request. If this parameter is specified, the response includes only
* records beyond the marker, up to the value specified by
* MaxRecords.
*/
public String getMarker() {
return marker;
}
/**
* An optional marker provided in the previous DescribeDBInstances
* request. If this parameter is specified, the response includes only
* records beyond the marker, up to the value specified by
* MaxRecords.
*
* @param marker An optional marker provided in the previous DescribeDBInstances
* request. If this parameter is specified, the response includes only
* records beyond the marker, up to the value specified by
* MaxRecords.
*/
public void setMarker(String marker) {
this.marker = marker;
}
/**
* An optional marker provided in the previous DescribeDBInstances
* 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.
*
* @param marker An optional marker provided in the previous DescribeDBInstances
* request. If this parameter is specified, the response includes only
* records beyond the marker, up to the value specified by
* MaxRecords.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeDBInstancesRequest 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("DBInstanceIdentifier: " + dBInstanceIdentifier + ", ");
sb.append("MaxRecords: " + maxRecords + ", ");
sb.append("Marker: " + marker + ", ");
sb.append("}");
return sb.toString();
}
}