com.amazonaws.services.workmail.model.MailboxExportJob 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 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.workmail.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* The details of a mailbox export job, including the user or resource ID associated with the mailbox and the S3 bucket
* that the mailbox contents are exported to.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class MailboxExportJob implements Serializable, Cloneable, StructuredPojo {
/**
*
* The identifier of the mailbox export job.
*
*/
private String jobId;
/**
*
* The identifier of the user or resource associated with the mailbox.
*
*/
private String entityId;
/**
*
* The mailbox export job description.
*
*/
private String description;
/**
*
* The name of the S3 bucket.
*
*/
private String s3BucketName;
/**
*
* The path to the S3 bucket and file that the mailbox export job exports to.
*
*/
private String s3Path;
/**
*
* The estimated progress of the mailbox export job, in percentage points.
*
*/
private Integer estimatedProgress;
/**
*
* The state of the mailbox export job.
*
*/
private String state;
/**
*
* The mailbox export job start timestamp.
*
*/
private java.util.Date startTime;
/**
*
* The mailbox export job end timestamp.
*
*/
private java.util.Date endTime;
/**
*
* The identifier of the mailbox export job.
*
*
* @param jobId
* The identifier of the mailbox export job.
*/
public void setJobId(String jobId) {
this.jobId = jobId;
}
/**
*
* The identifier of the mailbox export job.
*
*
* @return The identifier of the mailbox export job.
*/
public String getJobId() {
return this.jobId;
}
/**
*
* The identifier of the mailbox export job.
*
*
* @param jobId
* The identifier of the mailbox export job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MailboxExportJob withJobId(String jobId) {
setJobId(jobId);
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 MailboxExportJob 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 MailboxExportJob withDescription(String description) {
setDescription(description);
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 MailboxExportJob withS3BucketName(String s3BucketName) {
setS3BucketName(s3BucketName);
return this;
}
/**
*
* The path to the S3 bucket and file that the mailbox export job exports to.
*
*
* @param s3Path
* The path to the S3 bucket and file that the mailbox export job exports to.
*/
public void setS3Path(String s3Path) {
this.s3Path = s3Path;
}
/**
*
* The path to the S3 bucket and file that the mailbox export job exports to.
*
*
* @return The path to the S3 bucket and file that the mailbox export job exports to.
*/
public String getS3Path() {
return this.s3Path;
}
/**
*
* The path to the S3 bucket and file that the mailbox export job exports to.
*
*
* @param s3Path
* The path to the S3 bucket and file that the mailbox export job exports to.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MailboxExportJob withS3Path(String s3Path) {
setS3Path(s3Path);
return this;
}
/**
*
* The estimated progress of the mailbox export job, in percentage points.
*
*
* @param estimatedProgress
* The estimated progress of the mailbox export job, in percentage points.
*/
public void setEstimatedProgress(Integer estimatedProgress) {
this.estimatedProgress = estimatedProgress;
}
/**
*
* The estimated progress of the mailbox export job, in percentage points.
*
*
* @return The estimated progress of the mailbox export job, in percentage points.
*/
public Integer getEstimatedProgress() {
return this.estimatedProgress;
}
/**
*
* The estimated progress of the mailbox export job, in percentage points.
*
*
* @param estimatedProgress
* The estimated progress of the mailbox export job, in percentage points.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MailboxExportJob withEstimatedProgress(Integer estimatedProgress) {
setEstimatedProgress(estimatedProgress);
return this;
}
/**
*
* The state of the mailbox export job.
*
*
* @param state
* The state of the mailbox export job.
* @see MailboxExportJobState
*/
public void setState(String state) {
this.state = state;
}
/**
*
* The state of the mailbox export job.
*
*
* @return The state of the mailbox export job.
* @see MailboxExportJobState
*/
public String getState() {
return this.state;
}
/**
*
* The state of the mailbox export job.
*
*
* @param state
* The state of the mailbox export job.
* @return Returns a reference to this object so that method calls can be chained together.
* @see MailboxExportJobState
*/
public MailboxExportJob withState(String state) {
setState(state);
return this;
}
/**
*
* The state of the mailbox export job.
*
*
* @param state
* The state of the mailbox export job.
* @return Returns a reference to this object so that method calls can be chained together.
* @see MailboxExportJobState
*/
public MailboxExportJob withState(MailboxExportJobState state) {
this.state = state.toString();
return this;
}
/**
*
* The mailbox export job start timestamp.
*
*
* @param startTime
* The mailbox export job start timestamp.
*/
public void setStartTime(java.util.Date startTime) {
this.startTime = startTime;
}
/**
*
* The mailbox export job start timestamp.
*
*
* @return The mailbox export job start timestamp.
*/
public java.util.Date getStartTime() {
return this.startTime;
}
/**
*
* The mailbox export job start timestamp.
*
*
* @param startTime
* The mailbox export job start timestamp.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MailboxExportJob withStartTime(java.util.Date startTime) {
setStartTime(startTime);
return this;
}
/**
*
* The mailbox export job end timestamp.
*
*
* @param endTime
* The mailbox export job end timestamp.
*/
public void setEndTime(java.util.Date endTime) {
this.endTime = endTime;
}
/**
*
* The mailbox export job end timestamp.
*
*
* @return The mailbox export job end timestamp.
*/
public java.util.Date getEndTime() {
return this.endTime;
}
/**
*
* The mailbox export job end timestamp.
*
*
* @param endTime
* The mailbox export job end timestamp.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MailboxExportJob withEndTime(java.util.Date endTime) {
setEndTime(endTime);
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 (getJobId() != null)
sb.append("JobId: ").append(getJobId()).append(",");
if (getEntityId() != null)
sb.append("EntityId: ").append(getEntityId()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getS3BucketName() != null)
sb.append("S3BucketName: ").append(getS3BucketName()).append(",");
if (getS3Path() != null)
sb.append("S3Path: ").append(getS3Path()).append(",");
if (getEstimatedProgress() != null)
sb.append("EstimatedProgress: ").append(getEstimatedProgress()).append(",");
if (getState() != null)
sb.append("State: ").append(getState()).append(",");
if (getStartTime() != null)
sb.append("StartTime: ").append(getStartTime()).append(",");
if (getEndTime() != null)
sb.append("EndTime: ").append(getEndTime());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof MailboxExportJob == false)
return false;
MailboxExportJob other = (MailboxExportJob) obj;
if (other.getJobId() == null ^ this.getJobId() == null)
return false;
if (other.getJobId() != null && other.getJobId().equals(this.getJobId()) == 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.getS3BucketName() == null ^ this.getS3BucketName() == null)
return false;
if (other.getS3BucketName() != null && other.getS3BucketName().equals(this.getS3BucketName()) == false)
return false;
if (other.getS3Path() == null ^ this.getS3Path() == null)
return false;
if (other.getS3Path() != null && other.getS3Path().equals(this.getS3Path()) == false)
return false;
if (other.getEstimatedProgress() == null ^ this.getEstimatedProgress() == null)
return false;
if (other.getEstimatedProgress() != null && other.getEstimatedProgress().equals(this.getEstimatedProgress()) == false)
return false;
if (other.getState() == null ^ this.getState() == null)
return false;
if (other.getState() != null && other.getState().equals(this.getState()) == false)
return false;
if (other.getStartTime() == null ^ this.getStartTime() == null)
return false;
if (other.getStartTime() != null && other.getStartTime().equals(this.getStartTime()) == false)
return false;
if (other.getEndTime() == null ^ this.getEndTime() == null)
return false;
if (other.getEndTime() != null && other.getEndTime().equals(this.getEndTime()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getJobId() == null) ? 0 : getJobId().hashCode());
hashCode = prime * hashCode + ((getEntityId() == null) ? 0 : getEntityId().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getS3BucketName() == null) ? 0 : getS3BucketName().hashCode());
hashCode = prime * hashCode + ((getS3Path() == null) ? 0 : getS3Path().hashCode());
hashCode = prime * hashCode + ((getEstimatedProgress() == null) ? 0 : getEstimatedProgress().hashCode());
hashCode = prime * hashCode + ((getState() == null) ? 0 : getState().hashCode());
hashCode = prime * hashCode + ((getStartTime() == null) ? 0 : getStartTime().hashCode());
hashCode = prime * hashCode + ((getEndTime() == null) ? 0 : getEndTime().hashCode());
return hashCode;
}
@Override
public MailboxExportJob clone() {
try {
return (MailboxExportJob) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.workmail.model.transform.MailboxExportJobMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}