software.amazon.awssdk.services.redshift.model.DescribeClustersRequest Maven / Gradle / Ivy
Show all versions of redshift Show documentation
/*
* Copyright 2014-2019 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 software.amazon.awssdk.services.redshift.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeClustersRequest extends RedshiftRequest implements
ToCopyableBuilder {
private static final SdkField CLUSTER_IDENTIFIER_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(DescribeClustersRequest::clusterIdentifier)).setter(setter(Builder::clusterIdentifier))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ClusterIdentifier").build()).build();
private static final SdkField MAX_RECORDS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.getter(getter(DescribeClustersRequest::maxRecords)).setter(setter(Builder::maxRecords))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxRecords").build()).build();
private static final SdkField MARKER_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(DescribeClustersRequest::marker)).setter(setter(Builder::marker))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Marker").build()).build();
private static final SdkField> TAG_KEYS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.getter(getter(DescribeClustersRequest::tagKeys))
.setter(setter(Builder::tagKeys))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TagKeys").build(),
ListTrait
.builder()
.memberLocationName("TagKey")
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("TagKey").build()).build()).build()).build();
private static final SdkField> TAG_VALUES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.getter(getter(DescribeClustersRequest::tagValues))
.setter(setter(Builder::tagValues))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TagValues").build(),
ListTrait
.builder()
.memberLocationName("TagValue")
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("TagValue").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CLUSTER_IDENTIFIER_FIELD,
MAX_RECORDS_FIELD, MARKER_FIELD, TAG_KEYS_FIELD, TAG_VALUES_FIELD));
private final String clusterIdentifier;
private final Integer maxRecords;
private final String marker;
private final List tagKeys;
private final List tagValues;
private DescribeClustersRequest(BuilderImpl builder) {
super(builder);
this.clusterIdentifier = builder.clusterIdentifier;
this.maxRecords = builder.maxRecords;
this.marker = builder.marker;
this.tagKeys = builder.tagKeys;
this.tagValues = builder.tagValues;
}
/**
*
* 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 clusterIdentifier() {
return 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.
*
*
* @return 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 maxRecords() {
return 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, 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.
*
*
* @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 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.
*/
public String marker() {
return 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.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* @return 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 tagKeys() {
return tagKeys;
}
/**
*
* 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.
*
*
* @return 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 List tagValues() {
return tagValues;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(clusterIdentifier());
hashCode = 31 * hashCode + Objects.hashCode(maxRecords());
hashCode = 31 * hashCode + Objects.hashCode(marker());
hashCode = 31 * hashCode + Objects.hashCode(tagKeys());
hashCode = 31 * hashCode + Objects.hashCode(tagValues());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DescribeClustersRequest)) {
return false;
}
DescribeClustersRequest other = (DescribeClustersRequest) obj;
return Objects.equals(clusterIdentifier(), other.clusterIdentifier()) && Objects.equals(maxRecords(), other.maxRecords())
&& Objects.equals(marker(), other.marker()) && Objects.equals(tagKeys(), other.tagKeys())
&& Objects.equals(tagValues(), other.tagValues());
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*/
@Override
public String toString() {
return ToString.builder("DescribeClustersRequest").add("ClusterIdentifier", clusterIdentifier())
.add("MaxRecords", maxRecords()).add("Marker", marker()).add("TagKeys", tagKeys()).add("TagValues", tagValues())
.build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ClusterIdentifier":
return Optional.ofNullable(clazz.cast(clusterIdentifier()));
case "MaxRecords":
return Optional.ofNullable(clazz.cast(maxRecords()));
case "Marker":
return Optional.ofNullable(clazz.cast(marker()));
case "TagKeys":
return Optional.ofNullable(clazz.cast(tagKeys()));
case "TagValues":
return Optional.ofNullable(clazz.cast(tagValues()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeClustersRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends RedshiftRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* 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.
*/
Builder clusterIdentifier(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.
*
*
* @param 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 Returns a reference to this object so that method calls can be chained together.
*/
Builder maxRecords(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, 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.
*
*
* @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 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder marker(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.
*
*
* @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.
*/
Builder tagKeys(Collection 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.
*
*
* @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.
*/
Builder tagKeys(String... tagKeys);
/**
*
* 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.
*
*
* @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
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tagValues(Collection 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.
*
*
* @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
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tagValues(String... tagValues);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends RedshiftRequest.BuilderImpl implements Builder {
private String clusterIdentifier;
private Integer maxRecords;
private String marker;
private List tagKeys = DefaultSdkAutoConstructList.getInstance();
private List tagValues = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(DescribeClustersRequest model) {
super(model);
clusterIdentifier(model.clusterIdentifier);
maxRecords(model.maxRecords);
marker(model.marker);
tagKeys(model.tagKeys);
tagValues(model.tagValues);
}
public final String getClusterIdentifier() {
return clusterIdentifier;
}
@Override
public final Builder clusterIdentifier(String clusterIdentifier) {
this.clusterIdentifier = clusterIdentifier;
return this;
}
public final void setClusterIdentifier(String clusterIdentifier) {
this.clusterIdentifier = clusterIdentifier;
}
public final Integer getMaxRecords() {
return maxRecords;
}
@Override
public final Builder maxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
return this;
}
public final void setMaxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
}
public final String getMarker() {
return marker;
}
@Override
public final Builder marker(String marker) {
this.marker = marker;
return this;
}
public final void setMarker(String marker) {
this.marker = marker;
}
public final Collection getTagKeys() {
return tagKeys;
}
@Override
public final Builder tagKeys(Collection tagKeys) {
this.tagKeys = TagKeyListCopier.copy(tagKeys);
return this;
}
@Override
@SafeVarargs
public final Builder tagKeys(String... tagKeys) {
tagKeys(Arrays.asList(tagKeys));
return this;
}
public final void setTagKeys(Collection tagKeys) {
this.tagKeys = TagKeyListCopier.copy(tagKeys);
}
public final Collection getTagValues() {
return tagValues;
}
@Override
public final Builder tagValues(Collection tagValues) {
this.tagValues = TagValueListCopier.copy(tagValues);
return this;
}
@Override
@SafeVarargs
public final Builder tagValues(String... tagValues) {
tagValues(Arrays.asList(tagValues));
return this;
}
public final void setTagValues(Collection tagValues) {
this.tagValues = TagValueListCopier.copy(tagValues);
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public DescribeClustersRequest build() {
return new DescribeClustersRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}