com.amazonaws.services.redshift.model

Class DescribeClusterParametersRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.redshift.model.DescribeClusterParametersRequest

All Implemented Interfaces:

Serializable

public class DescribeClusterParametersRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the DescribeClusterParameters operation.

Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group. For each parameter the response includes information such as parameter name, description, data type, value, whether the parameter value is modifiable, and so on.

You can specify source filter to retrieve parameters of only specific type. For example, to retrieve parameters that were modified by a user action such as from ModifyClusterParameterGroup, you can specify source equal to user .

For more information about managing parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Management Guide .

See Also:

AmazonRedshift.describeClusterParameters(DescribeClusterParametersRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
DescribeClusterParametersRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getMarker() An optional marker returned from a previous DescribeClusterParameters request.
Integer	getMaxRecords() The maximum number of records to include in the response.
String	getParameterGroupName() The name of a cluster parameter group for which to return details.
String	getSource() The parameter types to return.
int	hashCode()
void	setMarker(String marker) An optional marker returned from a previous DescribeClusterParameters request.
void	setMaxRecords(Integer maxRecords) The maximum number of records to include in the response.
void	setParameterGroupName(String parameterGroupName) The name of a cluster parameter group for which to return details.
void	setSource(String source) The parameter types to return.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeClusterParametersRequest	withMarker(String marker) An optional marker returned from a previous DescribeClusterParameters request.
DescribeClusterParametersRequest	withMaxRecords(Integer maxRecords) The maximum number of records to include in the response.
DescribeClusterParametersRequest	withParameterGroupName(String parameterGroupName) The name of a cluster parameter group for which to return details.
DescribeClusterParametersRequest	withSource(String source) The parameter types to return.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribeClusterParametersRequest

public DescribeClusterParametersRequest()

Method Detail

getParameterGroupName

public String getParameterGroupName()

The name of a cluster parameter group for which to return details.

Returns:

The name of a cluster parameter group for which to return details.

setParameterGroupName

public void setParameterGroupName(String parameterGroupName)

The name of a cluster parameter group for which to return details.

Parameters:

parameterGroupName - The name of a cluster parameter group for which to return details.

withParameterGroupName

public DescribeClusterParametersRequest withParameterGroupName(String parameterGroupName)

The name of a cluster parameter group for which to return details.

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

Parameters:

parameterGroupName - The name of a cluster parameter group for which to return details.

Returns:

A reference to this updated object so that method calls can be chained together.

getSource

public String getSource()

The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group.

Default: All parameter types returned.

Valid Values: user | engine-default

Returns:

The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group.

Default: All parameter types returned.

Valid Values: user | engine-default

setSource

public void setSource(String source)

The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group.

Default: All parameter types returned.

Valid Values: user | engine-default

Parameters:

source - The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group.

Default: All parameter types returned.

Valid Values: user | engine-default

withSource

public DescribeClusterParametersRequest withSource(String source)

The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group.

Default: All parameter types returned.

Valid Values: user | engine-default

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

Parameters:

source - The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group.

Default: All parameter types returned.

Valid Values: user | engine-default

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, response includes a marker that you can specify in your subsequent request to retrieve remaining result.

Default: 100

Constraints: Value must be at least 20 and no more than 100.

Returns:

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, response includes a marker that you can specify in your subsequent request to retrieve remaining result.

Default: 100

Constraints: Value must be at least 20 and no more than 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, response includes a marker that you can specify in your subsequent request to retrieve remaining result.

Default: 100

Constraints: Value must be at least 20 and no more than 100.

Parameters:

maxRecords - The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, response includes a marker that you can specify in your subsequent request to retrieve remaining result.

Default: 100

Constraints: Value must be at least 20 and no more than 100.

withMaxRecords

public DescribeClusterParametersRequest withMaxRecords(Integer maxRecords)

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, response includes a marker that you can specify in your subsequent request to retrieve remaining result.

Default: 100

Constraints: Value must be at least 20 and no more than 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, response includes a marker that you can specify in your subsequent request to retrieve remaining result.

Default: 100

Constraints: Value must be at least 20 and no more than 100.

Returns:

A reference to this updated object so that method calls can be chained together.

getMarker

public String getMarker()

An optional marker returned from a previous DescribeClusterParameters request. If this parameter is specified, the response includes only records beyond the specified marker, up to the value specified by MaxRecords.

Returns:

An optional marker returned from a previous DescribeClusterParameters request. If this parameter is specified, the response includes only records beyond the specified marker, up to the value specified by MaxRecords.

setMarker

public void setMarker(String marker)

An optional marker returned from a previous DescribeClusterParameters request. If this parameter is specified, the response includes only records beyond the specified marker, up to the value specified by MaxRecords.

Parameters:

marker - An optional marker returned from a previous DescribeClusterParameters request. If this parameter is specified, the response includes only records beyond the specified marker, up to the value specified by MaxRecords.

withMarker

public DescribeClusterParametersRequest withMarker(String marker)

An optional marker returned from a previous DescribeClusterParameters request. If this parameter is specified, the response includes only records beyond the specified 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 marker returned from a previous DescribeClusterParameters request. If this parameter is specified, the response includes only records beyond the specified 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