com.amazonaws.services.redshift.model

Class DescribeClusterSubnetGroupsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.redshift.model.DescribeClusterSubnetGroupsRequest

All Implemented Interfaces:

Serializable

public class DescribeClusterSubnetGroupsRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the DescribeClusterSubnetGroups operation.

Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in you AWS account.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet 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 subnet groups that have any combination of those values are returned.

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

See Also:

AmazonRedshift.describeClusterSubnetGroups(DescribeClusterSubnetGroupsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeClusterSubnetGroupsRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getClusterSubnetGroupName() The name of the cluster subnet group for which information is requested.
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.
List<String>	getTagKeys() A tag key or keys for which you want to return all matching cluster subnet 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 subnet groups that are associated with the specified tag value or values.
int	hashCode()
void	setClusterSubnetGroupName(String clusterSubnetGroupName) The name of the cluster subnet group for which information is requested.
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	setTagKeys(Collection<String> tagKeys) A tag key or keys for which you want to return all matching cluster subnet 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 subnet 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.
DescribeClusterSubnetGroupsRequest	withClusterSubnetGroupName(String clusterSubnetGroupName) The name of the cluster subnet group for which information is requested.
DescribeClusterSubnetGroupsRequest	withMarker(String marker) An optional parameter that specifies the starting point to return a set of response records.
DescribeClusterSubnetGroupsRequest	withMaxRecords(Integer maxRecords) The maximum number of response records to return in each call.
DescribeClusterSubnetGroupsRequest	withTagKeys(Collection<String> tagKeys) A tag key or keys for which you want to return all matching cluster subnet groups that are associated with the specified key or keys.
DescribeClusterSubnetGroupsRequest	withTagKeys(String... tagKeys) A tag key or keys for which you want to return all matching cluster subnet groups that are associated with the specified key or keys.
DescribeClusterSubnetGroupsRequest	withTagValues(Collection<String> tagValues) A tag value or values for which you want to return all matching cluster subnet groups that are associated with the specified tag value or values.
DescribeClusterSubnetGroupsRequest	withTagValues(String... tagValues) A tag value or values for which you want to return all matching cluster subnet 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

DescribeClusterSubnetGroupsRequest

public DescribeClusterSubnetGroupsRequest()

Method Detail

getClusterSubnetGroupName

public String getClusterSubnetGroupName()

The name of the cluster subnet group for which information is requested.

Returns:

The name of the cluster subnet group for which information is requested.

setClusterSubnetGroupName

public void setClusterSubnetGroupName(String clusterSubnetGroupName)

The name of the cluster subnet group for which information is requested.

Parameters:

clusterSubnetGroupName - The name of the cluster subnet group for which information is requested.

withClusterSubnetGroupName

public DescribeClusterSubnetGroupsRequest withClusterSubnetGroupName(String clusterSubnetGroupName)

The name of the cluster subnet group for which information is requested.

Returns a reference to this object so that method calls can be chained together.

Parameters:

clusterSubnetGroupName - The name of the cluster subnet group for which information is requested.

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 DescribeClusterSubnetGroupsRequest 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 DescribeClusterSubnetGroups 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 DescribeClusterSubnetGroups 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 DescribeClusterSubnetGroups 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 DescribeClusterSubnetGroups 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 DescribeClusterSubnetGroupsRequest withMarker(String marker)

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSubnetGroups 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 DescribeClusterSubnetGroups 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 subnet groups that are associated with the specified key or keys. For example, suppose that you have subnet 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 subnet 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 subnet groups that are associated with the specified key or keys. For example, suppose that you have subnet 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 subnet 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 subnet groups that are associated with the specified key or keys. For example, suppose that you have subnet 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 subnet 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 subnet groups that are associated with the specified key or keys. For example, suppose that you have subnet 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 subnet groups that have either or both of these tag keys associated with them.

withTagKeys

public DescribeClusterSubnetGroupsRequest withTagKeys(String... tagKeys)

A tag key or keys for which you want to return all matching cluster subnet groups that are associated with the specified key or keys. For example, suppose that you have subnet 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 subnet 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 subnet groups that are associated with the specified key or keys. For example, suppose that you have subnet 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 subnet 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 DescribeClusterSubnetGroupsRequest withTagKeys(Collection<String> tagKeys)

A tag key or keys for which you want to return all matching cluster subnet groups that are associated with the specified key or keys. For example, suppose that you have subnet 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 subnet 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 subnet groups that are associated with the specified key or keys. For example, suppose that you have subnet 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 subnet 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 subnet groups that are associated with the specified tag value or values. For example, suppose that you have subnet 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 subnet 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 subnet groups that are associated with the specified tag value or values. For example, suppose that you have subnet 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 subnet 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 subnet groups that are associated with the specified tag value or values. For example, suppose that you have subnet 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 subnet 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 subnet groups that are associated with the specified tag value or values. For example, suppose that you have subnet 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 subnet groups that have either or both of these tag values associated with them.

withTagValues

public DescribeClusterSubnetGroupsRequest withTagValues(String... tagValues)

A tag value or values for which you want to return all matching cluster subnet groups that are associated with the specified tag value or values. For example, suppose that you have subnet 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 subnet 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 subnet groups that are associated with the specified tag value or values. For example, suppose that you have subnet 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 subnet 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 DescribeClusterSubnetGroupsRequest withTagValues(Collection<String> tagValues)

A tag value or values for which you want to return all matching cluster subnet groups that are associated with the specified tag value or values. For example, suppose that you have subnet 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 subnet 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 subnet groups that are associated with the specified tag value or values. For example, suppose that you have subnet 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 subnet 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