com.amazonaws.services.elasticache.model.CreateSnapshotRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-elasticache Show documentation
/*
* Copyright 2019-2024 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 com.amazonaws.services.elasticache.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* Represents the input of a CreateSnapshot operation.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateSnapshotRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The identifier of an existing replication group. The snapshot is created from this replication group.
*
*/
private String replicationGroupId;
/**
*
* The identifier of an existing cluster. The snapshot is created from this cluster.
*
*/
private String cacheClusterId;
/**
*
* A name for the snapshot being created.
*
*/
private String snapshotName;
/**
*
* The ID of the KMS key used to encrypt the snapshot.
*
*/
private String kmsKeyId;
/**
*
* A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag
* value, although null is accepted.
*
*/
private com.amazonaws.internal.SdkInternalList tags;
/**
*
* The identifier of an existing replication group. The snapshot is created from this replication group.
*
*
* @param replicationGroupId
* The identifier of an existing replication group. The snapshot is created from this replication group.
*/
public void setReplicationGroupId(String replicationGroupId) {
this.replicationGroupId = replicationGroupId;
}
/**
*
* The identifier of an existing replication group. The snapshot is created from this replication group.
*
*
* @return The identifier of an existing replication group. The snapshot is created from this replication group.
*/
public String getReplicationGroupId() {
return this.replicationGroupId;
}
/**
*
* The identifier of an existing replication group. The snapshot is created from this replication group.
*
*
* @param replicationGroupId
* The identifier of an existing replication group. The snapshot is created from this replication group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateSnapshotRequest withReplicationGroupId(String replicationGroupId) {
setReplicationGroupId(replicationGroupId);
return this;
}
/**
*
* The identifier of an existing cluster. The snapshot is created from this cluster.
*
*
* @param cacheClusterId
* The identifier of an existing cluster. The snapshot is created from this cluster.
*/
public void setCacheClusterId(String cacheClusterId) {
this.cacheClusterId = cacheClusterId;
}
/**
*
* The identifier of an existing cluster. The snapshot is created from this cluster.
*
*
* @return The identifier of an existing cluster. The snapshot is created from this cluster.
*/
public String getCacheClusterId() {
return this.cacheClusterId;
}
/**
*
* The identifier of an existing cluster. The snapshot is created from this cluster.
*
*
* @param cacheClusterId
* The identifier of an existing cluster. The snapshot is created from this cluster.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateSnapshotRequest withCacheClusterId(String cacheClusterId) {
setCacheClusterId(cacheClusterId);
return this;
}
/**
*
* A name for the snapshot being created.
*
*
* @param snapshotName
* A name for the snapshot being created.
*/
public void setSnapshotName(String snapshotName) {
this.snapshotName = snapshotName;
}
/**
*
* A name for the snapshot being created.
*
*
* @return A name for the snapshot being created.
*/
public String getSnapshotName() {
return this.snapshotName;
}
/**
*
* A name for the snapshot being created.
*
*
* @param snapshotName
* A name for the snapshot being created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateSnapshotRequest withSnapshotName(String snapshotName) {
setSnapshotName(snapshotName);
return this;
}
/**
*
* The ID of the KMS key used to encrypt the snapshot.
*
*
* @param kmsKeyId
* The ID of the KMS key used to encrypt the snapshot.
*/
public void setKmsKeyId(String kmsKeyId) {
this.kmsKeyId = kmsKeyId;
}
/**
*
* The ID of the KMS key used to encrypt the snapshot.
*
*
* @return The ID of the KMS key used to encrypt the snapshot.
*/
public String getKmsKeyId() {
return this.kmsKeyId;
}
/**
*
* The ID of the KMS key used to encrypt the snapshot.
*
*
* @param kmsKeyId
* The ID of the KMS key used to encrypt the snapshot.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateSnapshotRequest withKmsKeyId(String kmsKeyId) {
setKmsKeyId(kmsKeyId);
return this;
}
/**
*
* A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag
* value, although null is accepted.
*
*
* @return A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by
* a tag value, although null is accepted.
*/
public java.util.List getTags() {
if (tags == null) {
tags = new com.amazonaws.internal.SdkInternalList();
}
return tags;
}
/**
*
* A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag
* value, although null is accepted.
*
*
* @param tags
* A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a
* tag value, although null is accepted.
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new com.amazonaws.internal.SdkInternalList(tags);
}
/**
*
* A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag
* value, although null is accepted.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param tags
* A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a
* tag value, although null is accepted.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateSnapshotRequest withTags(Tag... tags) {
if (this.tags == null) {
setTags(new com.amazonaws.internal.SdkInternalList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag
* value, although null is accepted.
*
*
* @param tags
* A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a
* tag value, although null is accepted.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateSnapshotRequest withTags(java.util.Collection tags) {
setTags(tags);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getReplicationGroupId() != null)
sb.append("ReplicationGroupId: ").append(getReplicationGroupId()).append(",");
if (getCacheClusterId() != null)
sb.append("CacheClusterId: ").append(getCacheClusterId()).append(",");
if (getSnapshotName() != null)
sb.append("SnapshotName: ").append(getSnapshotName()).append(",");
if (getKmsKeyId() != null)
sb.append("KmsKeyId: ").append(getKmsKeyId()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateSnapshotRequest == false)
return false;
CreateSnapshotRequest other = (CreateSnapshotRequest) obj;
if (other.getReplicationGroupId() == null ^ this.getReplicationGroupId() == null)
return false;
if (other.getReplicationGroupId() != null && other.getReplicationGroupId().equals(this.getReplicationGroupId()) == false)
return false;
if (other.getCacheClusterId() == null ^ this.getCacheClusterId() == null)
return false;
if (other.getCacheClusterId() != null && other.getCacheClusterId().equals(this.getCacheClusterId()) == false)
return false;
if (other.getSnapshotName() == null ^ this.getSnapshotName() == null)
return false;
if (other.getSnapshotName() != null && other.getSnapshotName().equals(this.getSnapshotName()) == false)
return false;
if (other.getKmsKeyId() == null ^ this.getKmsKeyId() == null)
return false;
if (other.getKmsKeyId() != null && other.getKmsKeyId().equals(this.getKmsKeyId()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getReplicationGroupId() == null) ? 0 : getReplicationGroupId().hashCode());
hashCode = prime * hashCode + ((getCacheClusterId() == null) ? 0 : getCacheClusterId().hashCode());
hashCode = prime * hashCode + ((getSnapshotName() == null) ? 0 : getSnapshotName().hashCode());
hashCode = prime * hashCode + ((getKmsKeyId() == null) ? 0 : getKmsKeyId().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public CreateSnapshotRequest clone() {
return (CreateSnapshotRequest) super.clone();
}
}