com.amazonaws.services.ec2.model.ExportToS3TaskSpecification Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2018-2023 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.ec2.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* Describes an export instance task.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ExportToS3TaskSpecification implements Serializable, Cloneable {
/**
*
* The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is
* exported.
*
*/
private String containerFormat;
/**
*
* The format for the exported image.
*
*/
private String diskImageFormat;
/**
*
* The Amazon S3 bucket for the destination image. The destination bucket must exist and have an access control list
* (ACL) attached that specifies the Region-specific canonical account ID for the Grantee. For more
* information about the ACL to your S3 bucket, see Prerequisites in the VM Import/Export User Guide.
*
*/
private String s3Bucket;
/**
*
* The image is written to a single object in the Amazon S3 bucket at the S3 key s3prefix + exportTaskId + '.' +
* diskImageFormat.
*
*/
private String s3Prefix;
/**
*
* The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is
* exported.
*
*
* @param containerFormat
* The container format used to combine disk images with metadata (such as OVF). If absent, only the disk
* image is exported.
* @see ContainerFormat
*/
public void setContainerFormat(String containerFormat) {
this.containerFormat = containerFormat;
}
/**
*
* The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is
* exported.
*
*
* @return The container format used to combine disk images with metadata (such as OVF). If absent, only the disk
* image is exported.
* @see ContainerFormat
*/
public String getContainerFormat() {
return this.containerFormat;
}
/**
*
* The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is
* exported.
*
*
* @param containerFormat
* The container format used to combine disk images with metadata (such as OVF). If absent, only the disk
* image is exported.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ContainerFormat
*/
public ExportToS3TaskSpecification withContainerFormat(String containerFormat) {
setContainerFormat(containerFormat);
return this;
}
/**
*
* The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is
* exported.
*
*
* @param containerFormat
* The container format used to combine disk images with metadata (such as OVF). If absent, only the disk
* image is exported.
* @see ContainerFormat
*/
public void setContainerFormat(ContainerFormat containerFormat) {
withContainerFormat(containerFormat);
}
/**
*
* The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is
* exported.
*
*
* @param containerFormat
* The container format used to combine disk images with metadata (such as OVF). If absent, only the disk
* image is exported.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ContainerFormat
*/
public ExportToS3TaskSpecification withContainerFormat(ContainerFormat containerFormat) {
this.containerFormat = containerFormat.toString();
return this;
}
/**
*
* The format for the exported image.
*
*
* @param diskImageFormat
* The format for the exported image.
* @see DiskImageFormat
*/
public void setDiskImageFormat(String diskImageFormat) {
this.diskImageFormat = diskImageFormat;
}
/**
*
* The format for the exported image.
*
*
* @return The format for the exported image.
* @see DiskImageFormat
*/
public String getDiskImageFormat() {
return this.diskImageFormat;
}
/**
*
* The format for the exported image.
*
*
* @param diskImageFormat
* The format for the exported image.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DiskImageFormat
*/
public ExportToS3TaskSpecification withDiskImageFormat(String diskImageFormat) {
setDiskImageFormat(diskImageFormat);
return this;
}
/**
*
* The format for the exported image.
*
*
* @param diskImageFormat
* The format for the exported image.
* @see DiskImageFormat
*/
public void setDiskImageFormat(DiskImageFormat diskImageFormat) {
withDiskImageFormat(diskImageFormat);
}
/**
*
* The format for the exported image.
*
*
* @param diskImageFormat
* The format for the exported image.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DiskImageFormat
*/
public ExportToS3TaskSpecification withDiskImageFormat(DiskImageFormat diskImageFormat) {
this.diskImageFormat = diskImageFormat.toString();
return this;
}
/**
*
* The Amazon S3 bucket for the destination image. The destination bucket must exist and have an access control list
* (ACL) attached that specifies the Region-specific canonical account ID for the Grantee. For more
* information about the ACL to your S3 bucket, see Prerequisites in the VM Import/Export User Guide.
*
*
* @param s3Bucket
* The Amazon S3 bucket for the destination image. The destination bucket must exist and have an access
* control list (ACL) attached that specifies the Region-specific canonical account ID for the
* Grantee. For more information about the ACL to your S3 bucket, see Prerequisites in the VM Import/Export User Guide.
*/
public void setS3Bucket(String s3Bucket) {
this.s3Bucket = s3Bucket;
}
/**
*
* The Amazon S3 bucket for the destination image. The destination bucket must exist and have an access control list
* (ACL) attached that specifies the Region-specific canonical account ID for the Grantee. For more
* information about the ACL to your S3 bucket, see Prerequisites in the VM Import/Export User Guide.
*
*
* @return The Amazon S3 bucket for the destination image. The destination bucket must exist and have an access
* control list (ACL) attached that specifies the Region-specific canonical account ID for the
* Grantee. For more information about the ACL to your S3 bucket, see Prerequisites in the VM Import/Export User Guide.
*/
public String getS3Bucket() {
return this.s3Bucket;
}
/**
*
* The Amazon S3 bucket for the destination image. The destination bucket must exist and have an access control list
* (ACL) attached that specifies the Region-specific canonical account ID for the Grantee. For more
* information about the ACL to your S3 bucket, see Prerequisites in the VM Import/Export User Guide.
*
*
* @param s3Bucket
* The Amazon S3 bucket for the destination image. The destination bucket must exist and have an access
* control list (ACL) attached that specifies the Region-specific canonical account ID for the
* Grantee. For more information about the ACL to your S3 bucket, see Prerequisites in the VM Import/Export User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ExportToS3TaskSpecification withS3Bucket(String s3Bucket) {
setS3Bucket(s3Bucket);
return this;
}
/**
*
* The image is written to a single object in the Amazon S3 bucket at the S3 key s3prefix + exportTaskId + '.' +
* diskImageFormat.
*
*
* @param s3Prefix
* The image is written to a single object in the Amazon S3 bucket at the S3 key s3prefix + exportTaskId +
* '.' + diskImageFormat.
*/
public void setS3Prefix(String s3Prefix) {
this.s3Prefix = s3Prefix;
}
/**
*
* The image is written to a single object in the Amazon S3 bucket at the S3 key s3prefix + exportTaskId + '.' +
* diskImageFormat.
*
*
* @return The image is written to a single object in the Amazon S3 bucket at the S3 key s3prefix + exportTaskId +
* '.' + diskImageFormat.
*/
public String getS3Prefix() {
return this.s3Prefix;
}
/**
*
* The image is written to a single object in the Amazon S3 bucket at the S3 key s3prefix + exportTaskId + '.' +
* diskImageFormat.
*
*
* @param s3Prefix
* The image is written to a single object in the Amazon S3 bucket at the S3 key s3prefix + exportTaskId +
* '.' + diskImageFormat.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ExportToS3TaskSpecification 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 (getContainerFormat() != null)
sb.append("ContainerFormat: ").append(getContainerFormat()).append(",");
if (getDiskImageFormat() != null)
sb.append("DiskImageFormat: ").append(getDiskImageFormat()).append(",");
if (getS3Bucket() != null)
sb.append("S3Bucket: ").append(getS3Bucket()).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 ExportToS3TaskSpecification == false)
return false;
ExportToS3TaskSpecification other = (ExportToS3TaskSpecification) obj;
if (other.getContainerFormat() == null ^ this.getContainerFormat() == null)
return false;
if (other.getContainerFormat() != null && other.getContainerFormat().equals(this.getContainerFormat()) == false)
return false;
if (other.getDiskImageFormat() == null ^ this.getDiskImageFormat() == null)
return false;
if (other.getDiskImageFormat() != null && other.getDiskImageFormat().equals(this.getDiskImageFormat()) == false)
return false;
if (other.getS3Bucket() == null ^ this.getS3Bucket() == null)
return false;
if (other.getS3Bucket() != null && other.getS3Bucket().equals(this.getS3Bucket()) == 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 + ((getContainerFormat() == null) ? 0 : getContainerFormat().hashCode());
hashCode = prime * hashCode + ((getDiskImageFormat() == null) ? 0 : getDiskImageFormat().hashCode());
hashCode = prime * hashCode + ((getS3Bucket() == null) ? 0 : getS3Bucket().hashCode());
hashCode = prime * hashCode + ((getS3Prefix() == null) ? 0 : getS3Prefix().hashCode());
return hashCode;
}
@Override
public ExportToS3TaskSpecification clone() {
try {
return (ExportToS3TaskSpecification) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}