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

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 marker returned by a previous DescribeClusters request to indicate the first cluster that the current DescribeClusters request will return.
Integer	getMaxRecords() The maximum number of records that the response can include.
int	hashCode()
void	setClusterIdentifier(String clusterIdentifier) The unique identifier of a cluster whose properties you are requesting.
void	setMarker(String marker) An optional marker returned by a previous DescribeClusters request to indicate the first cluster that the current DescribeClusters request will return.
void	setMaxRecords(Integer maxRecords) The maximum number of records that the response can include.
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 marker returned by a previous DescribeClusters request to indicate the first cluster that the current DescribeClusters request will return.
DescribeClustersRequest	withMaxRecords(Integer maxRecords) The maximum number of records that the response can include.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

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 isn't 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 isn't 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 isn't 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 isn't 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 isn't 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 isn't 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 records that the response can include. If more records exist than the specified MaxRecords value, a marker is included in the response that can be used in a new DescribeClusters request to continue listing results.

Default: 100

Constraints: Value must be at least 20 and no more than 100.

Returns:

The maximum number of records that the response can include. If more records exist than the specified MaxRecords value, a marker is included in the response that can be used in a new DescribeClusters request to continue listing results.

Default: 100

Constraints: Value must be at least 20 and no more than 100.

setMaxRecords

public void setMaxRecords(Integer maxRecords)

The maximum number of records that the response can include. If more records exist than the specified MaxRecords value, a marker is included in the response that can be used in a new DescribeClusters request to continue listing results.

Default: 100

Constraints: Value must be at least 20 and no more than 100.

Parameters:

maxRecords - The maximum number of records that the response can include. If more records exist than the specified MaxRecords value, a marker is included in the response that can be used in a new DescribeClusters request to continue listing results.

Default: 100

Constraints: Value must be at least 20 and no more than 100.

withMaxRecords

public DescribeClustersRequest withMaxRecords(Integer maxRecords)

The maximum number of records that the response can include. If more records exist than the specified MaxRecords value, a marker is included in the response that can be used in a new DescribeClusters request to continue listing results.

Default: 100

Constraints: Value must be at least 20 and no more than 100.

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

Parameters:

maxRecords - The maximum number of records that the response can include. If more records exist than the specified MaxRecords value, a marker is included in the response that can be used in a new DescribeClusters request to continue listing results.

Default: 100

Constraints: Value must be at least 20 and no more than 100.

Returns:

A reference to this updated object so that method calls can be chained together.

getMarker

public String getMarker()

An optional marker returned by a previous DescribeClusters request to indicate the first cluster that the current DescribeClusters request will return.

You can specify either a Marker parameter or a ClusterIdentifier parameter in a DescribeClusters request, but not both.

Returns:

An optional marker returned by a previous DescribeClusters request to indicate the first cluster that the current DescribeClusters request will return.

You can specify either a Marker parameter or a ClusterIdentifier parameter in a DescribeClusters request, but not both.

setMarker

public void setMarker(String marker)

An optional marker returned by a previous DescribeClusters request to indicate the first cluster that the current DescribeClusters request will return.

You can specify either a Marker parameter or a ClusterIdentifier parameter in a DescribeClusters request, but not both.

Parameters:

marker - An optional marker returned by a previous DescribeClusters request to indicate the first cluster that the current DescribeClusters request will return.

You can specify either a Marker parameter or a ClusterIdentifier parameter in a DescribeClusters request, but not both.

withMarker

public DescribeClustersRequest withMarker(String marker)

An optional marker returned by a previous DescribeClusters request to indicate the first cluster that the current DescribeClusters request will return.

You can specify either a Marker parameter or a ClusterIdentifier parameter in a DescribeClusters request, but not both.

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

Parameters:

marker - An optional marker returned by a previous DescribeClusters request to indicate the first cluster that the current DescribeClusters request will return.

You can specify either a Marker parameter or a ClusterIdentifier parameter in a DescribeClusters request, 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