Class DescribeClustersRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
The unique identifier of a cluster whose properties you are requesting.An optional parameter that specifies the starting point to return a set of response records.The maximum number of response records to return in each call.A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys.A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values.int
hashCode()
void
setClusterIdentifier
(String clusterIdentifier) The unique identifier of a cluster whose properties you are requesting.void
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 clusters 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 clusters that are associated with the specified tag value or values.toString()
Returns a string representation of this object; useful for testing and debugging.withClusterIdentifier
(String clusterIdentifier) The unique identifier of a cluster whose properties you are requesting.withMarker
(String marker) An optional parameter that specifies the starting point to return a set of response records.withMaxRecords
(Integer maxRecords) The maximum number of response records to return in each call.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.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.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.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.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
DescribeClustersRequest
public DescribeClustersRequest()
-
-
Method Details
-
setClusterIdentifier
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
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
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
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 amarker
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 specifiedMaxRecords
value, a value is returned in amarker
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
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 amarker
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 amarker
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
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 amarker
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 specifiedMaxRecords
value, a value is returned in amarker
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
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 theMarker
field of the response. You can retrieve the next set of response records by providing the returned marker value in theMarker
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 inMaxRecords
, AWS returns a value in theMarker
field of the response. You can retrieve the next set of response records by providing the returned marker value in theMarker
parameter and retrying the request.Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.
-
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 theMarker
field of the response. You can retrieve the next set of response records by providing the returned marker value in theMarker
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 theMarker
field of the response. You can retrieve the next set of response records by providing the returned marker value in theMarker
parameter and retrying the request.Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.
-
withMarker
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 theMarker
field of the response. You can retrieve the next set of response records by providing the returned marker value in theMarker
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 inMaxRecords
, AWS returns a value in theMarker
field of the response. You can retrieve the next set of response records by providing the returned marker value in theMarker
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
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
andenvironment
. 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
andenvironment
. 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
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
andenvironment
. 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 calledowner
andenvironment
. 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
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
andenvironment
. 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)
orwithTagKeys(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 calledowner
andenvironment
. 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
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
andenvironment
. 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 calledowner
andenvironment
. 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
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
andtest
. 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
andtest
. 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
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
andtest
. 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 calledadmin
andtest
. 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
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
andtest
. 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)
orwithTagValues(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 calledadmin
andtest
. 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
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
andtest
. 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 calledadmin
andtest
. 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
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
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 classAmazonWebServiceRequest
- See Also:
-