software.amazon.awssdk.services.elasticache.model.CopySnapshotRequest Maven / Gradle / Ivy
Show all versions of elasticache 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.elasticache.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;
/**
*
* Represents the input of a CopySnapshotMessage operation.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class CopySnapshotRequest extends ElastiCacheRequest implements
ToCopyableBuilder {
private static final SdkField SOURCE_SNAPSHOT_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(CopySnapshotRequest::sourceSnapshotName)).setter(setter(Builder::sourceSnapshotName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SourceSnapshotName").build())
.build();
private static final SdkField TARGET_SNAPSHOT_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(CopySnapshotRequest::targetSnapshotName)).setter(setter(Builder::targetSnapshotName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TargetSnapshotName").build())
.build();
private static final SdkField TARGET_BUCKET_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(CopySnapshotRequest::targetBucket)).setter(setter(Builder::targetBucket))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TargetBucket").build()).build();
private static final SdkField KMS_KEY_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(CopySnapshotRequest::kmsKeyId)).setter(setter(Builder::kmsKeyId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("KmsKeyId").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(SOURCE_SNAPSHOT_NAME_FIELD,
TARGET_SNAPSHOT_NAME_FIELD, TARGET_BUCKET_FIELD, KMS_KEY_ID_FIELD));
private final String sourceSnapshotName;
private final String targetSnapshotName;
private final String targetBucket;
private final String kmsKeyId;
private CopySnapshotRequest(BuilderImpl builder) {
super(builder);
this.sourceSnapshotName = builder.sourceSnapshotName;
this.targetSnapshotName = builder.targetSnapshotName;
this.targetBucket = builder.targetBucket;
this.kmsKeyId = builder.kmsKeyId;
}
/**
*
* The name of an existing snapshot from which to make a copy.
*
*
* @return The name of an existing snapshot from which to make a copy.
*/
public String sourceSnapshotName() {
return sourceSnapshotName;
}
/**
*
* A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot, therefore this name must be
* unique within its context - ElastiCache or an Amazon S3 bucket if exporting.
*
*
* @return A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot, therefore this name
* must be unique within its context - ElastiCache or an Amazon S3 bucket if exporting.
*/
public String targetSnapshotName() {
return targetSnapshotName;
}
/**
*
* The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for
* external access.
*
*
* When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3
* bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User Guide.
*
*
* For more information, see Exporting a
* Snapshot in the Amazon ElastiCache User Guide.
*
*
* @return The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a
* snapshot for external access.
*
* When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to
* this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User
* Guide.
*
*
* For more information, see Exporting a
* Snapshot in the Amazon ElastiCache User Guide.
*/
public String targetBucket() {
return targetBucket;
}
/**
*
* The ID of the KMS key used to encrypt the target snapshot.
*
*
* @return The ID of the KMS key used to encrypt the target snapshot.
*/
public String kmsKeyId() {
return kmsKeyId;
}
@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(sourceSnapshotName());
hashCode = 31 * hashCode + Objects.hashCode(targetSnapshotName());
hashCode = 31 * hashCode + Objects.hashCode(targetBucket());
hashCode = 31 * hashCode + Objects.hashCode(kmsKeyId());
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 CopySnapshotRequest)) {
return false;
}
CopySnapshotRequest other = (CopySnapshotRequest) obj;
return Objects.equals(sourceSnapshotName(), other.sourceSnapshotName())
&& Objects.equals(targetSnapshotName(), other.targetSnapshotName())
&& Objects.equals(targetBucket(), other.targetBucket()) && Objects.equals(kmsKeyId(), other.kmsKeyId());
}
/**
* 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("CopySnapshotRequest").add("SourceSnapshotName", sourceSnapshotName())
.add("TargetSnapshotName", targetSnapshotName()).add("TargetBucket", targetBucket()).add("KmsKeyId", kmsKeyId())
.build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "SourceSnapshotName":
return Optional.ofNullable(clazz.cast(sourceSnapshotName()));
case "TargetSnapshotName":
return Optional.ofNullable(clazz.cast(targetSnapshotName()));
case "TargetBucket":
return Optional.ofNullable(clazz.cast(targetBucket()));
case "KmsKeyId":
return Optional.ofNullable(clazz.cast(kmsKeyId()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CopySnapshotRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends ElastiCacheRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The name of an existing snapshot from which to make a copy.
*
*
* @param sourceSnapshotName
* The name of an existing snapshot from which to make a copy.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder sourceSnapshotName(String sourceSnapshotName);
/**
*
* A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot, therefore this name must be
* unique within its context - ElastiCache or an Amazon S3 bucket if exporting.
*
*
* @param targetSnapshotName
* A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot, therefore this name
* must be unique within its context - ElastiCache or an Amazon S3 bucket if exporting.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder targetSnapshotName(String targetSnapshotName);
/**
*
* The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot
* for external access.
*
*
* When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this
* S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User Guide.
*
*
* For more information, see Exporting a
* Snapshot in the Amazon ElastiCache User Guide.
*
*
* @param targetBucket
* The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a
* snapshot for external access.
*
* When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions
* to this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User
* Guide.
*
*
* For more information, see Exporting
* a Snapshot in the Amazon ElastiCache User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder targetBucket(String targetBucket);
/**
*
* The ID of the KMS key used to encrypt the target snapshot.
*
*
* @param kmsKeyId
* The ID of the KMS key used to encrypt the target snapshot.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder kmsKeyId(String kmsKeyId);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends ElastiCacheRequest.BuilderImpl implements Builder {
private String sourceSnapshotName;
private String targetSnapshotName;
private String targetBucket;
private String kmsKeyId;
private BuilderImpl() {
}
private BuilderImpl(CopySnapshotRequest model) {
super(model);
sourceSnapshotName(model.sourceSnapshotName);
targetSnapshotName(model.targetSnapshotName);
targetBucket(model.targetBucket);
kmsKeyId(model.kmsKeyId);
}
public final String getSourceSnapshotName() {
return sourceSnapshotName;
}
@Override
public final Builder sourceSnapshotName(String sourceSnapshotName) {
this.sourceSnapshotName = sourceSnapshotName;
return this;
}
public final void setSourceSnapshotName(String sourceSnapshotName) {
this.sourceSnapshotName = sourceSnapshotName;
}
public final String getTargetSnapshotName() {
return targetSnapshotName;
}
@Override
public final Builder targetSnapshotName(String targetSnapshotName) {
this.targetSnapshotName = targetSnapshotName;
return this;
}
public final void setTargetSnapshotName(String targetSnapshotName) {
this.targetSnapshotName = targetSnapshotName;
}
public final String getTargetBucket() {
return targetBucket;
}
@Override
public final Builder targetBucket(String targetBucket) {
this.targetBucket = targetBucket;
return this;
}
public final void setTargetBucket(String targetBucket) {
this.targetBucket = targetBucket;
}
public final String getKmsKeyId() {
return kmsKeyId;
}
@Override
public final Builder kmsKeyId(String kmsKeyId) {
this.kmsKeyId = kmsKeyId;
return this;
}
public final void setKmsKeyId(String kmsKeyId) {
this.kmsKeyId = kmsKeyId;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CopySnapshotRequest build() {
return new CopySnapshotRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}