DescribeDBParameterGroupsRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.rds.model.DescribeDBParameterGroupsRequest

All Implemented Interfaces:

Serializable
```
public class DescribeDBParameterGroupsRequest
extends AmazonWebServiceRequest
implements Serializable
```
Container for the parameters to the DescribeDBParameterGroups operation.
Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.

See Also:
AmazonRDS.describeDBParameterGroups(DescribeDBParameterGroupsRequest), Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeDBParameterGroupsRequest()
Default constructor for a new DescribeDBParameterGroupsRequest object.

Constructors
Constructor and Description
`DescribeDBParameterGroupsRequest()` Default constructor for a new DescribeDBParameterGroupsRequest object.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getDBParameterGroupName()` The name of a specific DB parameter group to return details for.
`List<Filter>`	`getFilters()` This parameter is not currently supported.
`String`	`getMarker()` An optional pagination token provided by a previous `DescribeDBParameterGroups` request.
`Integer`	`getMaxRecords()` The maximum number of records to include in the response.
`int`	`hashCode()`
`void`	`setDBParameterGroupName(String dBParameterGroupName)` The name of a specific DB parameter group to return details for.
`void`	`setFilters(Collection<Filter> filters)` This parameter is not currently supported.
`void`	`setMarker(String marker)` An optional pagination token provided by a previous `DescribeDBParameterGroups` 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.
`DescribeDBParameterGroupsRequest`	`withDBParameterGroupName(String dBParameterGroupName)` The name of a specific DB parameter group to return details for.
`DescribeDBParameterGroupsRequest`	`withFilters(Collection<Filter> filters)` This parameter is not currently supported.
`DescribeDBParameterGroupsRequest`	`withFilters(Filter... filters)` This parameter is not currently supported.
`DescribeDBParameterGroupsRequest`	`withMarker(String marker)` An optional pagination token provided by a previous `DescribeDBParameterGroups` request.
`DescribeDBParameterGroupsRequest`	`withMaxRecords(Integer maxRecords)` The maximum number of records to include in the response.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DescribeDBParameterGroupsRequest
```
public DescribeDBParameterGroupsRequest()
```
    Default constructor for a new DescribeDBParameterGroupsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.
- Method Detail
  - getDBParameterGroupName
```
public String getDBParameterGroupName()
```
    The name of a specific DB parameter group to return details for.
    Constraints:
    - Must be 1 to 255 alphanumeric characters
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
    Returns:
    The name of a specific DB parameter group to return details for.
    Constraints:
    
    Must be 1 to 255 alphanumeric characters
    
    First character must be a letter
    
    Cannot end with a hyphen or contain two consecutive hyphens
  - setDBParameterGroupName
```
public void setDBParameterGroupName(String dBParameterGroupName)
```
    The name of a specific DB parameter group to return details for.
    Constraints:
    - Must be 1 to 255 alphanumeric characters
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
    Parameters:
    dBParameterGroupName - The name of a specific DB parameter group to return details for.
    Constraints:
    
    Must be 1 to 255 alphanumeric characters
    
    First character must be a letter
    
    Cannot end with a hyphen or contain two consecutive hyphens
  - withDBParameterGroupName
```
public DescribeDBParameterGroupsRequest withDBParameterGroupName(String dBParameterGroupName)
```
    The name of a specific DB parameter group to return details for.
    Constraints:
    - Must be 1 to 255 alphanumeric characters
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
    Returns a reference to this object so that method calls can be chained together.
    Parameters:
    dBParameterGroupName - The name of a specific DB parameter group to return details for.
    Constraints:
    
    Must be 1 to 255 alphanumeric characters
    
    First character must be a letter
    
    Cannot end with a hyphen or contain two consecutive hyphens
    Returns:
    A reference to this updated 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 DescribeDBParameterGroupsRequest withFilters(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.
  - withFilters
```
public DescribeDBParameterGroupsRequest 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 records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may 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 may 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 records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may 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 specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.
    Default: 100
    Constraints: minimum 20, maximum 100
  - withMaxRecords
```
public DescribeDBParameterGroupsRequest 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 may 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 records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may 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 DescribeDBParameterGroups 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 DescribeDBParameterGroups 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 DescribeDBParameterGroups 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 DescribeDBParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
  - withMarker
```
public DescribeDBParameterGroupsRequest withMarker(String marker)
```
    An optional pagination token provided by a previous DescribeDBParameterGroups 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 DescribeDBParameterGroups 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

Did this page help you?

Class DescribeDBParameterGroupsRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

DescribeDBParameterGroupsRequest

Method Detail

getDBParameterGroupName

setDBParameterGroupName

withDBParameterGroupName

getFilters

setFilters

withFilters

withFilters

getMaxRecords

setMaxRecords

withMaxRecords

getMarker

setMarker

withMarker

toString

hashCode

equals