All Downloads are FREE. Search and download functionalities are using the official Maven repository.

software.amazon.awssdk.services.redshift.model.CreateClusterSnapshotRequest Maven / Gradle / Ivy

Go to download

The AWS Java SDK for Amazon Redshift module holds the client classes that are used for communicating with Amazon Redshift Service

There is a newer version: 2.28.3
Show newest version
/*
 * 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 CreateClusterSnapshotRequest extends RedshiftRequest implements ToCopyableBuilder { private static final SdkField SNAPSHOT_IDENTIFIER_FIELD = SdkField. builder(MarshallingType.STRING) .memberName("SnapshotIdentifier").getter(getter(CreateClusterSnapshotRequest::snapshotIdentifier)) .setter(setter(Builder::snapshotIdentifier)) .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SnapshotIdentifier").build()) .build(); private static final SdkField CLUSTER_IDENTIFIER_FIELD = SdkField. builder(MarshallingType.STRING) .memberName("ClusterIdentifier").getter(getter(CreateClusterSnapshotRequest::clusterIdentifier)) .setter(setter(Builder::clusterIdentifier)) .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ClusterIdentifier").build()).build(); private static final SdkField MANUAL_SNAPSHOT_RETENTION_PERIOD_FIELD = SdkField . builder(MarshallingType.INTEGER) .memberName("ManualSnapshotRetentionPeriod") .getter(getter(CreateClusterSnapshotRequest::manualSnapshotRetentionPeriod)) .setter(setter(Builder::manualSnapshotRetentionPeriod)) .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ManualSnapshotRetentionPeriod") .build()).build(); private static final SdkField> TAGS_FIELD = SdkField .> builder(MarshallingType.LIST) .memberName("Tags") .getter(getter(CreateClusterSnapshotRequest::tags)) .setter(setter(Builder::tags)) .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tags").build(), ListTrait .builder() .memberLocationName("Tag") .memberFieldInfo( SdkField. builder(MarshallingType.SDK_POJO) .constructor(Tag::builder) .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD) .locationName("Tag").build()).build()).build()).build(); private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(SNAPSHOT_IDENTIFIER_FIELD, CLUSTER_IDENTIFIER_FIELD, MANUAL_SNAPSHOT_RETENTION_PERIOD_FIELD, TAGS_FIELD)); private final String snapshotIdentifier; private final String clusterIdentifier; private final Integer manualSnapshotRetentionPeriod; private final List tags; private CreateClusterSnapshotRequest(BuilderImpl builder) { super(builder); this.snapshotIdentifier = builder.snapshotIdentifier; this.clusterIdentifier = builder.clusterIdentifier; this.manualSnapshotRetentionPeriod = builder.manualSnapshotRetentionPeriod; this.tags = builder.tags; } /** *

* A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots * within the Amazon Web Services account. *

*

* Constraints: *

*
    *
  • *

    * Cannot be null, empty, or blank *

    *
  • *
  • *

    * Must contain from 1 to 255 alphanumeric characters or hyphens *

    *
  • *
  • *

    * First character must be a letter *

    *
  • *
  • *

    * Cannot end with a hyphen or contain two consecutive hyphens *

    *
  • *
*

* Example: my-snapshot-id *

* * @return A unique identifier for the snapshot that you are requesting. This identifier must be unique for all * snapshots within the Amazon Web Services account.

*

* Constraints: *

*
    *
  • *

    * Cannot be null, empty, or blank *

    *
  • *
  • *

    * Must contain from 1 to 255 alphanumeric characters or hyphens *

    *
  • *
  • *

    * First character must be a letter *

    *
  • *
  • *

    * Cannot end with a hyphen or contain two consecutive hyphens *

    *
  • *
*

* Example: my-snapshot-id */ public final String snapshotIdentifier() { return snapshotIdentifier; } /** *

* The cluster identifier for which you want a snapshot. *

* * @return The cluster identifier for which you want a snapshot. */ public final String clusterIdentifier() { return clusterIdentifier; } /** *

* The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained * indefinitely. *

*

* The value must be either -1 or an integer between 1 and 3,653. *

*

* The default value is -1. *

* * @return The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is * retained indefinitely.

*

* The value must be either -1 or an integer between 1 and 3,653. *

*

* The default value is -1. */ public final Integer manualSnapshotRetentionPeriod() { return manualSnapshotRetentionPeriod; } /** * For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that * the value is non-empty (for which, you should check the {@code isEmpty()} method on the property). This is useful * because the SDK will never return a null collection or map, but you may need to differentiate between the service * returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true * if a value for the property was specified in the request builder, and false if a value was not specified. */ public final boolean hasTags() { return tags != null && !(tags instanceof SdkAutoConstructList); } /** *

* A list of tag instances. *

*

* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException. *

*

* This method will never return null. If you would like to know whether the service returned this field (so that * you can differentiate between null and empty), you can use the {@link #hasTags} method. *

* * @return A list of tag instances. */ public final List tags() { return tags; } @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(snapshotIdentifier()); hashCode = 31 * hashCode + Objects.hashCode(clusterIdentifier()); hashCode = 31 * hashCode + Objects.hashCode(manualSnapshotRetentionPeriod()); hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null); 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 CreateClusterSnapshotRequest)) { return false; } CreateClusterSnapshotRequest other = (CreateClusterSnapshotRequest) obj; return Objects.equals(snapshotIdentifier(), other.snapshotIdentifier()) && Objects.equals(clusterIdentifier(), other.clusterIdentifier()) && Objects.equals(manualSnapshotRetentionPeriod(), other.manualSnapshotRetentionPeriod()) && hasTags() == other.hasTags() && Objects.equals(tags(), other.tags()); } /** * 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("CreateClusterSnapshotRequest").add("SnapshotIdentifier", snapshotIdentifier()) .add("ClusterIdentifier", clusterIdentifier()) .add("ManualSnapshotRetentionPeriod", manualSnapshotRetentionPeriod()).add("Tags", hasTags() ? tags() : null) .build(); } public final Optional getValueForField(String fieldName, Class clazz) { switch (fieldName) { case "SnapshotIdentifier": return Optional.ofNullable(clazz.cast(snapshotIdentifier())); case "ClusterIdentifier": return Optional.ofNullable(clazz.cast(clusterIdentifier())); case "ManualSnapshotRetentionPeriod": return Optional.ofNullable(clazz.cast(manualSnapshotRetentionPeriod())); case "Tags": return Optional.ofNullable(clazz.cast(tags())); default: return Optional.empty(); } } @Override public final List> sdkFields() { return SDK_FIELDS; } private static Function getter(Function g) { return obj -> g.apply((CreateClusterSnapshotRequest) obj); } private static BiConsumer setter(BiConsumer s) { return (obj, val) -> s.accept((Builder) obj, val); } public interface Builder extends RedshiftRequest.Builder, SdkPojo, CopyableBuilder { /** *

* A unique identifier for the snapshot that you are requesting. This identifier must be unique for all * snapshots within the Amazon Web Services account. *

*

* Constraints: *

*
    *
  • *

    * Cannot be null, empty, or blank *

    *
  • *
  • *

    * Must contain from 1 to 255 alphanumeric characters or hyphens *

    *
  • *
  • *

    * First character must be a letter *

    *
  • *
  • *

    * Cannot end with a hyphen or contain two consecutive hyphens *

    *
  • *
*

* Example: my-snapshot-id *

* * @param snapshotIdentifier * A unique identifier for the snapshot that you are requesting. This identifier must be unique for all * snapshots within the Amazon Web Services account.

*

* Constraints: *

*
    *
  • *

    * Cannot be null, empty, or blank *

    *
  • *
  • *

    * Must contain from 1 to 255 alphanumeric characters or hyphens *

    *
  • *
  • *

    * First character must be a letter *

    *
  • *
  • *

    * Cannot end with a hyphen or contain two consecutive hyphens *

    *
  • *
*

* Example: my-snapshot-id * @return Returns a reference to this object so that method calls can be chained together. */ Builder snapshotIdentifier(String snapshotIdentifier); /** *

* The cluster identifier for which you want a snapshot. *

* * @param clusterIdentifier * The cluster identifier for which you want a snapshot. * @return Returns a reference to this object so that method calls can be chained together. */ Builder clusterIdentifier(String clusterIdentifier); /** *

* The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained * indefinitely. *

*

* The value must be either -1 or an integer between 1 and 3,653. *

*

* The default value is -1. *

* * @param manualSnapshotRetentionPeriod * The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is * retained indefinitely.

*

* The value must be either -1 or an integer between 1 and 3,653. *

*

* The default value is -1. * @return Returns a reference to this object so that method calls can be chained together. */ Builder manualSnapshotRetentionPeriod(Integer manualSnapshotRetentionPeriod); /** *

* A list of tag instances. *

* * @param tags * A list of tag instances. * @return Returns a reference to this object so that method calls can be chained together. */ Builder tags(Collection tags); /** *

* A list of tag instances. *

* * @param tags * A list of tag instances. * @return Returns a reference to this object so that method calls can be chained together. */ Builder tags(Tag... tags); /** *

* A list of tag instances. *

* This is a convenience method that creates an instance of the * {@link software.amazon.awssdk.services.redshift.model.Tag.Builder} avoiding the need to create one manually * via {@link software.amazon.awssdk.services.redshift.model.Tag#builder()}. * *

* When the {@link Consumer} completes, * {@link software.amazon.awssdk.services.redshift.model.Tag.Builder#build()} is called immediately and its * result is passed to {@link #tags(List)}. * * @param tags * a consumer that will call methods on * {@link software.amazon.awssdk.services.redshift.model.Tag.Builder} * @return Returns a reference to this object so that method calls can be chained together. * @see #tags(java.util.Collection) */ Builder tags(Consumer... tags); @Override Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration); @Override Builder overrideConfiguration(Consumer builderConsumer); } static final class BuilderImpl extends RedshiftRequest.BuilderImpl implements Builder { private String snapshotIdentifier; private String clusterIdentifier; private Integer manualSnapshotRetentionPeriod; private List tags = DefaultSdkAutoConstructList.getInstance(); private BuilderImpl() { } private BuilderImpl(CreateClusterSnapshotRequest model) { super(model); snapshotIdentifier(model.snapshotIdentifier); clusterIdentifier(model.clusterIdentifier); manualSnapshotRetentionPeriod(model.manualSnapshotRetentionPeriod); tags(model.tags); } public final String getSnapshotIdentifier() { return snapshotIdentifier; } public final void setSnapshotIdentifier(String snapshotIdentifier) { this.snapshotIdentifier = snapshotIdentifier; } @Override public final Builder snapshotIdentifier(String snapshotIdentifier) { this.snapshotIdentifier = snapshotIdentifier; return this; } public final String getClusterIdentifier() { return clusterIdentifier; } public final void setClusterIdentifier(String clusterIdentifier) { this.clusterIdentifier = clusterIdentifier; } @Override public final Builder clusterIdentifier(String clusterIdentifier) { this.clusterIdentifier = clusterIdentifier; return this; } public final Integer getManualSnapshotRetentionPeriod() { return manualSnapshotRetentionPeriod; } public final void setManualSnapshotRetentionPeriod(Integer manualSnapshotRetentionPeriod) { this.manualSnapshotRetentionPeriod = manualSnapshotRetentionPeriod; } @Override public final Builder manualSnapshotRetentionPeriod(Integer manualSnapshotRetentionPeriod) { this.manualSnapshotRetentionPeriod = manualSnapshotRetentionPeriod; return this; } public final List getTags() { List result = TagListCopier.copyToBuilder(this.tags); if (result instanceof SdkAutoConstructList) { return null; } return result; } public final void setTags(Collection tags) { this.tags = TagListCopier.copyFromBuilder(tags); } @Override public final Builder tags(Collection tags) { this.tags = TagListCopier.copy(tags); return this; } @Override @SafeVarargs public final Builder tags(Tag... tags) { tags(Arrays.asList(tags)); return this; } @Override @SafeVarargs public final Builder tags(Consumer... tags) { tags(Stream.of(tags).map(c -> Tag.builder().applyMutation(c).build()).collect(Collectors.toList())); return this; } @Override public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) { super.overrideConfiguration(overrideConfiguration); return this; } @Override public Builder overrideConfiguration(Consumer builderConsumer) { super.overrideConfiguration(builderConsumer); return this; } @Override public CreateClusterSnapshotRequest build() { return new CreateClusterSnapshotRequest(this); } @Override public List> sdkFields() { return SDK_FIELDS; } } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy