public class DescribeClusterParameterGroupsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
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 parameters and 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.
NOOP| Constructor and Description |
|---|
DescribeClusterParameterGroupsRequest() |
| Modifier and Type | Method and Description |
|---|---|
DescribeClusterParameterGroupsRequest |
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 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.
|
getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeoutpublic DescribeClusterParameterGroupsRequest()
public String getParameterGroupName()
public void setParameterGroupName(String parameterGroupName)
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.public DescribeClusterParameterGroupsRequest withParameterGroupName(String parameterGroupName)
Returns a reference to this object so that method calls can be chained together.
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.public Integer getMaxRecords()
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.
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.
public void setMaxRecords(Integer maxRecords)
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.
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.
public DescribeClusterParameterGroupsRequest withMaxRecords(Integer maxRecords)
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.
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.
public String getMarker()
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.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.public void setMarker(String marker)
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.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.public DescribeClusterParameterGroupsRequest withMarker(String marker)
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.
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.public List<String> getTagKeys()
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.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.public void setTagKeys(Collection<String> tagKeys)
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.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.public DescribeClusterParameterGroupsRequest withTagKeys(String... tagKeys)
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.
NOTE: This method appends the values to the existing list (if
any). Use setTagKeys(java.util.Collection) or withTagKeys(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.
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.public DescribeClusterParameterGroupsRequest withTagKeys(Collection<String> tagKeys)
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.
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.public List<String> getTagValues()
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.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.public void setTagValues(Collection<String> tagValues)
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.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.public DescribeClusterParameterGroupsRequest withTagValues(String... tagValues)
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.
NOTE: This method appends the values to the existing list (if
any). Use setTagValues(java.util.Collection) or withTagValues(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.
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.public DescribeClusterParameterGroupsRequest withTagValues(Collection<String> tagValues)
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.
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.public String toString()
toString in class ObjectObject.toString()public DescribeClusterParameterGroupsRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.