com.amazonaws.services.rds.model

Class DescribeDBParametersRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rds.model.DescribeDBParametersRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeDBParametersRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DescribeDBParameters operation.

Returns the detailed parameter list for a particular DB parameter group.

See Also:

AmazonRDS.describeDBParameters(DescribeDBParametersRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeDBParametersRequest() Default constructor for a new DescribeDBParametersRequest object.
DescribeDBParametersRequest(String dBParameterGroupName) Constructs a new DescribeDBParametersRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
DescribeDBParametersRequest	clone() Creates a shallow clone of this request.
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 DescribeDBParameters request.
Integer	getMaxRecords() The maximum number of records to include in the response.
String	getSource() The parameter types to return.
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 DescribeDBParameters request.
void	setMaxRecords(Integer maxRecords) The maximum number of records to include in the response.
void	setSource(String source) The parameter types to return.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeDBParametersRequest	withDBParameterGroupName(String dBParameterGroupName) The name of a specific DB parameter group to return details for.
DescribeDBParametersRequest	withFilters(Collection<Filter> filters) This parameter is not currently supported.
DescribeDBParametersRequest	withFilters(Filter... filters) This parameter is not currently supported.
DescribeDBParametersRequest	withMarker(String marker) An optional pagination token provided by a previous DescribeDBParameters request.
DescribeDBParametersRequest	withMaxRecords(Integer maxRecords) The maximum number of records to include in the response.
DescribeDBParametersRequest	withSource(String source) The parameter types to return.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribeDBParametersRequest

public DescribeDBParametersRequest()

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

DescribeDBParametersRequest

public DescribeDBParametersRequest(String dBParameterGroupName)

Constructs a new DescribeDBParametersRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

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

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 DescribeDBParametersRequest 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.

getSource

public String getSource()

The parameter types to return.

Default: All parameter types returned

Valid Values: user | system | engine-default

Returns:

The parameter types to return.

Default: All parameter types returned

Valid Values: user | system | engine-default

setSource

public void setSource(String source)

The parameter types to return.

Default: All parameter types returned

Valid Values: user | system | engine-default

Parameters:

source - The parameter types to return.

Default: All parameter types returned

Valid Values: user | system | engine-default

withSource

public DescribeDBParametersRequest withSource(String source)

The parameter types to return.

Default: All parameter types returned

Valid Values: user | system | engine-default

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

Parameters:

source - The parameter types to return.

Default: All parameter types returned

Valid Values: user | system | engine-default

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 DescribeDBParametersRequest 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 DescribeDBParametersRequest 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 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.

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 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 DescribeDBParametersRequest 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.

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 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 DescribeDBParameters 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 DescribeDBParameters 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 DescribeDBParameters 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 DescribeDBParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

withMarker

public DescribeDBParametersRequest withMarker(String marker)

An optional pagination token provided by a previous DescribeDBParameters 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 DescribeDBParameters 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 DescribeDBParametersRequest 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()