software.amazon.awssdk.services.redshift.model.DescribeClusterParametersRequest Maven / Gradle / Ivy
Show all versions of redshift Show documentation
/*
* Copyright 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.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.LocationTrait;
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 DescribeClusterParametersRequest extends RedshiftRequest implements
ToCopyableBuilder {
private static final SdkField PARAMETER_GROUP_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ParameterGroupName").getter(getter(DescribeClusterParametersRequest::parameterGroupName))
.setter(setter(Builder::parameterGroupName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ParameterGroupName").build())
.build();
private static final SdkField SOURCE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Source")
.getter(getter(DescribeClusterParametersRequest::source)).setter(setter(Builder::source))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Source").build()).build();
private static final SdkField MAX_RECORDS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxRecords").getter(getter(DescribeClusterParametersRequest::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).memberName("Marker")
.getter(getter(DescribeClusterParametersRequest::marker)).setter(setter(Builder::marker))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Marker").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(PARAMETER_GROUP_NAME_FIELD,
SOURCE_FIELD, MAX_RECORDS_FIELD, MARKER_FIELD));
private final String parameterGroupName;
private final String source;
private final Integer maxRecords;
private final String marker;
private DescribeClusterParametersRequest(BuilderImpl builder) {
super(builder);
this.parameterGroupName = builder.parameterGroupName;
this.source = builder.source;
this.maxRecords = builder.maxRecords;
this.marker = builder.marker;
}
/**
*
* The name of a cluster parameter group for which to return details.
*
*
* @return The name of a cluster parameter group for which to return details.
*/
public final String parameterGroupName() {
return parameterGroupName;
}
/**
*
* The parameter types to return. Specify user to show parameters that are different form the default.
* Similarly, specify engine-default to show parameters that are the same as the default parameter
* group.
*
*
* Default: All parameter types returned.
*
*
* Valid Values: user | engine-default
*
*
* @return The parameter types to return. Specify user to show parameters that are different form the
* default. Similarly, specify engine-default to show parameters that are the same as the
* default parameter group.
*
* Default: All parameter types returned.
*
*
* Valid Values: user | engine-default
*/
public final String source() {
return source;
}
/**
*
* 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 final Integer maxRecords() {
return maxRecords;
}
/**
*
* An optional parameter that specifies the starting point to return a set of response records. When the results of
* a DescribeClusterParameters 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.
*
*
* @return An optional parameter that specifies the starting point to return a set of response records. When the
* results of a DescribeClusterParameters 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.
*/
public final String marker() {
return marker;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(parameterGroupName());
hashCode = 31 * hashCode + Objects.hashCode(source());
hashCode = 31 * hashCode + Objects.hashCode(maxRecords());
hashCode = 31 * hashCode + Objects.hashCode(marker());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DescribeClusterParametersRequest)) {
return false;
}
DescribeClusterParametersRequest other = (DescribeClusterParametersRequest) obj;
return Objects.equals(parameterGroupName(), other.parameterGroupName()) && Objects.equals(source(), other.source())
&& Objects.equals(maxRecords(), other.maxRecords()) && Objects.equals(marker(), other.marker());
}
/**
* 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 final String toString() {
return ToString.builder("DescribeClusterParametersRequest").add("ParameterGroupName", parameterGroupName())
.add("Source", source()).add("MaxRecords", maxRecords()).add("Marker", marker()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ParameterGroupName":
return Optional.ofNullable(clazz.cast(parameterGroupName()));
case "Source":
return Optional.ofNullable(clazz.cast(source()));
case "MaxRecords":
return Optional.ofNullable(clazz.cast(maxRecords()));
case "Marker":
return Optional.ofNullable(clazz.cast(marker()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeClusterParametersRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends RedshiftRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The name of a cluster parameter group for which to return details.
*
*
* @param parameterGroupName
* The name of a cluster parameter group for which to return details.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder parameterGroupName(String parameterGroupName);
/**
*
* The parameter types to return. Specify user to show parameters that are different form the
* default. Similarly, specify engine-default to show parameters that are the same as the default
* parameter group.
*
*
* Default: All parameter types returned.
*
*
* Valid Values: user | engine-default
*
*
* @param source
* The parameter types to return. Specify user to show parameters that are different form
* the default. Similarly, specify engine-default to show parameters that are the same as
* the default parameter group.
*
* Default: All parameter types returned.
*
*
* Valid Values: user | engine-default
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder source(String source);
/**
*
* 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 DescribeClusterParameters 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.
*
*
* @param marker
* An optional parameter that specifies the starting point to return a set of response records. When the
* results of a DescribeClusterParameters 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder marker(String marker);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends RedshiftRequest.BuilderImpl implements Builder {
private String parameterGroupName;
private String source;
private Integer maxRecords;
private String marker;
private BuilderImpl() {
}
private BuilderImpl(DescribeClusterParametersRequest model) {
super(model);
parameterGroupName(model.parameterGroupName);
source(model.source);
maxRecords(model.maxRecords);
marker(model.marker);
}
public final String getParameterGroupName() {
return parameterGroupName;
}
@Override
public final Builder parameterGroupName(String parameterGroupName) {
this.parameterGroupName = parameterGroupName;
return this;
}
public final void setParameterGroupName(String parameterGroupName) {
this.parameterGroupName = parameterGroupName;
}
public final String getSource() {
return source;
}
@Override
public final Builder source(String source) {
this.source = source;
return this;
}
public final void setSource(String source) {
this.source = source;
}
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;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public DescribeClusterParametersRequest build() {
return new DescribeClusterParametersRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}