com.amazonaws.services.workmail.model.StartMailboxExportJobRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-workmail Show documentation
Show all versions of aws-java-sdk-workmail Show documentation
The AWS Java SDK for Amazon WorkMail module holds the client classes that are used for communicating with Amazon WorkMail Service
/*
* Copyright 2016-2021 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.workmail.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class StartMailboxExportJobRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The idempotency token for the client request.
*
*/
private String clientToken;
/**
*
* The identifier associated with the organization.
*
*/
private String organizationId;
/**
*
* The identifier of the user or resource associated with the mailbox.
*
*/
private String entityId;
/**
*
* The mailbox export job description.
*
*/
private String description;
/**
*
* The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the S3 bucket.
*
*/
private String roleArn;
/**
*
* The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the
* exported mailbox content.
*
*/
private String kmsKeyArn;
/**
*
* The name of the S3 bucket.
*
*/
private String s3BucketName;
/**
*
* The S3 bucket prefix.
*
*/
private String s3Prefix;
/**
*
* The idempotency token for the client request.
*
*
* @param clientToken
* The idempotency token for the client request.
*/
public void setClientToken(String clientToken) {
this.clientToken = clientToken;
}
/**
*
* The idempotency token for the client request.
*
*
* @return The idempotency token for the client request.
*/
public String getClientToken() {
return this.clientToken;
}
/**
*
* The idempotency token for the client request.
*
*
* @param clientToken
* The idempotency token for the client request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartMailboxExportJobRequest withClientToken(String clientToken) {
setClientToken(clientToken);
return this;
}
/**
*
* The identifier associated with the organization.
*
*
* @param organizationId
* The identifier associated with the organization.
*/
public void setOrganizationId(String organizationId) {
this.organizationId = organizationId;
}
/**
*
* The identifier associated with the organization.
*
*
* @return The identifier associated with the organization.
*/
public String getOrganizationId() {
return this.organizationId;
}
/**
*
* The identifier associated with the organization.
*
*
* @param organizationId
* The identifier associated with the organization.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartMailboxExportJobRequest withOrganizationId(String organizationId) {
setOrganizationId(organizationId);
return this;
}
/**
*
* The identifier of the user or resource associated with the mailbox.
*
*
* @param entityId
* The identifier of the user or resource associated with the mailbox.
*/
public void setEntityId(String entityId) {
this.entityId = entityId;
}
/**
*
* The identifier of the user or resource associated with the mailbox.
*
*
* @return The identifier of the user or resource associated with the mailbox.
*/
public String getEntityId() {
return this.entityId;
}
/**
*
* The identifier of the user or resource associated with the mailbox.
*
*
* @param entityId
* The identifier of the user or resource associated with the mailbox.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartMailboxExportJobRequest withEntityId(String entityId) {
setEntityId(entityId);
return this;
}
/**
*
* The mailbox export job description.
*
*
* @param description
* The mailbox export job description.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* The mailbox export job description.
*
*
* @return The mailbox export job description.
*/
public String getDescription() {
return this.description;
}
/**
*
* The mailbox export job description.
*
*
* @param description
* The mailbox export job description.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartMailboxExportJobRequest withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the S3 bucket.
*
*
* @param roleArn
* The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the S3
* bucket.
*/
public void setRoleArn(String roleArn) {
this.roleArn = roleArn;
}
/**
*
* The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the S3 bucket.
*
*
* @return The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the S3
* bucket.
*/
public String getRoleArn() {
return this.roleArn;
}
/**
*
* The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the S3 bucket.
*
*
* @param roleArn
* The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the S3
* bucket.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartMailboxExportJobRequest withRoleArn(String roleArn) {
setRoleArn(roleArn);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the
* exported mailbox content.
*
*
* @param kmsKeyArn
* The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the
* exported mailbox content.
*/
public void setKmsKeyArn(String kmsKeyArn) {
this.kmsKeyArn = kmsKeyArn;
}
/**
*
* The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the
* exported mailbox content.
*
*
* @return The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts
* the exported mailbox content.
*/
public String getKmsKeyArn() {
return this.kmsKeyArn;
}
/**
*
* The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the
* exported mailbox content.
*
*
* @param kmsKeyArn
* The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the
* exported mailbox content.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartMailboxExportJobRequest withKmsKeyArn(String kmsKeyArn) {
setKmsKeyArn(kmsKeyArn);
return this;
}
/**
*
* The name of the S3 bucket.
*
*
* @param s3BucketName
* The name of the S3 bucket.
*/
public void setS3BucketName(String s3BucketName) {
this.s3BucketName = s3BucketName;
}
/**
*
* The name of the S3 bucket.
*
*
* @return The name of the S3 bucket.
*/
public String getS3BucketName() {
return this.s3BucketName;
}
/**
*
* The name of the S3 bucket.
*
*
* @param s3BucketName
* The name of the S3 bucket.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartMailboxExportJobRequest withS3BucketName(String s3BucketName) {
setS3BucketName(s3BucketName);
return this;
}
/**
*
* The S3 bucket prefix.
*
*
* @param s3Prefix
* The S3 bucket prefix.
*/
public void setS3Prefix(String s3Prefix) {
this.s3Prefix = s3Prefix;
}
/**
*
* The S3 bucket prefix.
*
*
* @return The S3 bucket prefix.
*/
public String getS3Prefix() {
return this.s3Prefix;
}
/**
*
* The S3 bucket prefix.
*
*
* @param s3Prefix
* The S3 bucket prefix.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartMailboxExportJobRequest withS3Prefix(String s3Prefix) {
setS3Prefix(s3Prefix);
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 (getClientToken() != null)
sb.append("ClientToken: ").append(getClientToken()).append(",");
if (getOrganizationId() != null)
sb.append("OrganizationId: ").append(getOrganizationId()).append(",");
if (getEntityId() != null)
sb.append("EntityId: ").append(getEntityId()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getRoleArn() != null)
sb.append("RoleArn: ").append(getRoleArn()).append(",");
if (getKmsKeyArn() != null)
sb.append("KmsKeyArn: ").append(getKmsKeyArn()).append(",");
if (getS3BucketName() != null)
sb.append("S3BucketName: ").append(getS3BucketName()).append(",");
if (getS3Prefix() != null)
sb.append("S3Prefix: ").append(getS3Prefix());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof StartMailboxExportJobRequest == false)
return false;
StartMailboxExportJobRequest other = (StartMailboxExportJobRequest) obj;
if (other.getClientToken() == null ^ this.getClientToken() == null)
return false;
if (other.getClientToken() != null && other.getClientToken().equals(this.getClientToken()) == false)
return false;
if (other.getOrganizationId() == null ^ this.getOrganizationId() == null)
return false;
if (other.getOrganizationId() != null && other.getOrganizationId().equals(this.getOrganizationId()) == false)
return false;
if (other.getEntityId() == null ^ this.getEntityId() == null)
return false;
if (other.getEntityId() != null && other.getEntityId().equals(this.getEntityId()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getRoleArn() == null ^ this.getRoleArn() == null)
return false;
if (other.getRoleArn() != null && other.getRoleArn().equals(this.getRoleArn()) == 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.getS3BucketName() == null ^ this.getS3BucketName() == null)
return false;
if (other.getS3BucketName() != null && other.getS3BucketName().equals(this.getS3BucketName()) == false)
return false;
if (other.getS3Prefix() == null ^ this.getS3Prefix() == null)
return false;
if (other.getS3Prefix() != null && other.getS3Prefix().equals(this.getS3Prefix()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getClientToken() == null) ? 0 : getClientToken().hashCode());
hashCode = prime * hashCode + ((getOrganizationId() == null) ? 0 : getOrganizationId().hashCode());
hashCode = prime * hashCode + ((getEntityId() == null) ? 0 : getEntityId().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getRoleArn() == null) ? 0 : getRoleArn().hashCode());
hashCode = prime * hashCode + ((getKmsKeyArn() == null) ? 0 : getKmsKeyArn().hashCode());
hashCode = prime * hashCode + ((getS3BucketName() == null) ? 0 : getS3BucketName().hashCode());
hashCode = prime * hashCode + ((getS3Prefix() == null) ? 0 : getS3Prefix().hashCode());
return hashCode;
}
@Override
public StartMailboxExportJobRequest clone() {
return (StartMailboxExportJobRequest) super.clone();
}
}