@Generated(value="software.amazon.awssdk:codegen") public final class DescribeClustersRequest extends RedshiftRequest implements ToCopyableBuilder<DescribeClustersRequest.Builder,DescribeClustersRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
DescribeClustersRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static DescribeClustersRequest.Builder |
builder() |
String |
clusterIdentifier()
The unique identifier of a cluster whose properties you are requesting.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
String |
marker()
An optional parameter that specifies the starting point to return a set of response records.
|
Integer |
maxRecords()
The maximum number of response records to return in each call.
|
static Class<? extends DescribeClustersRequest.Builder> |
serializableBuilderClass() |
List<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.
|
List<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.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
overrideConfiguration
copy
public 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.
The default is that all clusters defined for an account are returned.
public 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
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 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.
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.
public List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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> 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DescribeClustersRequest.Builder,DescribeClustersRequest>
toBuilder
in class RedshiftRequest
public static DescribeClustersRequest.Builder builder()
public static Class<? extends DescribeClustersRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.