software.amazon.awssdk.services.redshift.model.DescribeNodeConfigurationOptionsRequest 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.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 java.util.stream.Collectors;
import java.util.stream.Stream;
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.core.util.SdkAutoConstructList;
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 DescribeNodeConfigurationOptionsRequest extends RedshiftRequest implements
ToCopyableBuilder {
private static final SdkField ACTION_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(DescribeNodeConfigurationOptionsRequest::actionTypeAsString)).setter(setter(Builder::actionType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ActionType").build()).build();
private static final SdkField CLUSTER_IDENTIFIER_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(DescribeNodeConfigurationOptionsRequest::clusterIdentifier))
.setter(setter(Builder::clusterIdentifier))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ClusterIdentifier").build()).build();
private static final SdkField SNAPSHOT_IDENTIFIER_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(DescribeNodeConfigurationOptionsRequest::snapshotIdentifier))
.setter(setter(Builder::snapshotIdentifier))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SnapshotIdentifier").build())
.build();
private static final SdkField OWNER_ACCOUNT_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(DescribeNodeConfigurationOptionsRequest::ownerAccount)).setter(setter(Builder::ownerAccount))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OwnerAccount").build()).build();
private static final SdkField> FILTERS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.getter(getter(DescribeNodeConfigurationOptionsRequest::filters))
.setter(setter(Builder::filters))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Filter").build(),
ListTrait
.builder()
.memberLocationName("NodeConfigurationOptionsFilter")
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(NodeConfigurationOptionsFilter::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("NodeConfigurationOptionsFilter").build()).build()).build())
.build();
private static final SdkField MARKER_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(DescribeNodeConfigurationOptionsRequest::marker)).setter(setter(Builder::marker))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Marker").build()).build();
private static final SdkField MAX_RECORDS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.getter(getter(DescribeNodeConfigurationOptionsRequest::maxRecords)).setter(setter(Builder::maxRecords))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxRecords").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ACTION_TYPE_FIELD,
CLUSTER_IDENTIFIER_FIELD, SNAPSHOT_IDENTIFIER_FIELD, OWNER_ACCOUNT_FIELD, FILTERS_FIELD, MARKER_FIELD,
MAX_RECORDS_FIELD));
private final String actionType;
private final String clusterIdentifier;
private final String snapshotIdentifier;
private final String ownerAccount;
private final List filters;
private final String marker;
private final Integer maxRecords;
private DescribeNodeConfigurationOptionsRequest(BuilderImpl builder) {
super(builder);
this.actionType = builder.actionType;
this.clusterIdentifier = builder.clusterIdentifier;
this.snapshotIdentifier = builder.snapshotIdentifier;
this.ownerAccount = builder.ownerAccount;
this.filters = builder.filters;
this.marker = builder.marker;
this.maxRecords = builder.maxRecords;
}
/**
*
* The action type to evaluate for possible node configurations. Specify "restore-cluster" to get configuration
* combinations based on an existing snapshot. Specify "recommend-node-config" to get configuration recommendations
* based on an existing cluster or snapshot. Specify "resize-cluster" to get configuration combinations for elastic
* resize based on an existing cluster.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #actionType} will
* return {@link ActionType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #actionTypeAsString}.
*
*
* @return The action type to evaluate for possible node configurations. Specify "restore-cluster" to get
* configuration combinations based on an existing snapshot. Specify "recommend-node-config" to get
* configuration recommendations based on an existing cluster or snapshot. Specify "resize-cluster" to get
* configuration combinations for elastic resize based on an existing cluster.
* @see ActionType
*/
public ActionType actionType() {
return ActionType.fromValue(actionType);
}
/**
*
* The action type to evaluate for possible node configurations. Specify "restore-cluster" to get configuration
* combinations based on an existing snapshot. Specify "recommend-node-config" to get configuration recommendations
* based on an existing cluster or snapshot. Specify "resize-cluster" to get configuration combinations for elastic
* resize based on an existing cluster.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #actionType} will
* return {@link ActionType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #actionTypeAsString}.
*
*
* @return The action type to evaluate for possible node configurations. Specify "restore-cluster" to get
* configuration combinations based on an existing snapshot. Specify "recommend-node-config" to get
* configuration recommendations based on an existing cluster or snapshot. Specify "resize-cluster" to get
* configuration combinations for elastic resize based on an existing cluster.
* @see ActionType
*/
public String actionTypeAsString() {
return actionType;
}
/**
*
* The identifier of the cluster to evaluate for possible node configurations.
*
*
* @return The identifier of the cluster to evaluate for possible node configurations.
*/
public String clusterIdentifier() {
return clusterIdentifier;
}
/**
*
* The identifier of the snapshot to evaluate for possible node configurations.
*
*
* @return The identifier of the snapshot to evaluate for possible node configurations.
*/
public String snapshotIdentifier() {
return snapshotIdentifier;
}
/**
*
* The AWS customer account used to create or copy the snapshot. Required if you are restoring a snapshot you do not
* own, optional if you own the snapshot.
*
*
* @return The AWS customer account used to create or copy the snapshot. Required if you are restoring a snapshot
* you do not own, optional if you own the snapshot.
*/
public String ownerAccount() {
return ownerAccount;
}
/**
* Returns true if the Filters property was specified by the sender (it may be empty), or false if the sender did
* not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
*/
public boolean hasFilters() {
return filters != null && !(filters instanceof SdkAutoConstructList);
}
/**
*
* A set of name, operator, and value items to filter the results.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasFilters()} to see if a value was sent in this field.
*
*
* @return A set of name, operator, and value items to filter the results.
*/
public List filters() {
return filters;
}
/**
*
* An optional parameter that specifies the starting point to return a set of response records. When the results of
* a DescribeNodeConfigurationOptions 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 DescribeNodeConfigurationOptions 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 String marker() {
return marker;
}
/**
*
* 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: 500
*
*
* Constraints: minimum 100, maximum 500.
*
*
* @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: 500
*
*
* Constraints: minimum 100, maximum 500.
*/
public Integer maxRecords() {
return maxRecords;
}
@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 + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(actionTypeAsString());
hashCode = 31 * hashCode + Objects.hashCode(clusterIdentifier());
hashCode = 31 * hashCode + Objects.hashCode(snapshotIdentifier());
hashCode = 31 * hashCode + Objects.hashCode(ownerAccount());
hashCode = 31 * hashCode + Objects.hashCode(filters());
hashCode = 31 * hashCode + Objects.hashCode(marker());
hashCode = 31 * hashCode + Objects.hashCode(maxRecords());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DescribeNodeConfigurationOptionsRequest)) {
return false;
}
DescribeNodeConfigurationOptionsRequest other = (DescribeNodeConfigurationOptionsRequest) obj;
return Objects.equals(actionTypeAsString(), other.actionTypeAsString())
&& Objects.equals(clusterIdentifier(), other.clusterIdentifier())
&& Objects.equals(snapshotIdentifier(), other.snapshotIdentifier())
&& Objects.equals(ownerAccount(), other.ownerAccount()) && Objects.equals(filters(), other.filters())
&& Objects.equals(marker(), other.marker()) && Objects.equals(maxRecords(), other.maxRecords());
}
/**
* 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("DescribeNodeConfigurationOptionsRequest").add("ActionType", actionTypeAsString())
.add("ClusterIdentifier", clusterIdentifier()).add("SnapshotIdentifier", snapshotIdentifier())
.add("OwnerAccount", ownerAccount()).add("Filters", filters()).add("Marker", marker())
.add("MaxRecords", maxRecords()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ActionType":
return Optional.ofNullable(clazz.cast(actionTypeAsString()));
case "ClusterIdentifier":
return Optional.ofNullable(clazz.cast(clusterIdentifier()));
case "SnapshotIdentifier":
return Optional.ofNullable(clazz.cast(snapshotIdentifier()));
case "OwnerAccount":
return Optional.ofNullable(clazz.cast(ownerAccount()));
case "Filters":
return Optional.ofNullable(clazz.cast(filters()));
case "Marker":
return Optional.ofNullable(clazz.cast(marker()));
case "MaxRecords":
return Optional.ofNullable(clazz.cast(maxRecords()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeNodeConfigurationOptionsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends RedshiftRequest.Builder, SdkPojo,
CopyableBuilder {
/**
*
* The action type to evaluate for possible node configurations. Specify "restore-cluster" to get configuration
* combinations based on an existing snapshot. Specify "recommend-node-config" to get configuration
* recommendations based on an existing cluster or snapshot. Specify "resize-cluster" to get configuration
* combinations for elastic resize based on an existing cluster.
*
*
* @param actionType
* The action type to evaluate for possible node configurations. Specify "restore-cluster" to get
* configuration combinations based on an existing snapshot. Specify "recommend-node-config" to get
* configuration recommendations based on an existing cluster or snapshot. Specify "resize-cluster" to
* get configuration combinations for elastic resize based on an existing cluster.
* @see ActionType
* @return Returns a reference to this object so that method calls can be chained together.
* @see ActionType
*/
Builder actionType(String actionType);
/**
*
* The action type to evaluate for possible node configurations. Specify "restore-cluster" to get configuration
* combinations based on an existing snapshot. Specify "recommend-node-config" to get configuration
* recommendations based on an existing cluster or snapshot. Specify "resize-cluster" to get configuration
* combinations for elastic resize based on an existing cluster.
*
*
* @param actionType
* The action type to evaluate for possible node configurations. Specify "restore-cluster" to get
* configuration combinations based on an existing snapshot. Specify "recommend-node-config" to get
* configuration recommendations based on an existing cluster or snapshot. Specify "resize-cluster" to
* get configuration combinations for elastic resize based on an existing cluster.
* @see ActionType
* @return Returns a reference to this object so that method calls can be chained together.
* @see ActionType
*/
Builder actionType(ActionType actionType);
/**
*
* The identifier of the cluster to evaluate for possible node configurations.
*
*
* @param clusterIdentifier
* The identifier of the cluster to evaluate for possible node configurations.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder clusterIdentifier(String clusterIdentifier);
/**
*
* The identifier of the snapshot to evaluate for possible node configurations.
*
*
* @param snapshotIdentifier
* The identifier of the snapshot to evaluate for possible node configurations.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder snapshotIdentifier(String snapshotIdentifier);
/**
*
* The AWS customer account used to create or copy the snapshot. Required if you are restoring a snapshot you do
* not own, optional if you own the snapshot.
*
*
* @param ownerAccount
* The AWS customer account used to create or copy the snapshot. Required if you are restoring a snapshot
* you do not own, optional if you own the snapshot.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder ownerAccount(String ownerAccount);
/**
*
* A set of name, operator, and value items to filter the results.
*
*
* @param filters
* A set of name, operator, and value items to filter the results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder filters(Collection filters);
/**
*
* A set of name, operator, and value items to filter the results.
*
*
* @param filters
* A set of name, operator, and value items to filter the results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder filters(NodeConfigurationOptionsFilter... filters);
/**
*
* A set of name, operator, and value items to filter the results.
*
* This is a convenience that creates an instance of the {@link List.Builder}
* avoiding the need to create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called
* immediately and its result is passed to {@link #filters(List)}.
*
* @param filters
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #filters(List)
*/
Builder filters(Consumer... filters);
/**
*
* An optional parameter that specifies the starting point to return a set of response records. When the results
* of a DescribeNodeConfigurationOptions 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 DescribeNodeConfigurationOptions 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);
/**
*
* 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: 500
*
*
* Constraints: minimum 100, maximum 500.
*
*
* @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: 500
*
*
* Constraints: minimum 100, maximum 500.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxRecords(Integer maxRecords);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends RedshiftRequest.BuilderImpl implements Builder {
private String actionType;
private String clusterIdentifier;
private String snapshotIdentifier;
private String ownerAccount;
private List filters = DefaultSdkAutoConstructList.getInstance();
private String marker;
private Integer maxRecords;
private BuilderImpl() {
}
private BuilderImpl(DescribeNodeConfigurationOptionsRequest model) {
super(model);
actionType(model.actionType);
clusterIdentifier(model.clusterIdentifier);
snapshotIdentifier(model.snapshotIdentifier);
ownerAccount(model.ownerAccount);
filters(model.filters);
marker(model.marker);
maxRecords(model.maxRecords);
}
public final String getActionType() {
return actionType;
}
@Override
public final Builder actionType(String actionType) {
this.actionType = actionType;
return this;
}
@Override
public final Builder actionType(ActionType actionType) {
this.actionType(actionType == null ? null : actionType.toString());
return this;
}
public final void setActionType(String actionType) {
this.actionType = actionType;
}
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 String getSnapshotIdentifier() {
return snapshotIdentifier;
}
@Override
public final Builder snapshotIdentifier(String snapshotIdentifier) {
this.snapshotIdentifier = snapshotIdentifier;
return this;
}
public final void setSnapshotIdentifier(String snapshotIdentifier) {
this.snapshotIdentifier = snapshotIdentifier;
}
public final String getOwnerAccount() {
return ownerAccount;
}
@Override
public final Builder ownerAccount(String ownerAccount) {
this.ownerAccount = ownerAccount;
return this;
}
public final void setOwnerAccount(String ownerAccount) {
this.ownerAccount = ownerAccount;
}
public final Collection getFilters() {
return filters != null ? filters.stream().map(NodeConfigurationOptionsFilter::toBuilder).collect(Collectors.toList())
: null;
}
@Override
public final Builder filters(Collection filters) {
this.filters = NodeConfigurationOptionsFilterListCopier.copy(filters);
return this;
}
@Override
@SafeVarargs
public final Builder filters(NodeConfigurationOptionsFilter... filters) {
filters(Arrays.asList(filters));
return this;
}
@Override
@SafeVarargs
public final Builder filters(Consumer... filters) {
filters(Stream.of(filters).map(c -> NodeConfigurationOptionsFilter.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final void setFilters(Collection filters) {
this.filters = NodeConfigurationOptionsFilterListCopier.copyFromBuilder(filters);
}
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 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;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public DescribeNodeConfigurationOptionsRequest build() {
return new DescribeNodeConfigurationOptionsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}