@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DescribeClustersRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
DescribeClustersRequest() |
Modifier and Type | Method and Description |
---|---|
DescribeClustersRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
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.
|
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.
|
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.
|
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.
|
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.
|
String |
toString()
Returns a string representation of this object.
|
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.
|
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.
|
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.
|
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.
|
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.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
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.
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.
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.
The default is that all clusters defined for an account are returned.
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.
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.
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.
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.
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.
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.
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.
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.
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
, Amazon Web Services
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.
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
, Amazon
Web Services 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.
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
, Amazon Web Services
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.
MaxRecords
,
Amazon Web Services 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.
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
, Amazon Web Services
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.
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
, Amazon
Web Services 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.
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.
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.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.
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.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.
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.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.
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.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.
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.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.
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.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.
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.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.
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.public String toString()
toString
in class Object
Object.toString()
public DescribeClustersRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()