Interface DescribeClustersRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<DescribeClustersRequest.Builder,
,DescribeClustersRequest> RedshiftRequest.Builder
,SdkBuilder<DescribeClustersRequest.Builder,
,DescribeClustersRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
DescribeClustersRequest
-
Method Summary
Modifier and TypeMethodDescriptionclusterIdentifier
(String clusterIdentifier) 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.maxRecords
(Integer maxRecords) The maximum number of response records to return in each call.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys.tagKeys
(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.A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values.tagValues
(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 interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.redshift.model.RedshiftRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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.
-
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 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.
-
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 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
, Amazon Web Services 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.
-
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
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.
-
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
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.
-
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
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.
-
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
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.
-
overrideConfiguration
DescribeClustersRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
DescribeClustersRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-