DescribeClusterParametersRequest (AWS SDK For Java for OSGi 1.10.21 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.redshift.model.DescribeClusterParametersRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable
```
public class DescribeClusterParametersRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable
```
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 parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide .

See Also:
AmazonRedshift.describeClusterParameters(DescribeClusterParametersRequest), Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

DescribeClusterParametersRequest()

Constructors
Constructor and Description
`DescribeClusterParametersRequest()`

Method Summary

Methods
Modifier and Type	Method and Description
`DescribeClusterParametersRequest`	`clone()` Creates a shallow clone of this request.
`boolean`	`equals(Object obj)`
`String`	`getMarker()` An optional parameter that specifies the starting point to return a set of response records.
`Integer`	`getMaxRecords()` The maximum number of response records to return in each call.
`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 parameter that specifies the starting point to return a set of response records.
`void`	`setMaxRecords(Integer maxRecords)` The maximum number of response records to return in each call.
`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 parameter that specifies the starting point to return a set of response records.
`DescribeClusterParametersRequest`	`withMaxRecords(Integer maxRecords)` The maximum number of response records to return in each call.
`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
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
  - 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 response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
    Default: 100
    Constraints: minimum 20, maximum 100.
    
    Returns:
    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
    Default: 100
    Constraints: minimum 20, maximum 100.
  - setMaxRecords
```
public void setMaxRecords(Integer maxRecords)
```
    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
    Default: 100
    Constraints: minimum 20, maximum 100.
    
    Parameters:
    maxRecords - The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
    Default: 100
    Constraints: minimum 20, maximum 100.
  - withMaxRecords
```
public DescribeClusterParametersRequest withMaxRecords(Integer maxRecords)
```
    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
    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 response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
    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 parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
    
    Returns:
    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
  - setMarker
```
public void setMarker(String marker)
```
    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
    
    Parameters:
    marker - An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
  - withMarker
```
public DescribeClusterParametersRequest withMarker(String marker)
```
    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    marker - An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
    
    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 DescribeClusterParametersRequest 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()

Class DescribeClusterParametersRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

DescribeClusterParametersRequest

Method Detail

getParameterGroupName

setParameterGroupName

withParameterGroupName

getSource

setSource

withSource

getMaxRecords

setMaxRecords

withMaxRecords

getMarker

setMarker

withMarker

toString

hashCode

equals

clone