Package software.amazon.awssdk.services.redshift.model

Class DescribeClusterParameterGroupsRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.redshift.model.DescribeClusterParameterGroupsRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<DescribeClusterParameterGroupsRequest.Builder,DescribeClusterParameterGroupsRequest>

@Generated("software.amazon.awssdk:codegen")
public class DescribeClusterParameterGroupsRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<DescribeClusterParameterGroupsRequest.Builder,DescribeClusterParameterGroupsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeClusterParameterGroupsRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static DescribeClusterParameterGroupsRequest.Builder	builder()
boolean	equals(Object obj)
int	hashCode()
String	marker()	An optional parameter that specifies the starting point to return a set of response records.
Integer	maxRecords()	The maximum number of response records to return in each call.
String	parameterGroupName()	The name of a specific parameter group for which to return details.
static Class<? extends DescribeClusterParameterGroupsRequest.Builder>	serializableBuilderClass()
List<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.
List<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.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

parameterGroupName

public 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:

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.

maxRecords

public 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:

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.

marker

public 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:

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.

tagKeys

public List<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 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.

tagValues

public List<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 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.

toBuilder

public DescribeClusterParameterGroupsRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeClusterParameterGroupsRequest.Builder,DescribeClusterParameterGroupsRequest>

Returns:

a builder for type T

builder

public static DescribeClusterParameterGroupsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeClusterParameterGroupsRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object