Class DescribeDBInstancesRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.rds.model.DescribeDBInstancesRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class DescribeDBInstancesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description DescribeDBInstancesRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DescribeDBInstancesRequest
clone()
Creates a shallow clone of this request.boolean
equals(Object obj)
String
getDBInstanceIdentifier()
The user-supplied instance identifier.List<Filter>
getFilters()
This parameter is not currently supported.String
getMarker()
An optional pagination token provided by a previousDescribeDBInstances
request.Integer
getMaxRecords()
The maximum number of records to include in the response.int
hashCode()
void
setDBInstanceIdentifier(String dBInstanceIdentifier)
The user-supplied instance identifier.void
setFilters(Collection<Filter> filters)
This parameter is not currently supported.void
setMarker(String marker)
An optional pagination token provided by a previousDescribeDBInstances
request.void
setMaxRecords(Integer maxRecords)
The maximum number of records to include in the response.String
toString()
Returns a string representation of this object; useful for testing and debugging.DescribeDBInstancesRequest
withDBInstanceIdentifier(String dBInstanceIdentifier)
The user-supplied instance identifier.DescribeDBInstancesRequest
withFilters(Filter... filters)
This parameter is not currently supported.DescribeDBInstancesRequest
withFilters(Collection<Filter> filters)
This parameter is not currently supported.DescribeDBInstancesRequest
withMarker(String marker)
An optional pagination token provided by a previousDescribeDBInstances
request.DescribeDBInstancesRequest
withMaxRecords(Integer maxRecords)
The maximum number of records to include in the response.-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Method Detail
-
setDBInstanceIdentifier
public void setDBInstanceIdentifier(String 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.
Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
- Parameters:
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.Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
-
getDBInstanceIdentifier
public String getDBInstanceIdentifier()
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.
Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
- Returns:
- 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.
Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
-
withDBInstanceIdentifier
public DescribeDBInstancesRequest withDBInstanceIdentifier(String 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.
Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
- Parameters:
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.Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 DescribeDBInstancesRequest 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)
orwithFilters(java.util.Collection)
if you want to override the existing values.- Parameters:
filters
- This parameter is not currently supported.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withFilters
public DescribeDBInstancesRequest withFilters(Collection<Filter> filters)
This parameter is not currently supported.
- Parameters:
filters
- This parameter is not currently supported.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMaxRecords
public void setMaxRecords(Integer maxRecords)
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that the remaining 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 records exist than the specifiedMaxRecords
value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.Default: 100
Constraints: Minimum 20, maximum 100.
-
getMaxRecords
public Integer getMaxRecords()
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.Default: 100
Constraints: Minimum 20, maximum 100.
- Returns:
- The maximum number of records to include in the response. If more
records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.Default: 100
Constraints: Minimum 20, maximum 100.
-
withMaxRecords
public DescribeDBInstancesRequest withMaxRecords(Integer maxRecords)
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that the remaining 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 records exist than the specifiedMaxRecords
value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.Default: 100
Constraints: Minimum 20, maximum 100.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMarker
public void setMarker(String marker)
An optional pagination token provided by a previous
DescribeDBInstances
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.- Parameters:
marker
- An optional pagination token provided by a previousDescribeDBInstances
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.
-
getMarker
public String getMarker()
An optional pagination token provided by a previous
DescribeDBInstances
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.- Returns:
- An optional pagination token provided by a previous
DescribeDBInstances
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.
-
withMarker
public DescribeDBInstancesRequest withMarker(String marker)
An optional pagination token provided by a previous
DescribeDBInstances
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.- Parameters:
marker
- An optional pagination token provided by a previousDescribeDBInstances
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.- Returns:
- Returns a reference to this 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 classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public DescribeDBInstancesRequest 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 classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-