com.amazonaws.services.redshift.model

Class DescribeClustersRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.redshift.model.DescribeClustersRequest

All Implemented Interfaces:

Serializable

public class DescribeClustersRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the DescribeClusters operation.

Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Management Guide .

See Also:

AmazonRedshift.describeClusters(DescribeClustersRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeClustersRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getClusterIdentifier() The unique identifier of a cluster whose properties you are requesting.
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.
int	hashCode()
void	setClusterIdentifier(String clusterIdentifier) The unique identifier of a cluster whose properties you are requesting.
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.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeClustersRequest	withClusterIdentifier(String clusterIdentifier) The unique identifier of a cluster whose properties you are requesting.
DescribeClustersRequest	withMarker(String marker) An optional parameter that specifies the starting point to return a set of response records.
DescribeClustersRequest	withMaxRecords(Integer maxRecords) The maximum number of response records to return in each call.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

DescribeClustersRequest

public DescribeClustersRequest()

Method Detail

getClusterIdentifier

public String getClusterIdentifier()

The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive.

The default is that all clusters defined for an account are returned.

Returns:

The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive.

The default is that all clusters defined for an account are returned.

setClusterIdentifier

public void setClusterIdentifier(String clusterIdentifier)

The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive.

The default is that all clusters defined for an account are returned.

Parameters:

clusterIdentifier - The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive.

The default is that all clusters defined for an account are returned.

withClusterIdentifier

public DescribeClustersRequest withClusterIdentifier(String clusterIdentifier)

The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive.

The default is that all clusters defined for an account are returned.

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

Parameters:

clusterIdentifier - The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive.

The default is that all clusters defined for an account 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 DescribeClustersRequest 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 DescribeClusters 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.

Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.

Returns:

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusters 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.

Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.

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 DescribeClusters 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.

Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.

Parameters:

marker - An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusters 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.

Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.

withMarker

public DescribeClustersRequest withMarker(String marker)

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusters 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.

Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.

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 DescribeClusters 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.

Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.

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