com.amazonaws.services.rds.model

Class DescribeDBClusterParametersRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rds.model.DescribeDBClusterParametersRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeDBClusterParametersRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DescribeDBClusterParameters operation.

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

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

See Also:

AmazonRDS.describeDBClusterParameters(DescribeDBClusterParametersRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeDBClusterParametersRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DescribeDBClusterParametersRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getDBClusterParameterGroupName() The name of a specific DB cluster parameter group to return parameter details for.
List<Filter>	getFilters() This parameter is not currently supported.
String	getMarker() An optional pagination token provided by a previous DescribeDBClusterParameters request.
Integer	getMaxRecords() The maximum number of records to include in the response.
String	getSource() A value that indicates to return only parameters for a specific source.
int	hashCode()
void	setDBClusterParameterGroupName(String dBClusterParameterGroupName) The name of a specific DB cluster parameter group to return parameter 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 DescribeDBClusterParameters request.
void	setMaxRecords(Integer maxRecords) The maximum number of records to include in the response.
void	setSource(String source) A value that indicates to return only parameters for a specific source.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeDBClusterParametersRequest	withDBClusterParameterGroupName(String dBClusterParameterGroupName) The name of a specific DB cluster parameter group to return parameter details for.
DescribeDBClusterParametersRequest	withFilters(Collection<Filter> filters) This parameter is not currently supported.
DescribeDBClusterParametersRequest	withFilters(Filter... filters) This parameter is not currently supported.
DescribeDBClusterParametersRequest	withMarker(String marker) An optional pagination token provided by a previous DescribeDBClusterParameters request.
DescribeDBClusterParametersRequest	withMaxRecords(Integer maxRecords) The maximum number of records to include in the response.
DescribeDBClusterParametersRequest	withSource(String source) A value that indicates to return only parameters for a specific source.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribeDBClusterParametersRequest

public DescribeDBClusterParametersRequest()

Method Detail

getDBClusterParameterGroupName

public String getDBClusterParameterGroupName()

The name of a specific DB cluster parameter group to return parameter 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 cluster parameter group to return parameter 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

setDBClusterParameterGroupName

public void setDBClusterParameterGroupName(String dBClusterParameterGroupName)

The name of a specific DB cluster parameter group to return parameter 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:

dBClusterParameterGroupName - The name of a specific DB cluster parameter group to return parameter 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

withDBClusterParameterGroupName

public DescribeDBClusterParametersRequest withDBClusterParameterGroupName(String dBClusterParameterGroupName)

The name of a specific DB cluster parameter group to return parameter 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:

dBClusterParameterGroupName - The name of a specific DB cluster parameter group to return parameter 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()

A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer.

Returns:

A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer.

setSource

public void setSource(String source)

A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer.

Parameters:

source - A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer.

withSource

public DescribeDBClusterParametersRequest withSource(String source)

A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer.

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

Parameters:

source - A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer.

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

withMarker

public DescribeDBClusterParametersRequest withMarker(String marker)

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