/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.redshift.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** *
* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class DescribeClustersRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** ** 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. *
*/ private String clusterIdentifier; /** *
* 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. *
*/ private Integer maxRecords; /** *
* 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. *
*/ private String marker; /** *
* 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.
*
* 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.
*
* 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. *
* * @param 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 setClusterIdentifier(String clusterIdentifier) { this.clusterIdentifier = 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. *
* * @return 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() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeClustersRequest withClusterIdentifier(String clusterIdentifier) { setClusterIdentifier(clusterIdentifier); return this; } /** *
* 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. *
* * @param 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 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 setMaxRecords(Integer maxRecords) { this.maxRecords = 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. *
* * @return 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 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() { return this.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. *
* * @param 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 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. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeClustersRequest withMaxRecords(Integer maxRecords) { setMaxRecords(maxRecords); return this; } /** *
* 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. *
* * @param 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 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 void setMarker(String marker) { this.marker = 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. *
* * @return 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 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() { return this.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. *
* * @param 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 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. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeClustersRequest withMarker(String marker) { setMarker(marker); return this; } /** *
* 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 java.util.List
* 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(java.util.Collection
* 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 * {@link #setTagKeys(java.util.Collection)} or {@link #withTagKeys(java.util.Collection)} if you want to override * the existing values. *
* * @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeClustersRequest withTagKeys(String... tagKeys) {
if (this.tagKeys == null) {
setTagKeys(new com.amazonaws.internal.SdkInternalList
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeClustersRequest withTagKeys(java.util.Collection
* 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 java.util.List
* 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(java.util.Collection
* 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 * {@link #setTagValues(java.util.Collection)} or {@link #withTagValues(java.util.Collection)} if you want to * override the existing values. *
* * @param 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
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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeClustersRequest withTagValues(String... tagValues) {
if (this.tagValues == null) {
setTagValues(new com.amazonaws.internal.SdkInternalList
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeClustersRequest withTagValues(java.util.Collection