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

Class DescribeClusterParameterGroupsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.redshift.model.RedshiftRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeClusterParameterGroupsRequest.Builder,DescribeClusterParameterGroupsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeClusterParameterGroupsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeClusterParameterGroupsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTagKeys()	For responses, this returns true if the service returned a value for the TagKeys property.
boolean	hasTagValues()	For responses, this returns true if the service returned a value for the TagValues property.
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.
List<SdkField<?>>	sdkFields()
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()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

parameterGroupName

public final 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 final 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 final 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, Amazon Web Services 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, Amazon Web Services 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.

hasTagKeys

public final boolean hasTagKeys()

For responses, this returns true if the service returned a value for the TagKeys property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tagKeys

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTagKeys() method.

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.

hasTagValues

public final boolean hasTagValues()

For responses, this returns true if the service returned a value for the TagValues property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tagValues

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTagValues() method.

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()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeClusterParameterGroupsRequest.Builder,DescribeClusterParameterGroupsRequest>

Specified by:

toBuilder in class RedshiftRequest

builder

public static DescribeClusterParameterGroupsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo