com.amazonaws.services.mailmanager.model.CreateArchiveRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-mailmanager 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.mailmanager.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* The request to create a new email archive.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateArchiveRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* A unique name for the new archive.
*
*/
private String archiveName;
/**
*
* A unique token Amazon SES uses to recognize retries of this request.
*
*/
private String clientToken;
/**
*
* The Amazon Resource Name (ARN) of the KMS key for encrypting emails in the archive.
*
*/
private String kmsKeyArn;
/**
*
* The period for retaining emails in the archive before automatic deletion.
*
*/
private ArchiveRetention retention;
/**
*
* The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1",
* "key2":"value2"} }.
*
*/
private java.util.List tags;
/**
*
* A unique name for the new archive.
*
*
* @param archiveName
* A unique name for the new archive.
*/
public void setArchiveName(String archiveName) {
this.archiveName = archiveName;
}
/**
*
* A unique name for the new archive.
*
*
* @return A unique name for the new archive.
*/
public String getArchiveName() {
return this.archiveName;
}
/**
*
* A unique name for the new archive.
*
*
* @param archiveName
* A unique name for the new archive.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateArchiveRequest withArchiveName(String archiveName) {
setArchiveName(archiveName);
return this;
}
/**
*
* A unique token Amazon SES uses to recognize retries of this request.
*
*
* @param clientToken
* A unique token Amazon SES uses to recognize retries of this request.
*/
public void setClientToken(String clientToken) {
this.clientToken = clientToken;
}
/**
*
* A unique token Amazon SES uses to recognize retries of this request.
*
*
* @return A unique token Amazon SES uses to recognize retries of this request.
*/
public String getClientToken() {
return this.clientToken;
}
/**
*
* A unique token Amazon SES uses to recognize retries of this request.
*
*
* @param clientToken
* A unique token Amazon SES uses to recognize retries of this request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateArchiveRequest withClientToken(String clientToken) {
setClientToken(clientToken);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the KMS key for encrypting emails in the archive.
*
*
* @param kmsKeyArn
* The Amazon Resource Name (ARN) of the KMS key for encrypting emails in the archive.
*/
public void setKmsKeyArn(String kmsKeyArn) {
this.kmsKeyArn = kmsKeyArn;
}
/**
*
* The Amazon Resource Name (ARN) of the KMS key for encrypting emails in the archive.
*
*
* @return The Amazon Resource Name (ARN) of the KMS key for encrypting emails in the archive.
*/
public String getKmsKeyArn() {
return this.kmsKeyArn;
}
/**
*
* The Amazon Resource Name (ARN) of the KMS key for encrypting emails in the archive.
*
*
* @param kmsKeyArn
* The Amazon Resource Name (ARN) of the KMS key for encrypting emails in the archive.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateArchiveRequest withKmsKeyArn(String kmsKeyArn) {
setKmsKeyArn(kmsKeyArn);
return this;
}
/**
*
* The period for retaining emails in the archive before automatic deletion.
*
*
* @param retention
* The period for retaining emails in the archive before automatic deletion.
*/
public void setRetention(ArchiveRetention retention) {
this.retention = retention;
}
/**
*
* The period for retaining emails in the archive before automatic deletion.
*
*
* @return The period for retaining emails in the archive before automatic deletion.
*/
public ArchiveRetention getRetention() {
return this.retention;
}
/**
*
* The period for retaining emails in the archive before automatic deletion.
*
*
* @param retention
* The period for retaining emails in the archive before automatic deletion.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateArchiveRequest withRetention(ArchiveRetention retention) {
setRetention(retention);
return this;
}
/**
*
* The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1",
* "key2":"value2"} }.
*
*
* @return The tags used to organize, track, or control access for the resource. For example, { "tags":
* {"key1":"value1", "key2":"value2"} }.
*/
public java.util.List getTags() {
return tags;
}
/**
*
* The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1",
* "key2":"value2"} }.
*
*
* @param tags
* The tags used to organize, track, or control access for the resource. For example, { "tags":
* {"key1":"value1", "key2":"value2"} }.
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new java.util.ArrayList(tags);
}
/**
*
* The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1",
* "key2":"value2"} }.
*
*
* 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
* The tags used to organize, track, or control access for the resource. For example, { "tags":
* {"key1":"value1", "key2":"value2"} }.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateArchiveRequest withTags(Tag... tags) {
if (this.tags == null) {
setTags(new java.util.ArrayList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1",
* "key2":"value2"} }.
*
*
* @param tags
* The tags used to organize, track, or control access for the resource. For example, { "tags":
* {"key1":"value1", "key2":"value2"} }.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateArchiveRequest 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 (getArchiveName() != null)
sb.append("ArchiveName: ").append(getArchiveName()).append(",");
if (getClientToken() != null)
sb.append("ClientToken: ").append(getClientToken()).append(",");
if (getKmsKeyArn() != null)
sb.append("KmsKeyArn: ").append(getKmsKeyArn()).append(",");
if (getRetention() != null)
sb.append("Retention: ").append(getRetention()).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 CreateArchiveRequest == false)
return false;
CreateArchiveRequest other = (CreateArchiveRequest) obj;
if (other.getArchiveName() == null ^ this.getArchiveName() == null)
return false;
if (other.getArchiveName() != null && other.getArchiveName().equals(this.getArchiveName()) == false)
return false;
if (other.getClientToken() == null ^ this.getClientToken() == null)
return false;
if (other.getClientToken() != null && other.getClientToken().equals(this.getClientToken()) == false)
return false;
if (other.getKmsKeyArn() == null ^ this.getKmsKeyArn() == null)
return false;
if (other.getKmsKeyArn() != null && other.getKmsKeyArn().equals(this.getKmsKeyArn()) == false)
return false;
if (other.getRetention() == null ^ this.getRetention() == null)
return false;
if (other.getRetention() != null && other.getRetention().equals(this.getRetention()) == 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 + ((getArchiveName() == null) ? 0 : getArchiveName().hashCode());
hashCode = prime * hashCode + ((getClientToken() == null) ? 0 : getClientToken().hashCode());
hashCode = prime * hashCode + ((getKmsKeyArn() == null) ? 0 : getKmsKeyArn().hashCode());
hashCode = prime * hashCode + ((getRetention() == null) ? 0 : getRetention().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public CreateArchiveRequest clone() {
return (CreateArchiveRequest) super.clone();
}
}