@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) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasTagKeys()
For responses, this returns true if the service returned a value for the TagKeys property.
|
boolean |
hasTagValues()
For responses, this returns true if the service returned a value for the TagValues property.
|
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.
|
List<SdkField<?>> |
sdkFields() |
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() |
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final 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 final 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 final 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.
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 final boolean hasTagKeys()
isEmpty() method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final 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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTagKeys() method.
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 final boolean hasTagValues()
isEmpty() method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final 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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTagValues() method.
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()
toBuilder in interface ToCopyableBuilder<DescribeClustersRequest.Builder,DescribeClustersRequest>toBuilder in class RedshiftRequestpublic static DescribeClustersRequest.Builder builder()
public static Class<? extends DescribeClustersRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2023. All rights reserved.