Class DescribeClustersRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.redshift.model.DescribeClustersRequest
All Implemented Interfaces:
ReadLimitInfo, Serializable, Cloneable

public class DescribeClustersRequest extends AmazonWebServiceRequest implements Serializable, Cloneable

See Also:
  • Constructor Details

    • DescribeClustersRequest

      public DescribeClustersRequest()
  • Method Details

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

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

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

      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:
      Returns a reference to this object so that method calls can be chained together.
    • 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.

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

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

      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:
      Returns a reference to this object so that method calls can be chained together.
    • 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.

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

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

      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:
      Returns a reference to this 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 clusters that are associated with the specified key or keys. For example, suppose that you have clusters 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 clusters 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 clusters that are associated with the specified key or keys. For example, suppose that you have clusters 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 clusters 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 clusters that are associated with the specified key or keys. For example, suppose that you have clusters 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 clusters 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 clusters that are associated with the specified key or keys. For example, suppose that you have clusters 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 clusters that have either or both of these tag keys associated with them.
    • withTagKeys

      public DescribeClustersRequest withTagKeys(String... tagKeys)

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

      NOTE: This method appends the values to the existing list (if any). Use setTagKeys(java.util.Collection) or withTagKeys(java.util.Collection) if you want to override the existing values.

      Parameters:
      tagKeys - A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters 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 clusters that have either or both of these tag keys associated with them.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • withTagKeys

      public DescribeClustersRequest withTagKeys(Collection<String> tagKeys)

      A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters 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 clusters 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 clusters that are associated with the specified key or keys. For example, suppose that you have clusters 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 clusters that have either or both of these tag keys associated with them.
      Returns:
      Returns a reference to this 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 clusters that are associated with the specified tag value or values. For example, suppose that you have clusters 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 clusters 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 clusters that are associated with the specified tag value or values. For example, suppose that you have clusters 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 clusters 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 clusters that are associated with the specified tag value or values. For example, suppose that you have clusters 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 clusters 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 clusters that are associated with the specified tag value or values. For example, suppose that you have clusters 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 clusters that have either or both of these tag values associated with them.
    • withTagValues

      public DescribeClustersRequest withTagValues(String... tagValues)

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

      NOTE: This method appends the values to the existing list (if any). Use setTagValues(java.util.Collection) or withTagValues(java.util.Collection) if you want to override the existing values.

      Parameters:
      tagValues - A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters 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 clusters that have either or both of these tag values associated with them.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • withTagValues

      public DescribeClustersRequest withTagValues(Collection<String> tagValues)

      A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters 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 clusters 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 clusters that are associated with the specified tag value or values. For example, suppose that you have clusters 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 clusters that have either or both of these tag values associated with them.
      Returns:
      Returns a reference to this 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:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public DescribeClustersRequest clone()
      Description copied from class: AmazonWebServiceRequest
      Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.
      Overrides:
      clone in class AmazonWebServiceRequest
      See Also: