DescribeClusterParameterGroupsRequest (AWS Java SDK for Amazon Redshift 1.9.21 API)

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

All Implemented Interfaces:

Serializable
```
public class DescribeClusterParameterGroupsRequest
extends AmazonWebServiceRequest
implements Serializable
```
Container for the parameters to the DescribeClusterParameterGroups operation.
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group.

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

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all parameter groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all parameter groups that have any combination of those values are returned.

If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them.

See Also:
AmazonRedshift.describeClusterParameterGroups(DescribeClusterParameterGroupsRequest), Serialized Form

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

Constructor Summary

Constructors
Constructor and Description

DescribeClusterParameterGroupsRequest()

Constructors
Constructor and Description
`DescribeClusterParameterGroupsRequest()`

Method Summary

Methods
Modifier and Type	Method and Description
`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 specific parameter group for which to return details.
`List<String>`	`getTagKeys()` A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the specified key or keys.
`List<String>`	`getTagValues()` A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values.
`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 specific parameter group for which to return details.
`void`	`setTagKeys(Collection<String> tagKeys)` A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the specified key or keys.
`void`	`setTagValues(Collection<String> tagValues)` A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`DescribeClusterParameterGroupsRequest`	`withMarker(String marker)` An optional parameter that specifies the starting point to return a set of response records.
`DescribeClusterParameterGroupsRequest`	`withMaxRecords(Integer maxRecords)` The maximum number of response records to return in each call.
`DescribeClusterParameterGroupsRequest`	`withParameterGroupName(String parameterGroupName)` The name of a specific parameter group for which to return details.
`DescribeClusterParameterGroupsRequest`	`withTagKeys(Collection<String> tagKeys)` A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the specified key or keys.
`DescribeClusterParameterGroupsRequest`	`withTagKeys(String... tagKeys)` A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the specified key or keys.
`DescribeClusterParameterGroupsRequest`	`withTagValues(Collection<String> tagValues)` A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values.
`DescribeClusterParameterGroupsRequest`	`withTagValues(String... tagValues)` A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

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

- Constructor Detail
  - DescribeClusterParameterGroupsRequest
```
public DescribeClusterParameterGroupsRequest()
```
- Method Detail
  - getParameterGroupName
```
public String getParameterGroupName()
```
    The name of a specific parameter group for which to return details. By default, details about all parameter groups and the default parameter group are returned.
    
    Returns:
    The name of a specific parameter group for which to return details. By default, details about all parameter groups and the default parameter group are returned.
  - setParameterGroupName
```
public void setParameterGroupName(String parameterGroupName)
```
    The name of a specific parameter group for which to return details. By default, details about all parameter groups and the default parameter group are returned.
    
    Parameters:
    parameterGroupName - The name of a specific parameter group for which to return details. By default, details about all parameter groups and the default parameter group are returned.
  - withParameterGroupName
```
public DescribeClusterParameterGroupsRequest withParameterGroupName(String parameterGroupName)
```
    The name of a specific parameter group for which to return details. By default, details about all parameter groups and the default parameter group are returned.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    parameterGroupName - The name of a specific parameter group for which to return details. By default, details about all parameter groups and the default parameter group are returned.
    
    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 DescribeClusterParameterGroupsRequest 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 DescribeClusterParameterGroups 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 DescribeClusterParameterGroups 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 DescribeClusterParameterGroups 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 DescribeClusterParameterGroups 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 DescribeClusterParameterGroupsRequest withMarker(String marker)
```
    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups 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 DescribeClusterParameterGroups 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.
  - getTagKeys
```
public List<String> getTagKeys()
```
    A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag keys associated with them.
    
    Returns:
    A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag keys associated with them.
  - setTagKeys
```
public void setTagKeys(Collection<String> tagKeys)
```
    A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag keys associated with them.
    
    Parameters:
    tagKeys - A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag keys associated with them.
  - withTagKeys
```
public DescribeClusterParameterGroupsRequest withTagKeys(String... tagKeys)
```
    A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag keys associated with them.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    tagKeys - A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag keys associated with them.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withTagKeys
```
public DescribeClusterParameterGroupsRequest withTagKeys(Collection<String> tagKeys)
```
    A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag keys associated with them.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    tagKeys - A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag keys associated with them.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getTagValues
```
public List<String> getTagValues()
```
    A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag values associated with them.
    
    Returns:
    A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag values associated with them.
  - setTagValues
```
public void setTagValues(Collection<String> tagValues)
```
    A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag values associated with them.
    
    Parameters:
    tagValues - A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag values associated with them.
  - withTagValues
```
public DescribeClusterParameterGroupsRequest withTagValues(String... tagValues)
```
    A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag values associated with them.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    tagValues - A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag values associated with them.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withTagValues
```
public DescribeClusterParameterGroupsRequest withTagValues(Collection<String> tagValues)
```
    A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag values associated with them.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    tagValues - A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag values associated with them.
    
    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

Class DescribeClusterParameterGroupsRequest

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

DescribeClusterParameterGroupsRequest

Method Detail

getParameterGroupName

setParameterGroupName

withParameterGroupName

getMaxRecords

setMaxRecords

withMaxRecords

getMarker

setMarker

withMarker

getTagKeys

setTagKeys

withTagKeys

withTagKeys

getTagValues

setTagValues

withTagValues

withTagValues

toString

hashCode

equals