/* * 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; import com.amazonaws.AmazonWebServiceRequest; import com.amazonaws.Request; import com.amazonaws.services.ec2.model.transform.ImportSnapshotRequestMarshaller; /** * */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class ImportSnapshotRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest { /** *

* The client-specific data. *

*/ private ClientData clientData; /** *

* Token to enable idempotency for VM import requests. *

*/ private String clientToken; /** *

* The description string for the import snapshot task. *

*/ private String description; /** *

* Information about the disk container. *

*/ private SnapshotDiskContainer diskContainer; /** *

* Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key for EBS * is used unless you specify a non-default KMS key using KmsKeyId. For more information, see Amazon EBS Encryption in the * Amazon Elastic Compute Cloud User Guide. *

*/ private Boolean encrypted; /** *

* An identifier for the symmetric KMS key to use when creating the encrypted snapshot. This parameter is only * required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for * EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set. *

*

* The KMS key identifier may be provided in any of the following formats: *

* *

* Amazon Web Services parses KmsKeyId asynchronously, meaning that the action you call may appear to * complete even though you provided an invalid identifier. This action will eventually report failure. *

*

* The specified KMS key must exist in the Region that the snapshot is being copied to. *

*

* Amazon EBS does not support asymmetric KMS keys. *

*/ private String kmsKeyId; /** *

* The name of the role to use when not using the default role, 'vmimport'. *

*/ private String roleName; /** *

* The tags to apply to the import snapshot task during creation. *

*/ private com.amazonaws.internal.SdkInternalList tagSpecifications; /** *

* The client-specific data. *

* * @param clientData * The client-specific data. */ public void setClientData(ClientData clientData) { this.clientData = clientData; } /** *

* The client-specific data. *

* * @return The client-specific data. */ public ClientData getClientData() { return this.clientData; } /** *

* The client-specific data. *

* * @param clientData * The client-specific data. * @return Returns a reference to this object so that method calls can be chained together. */ public ImportSnapshotRequest withClientData(ClientData clientData) { setClientData(clientData); return this; } /** *

* Token to enable idempotency for VM import requests. *

* * @param clientToken * Token to enable idempotency for VM import requests. */ public void setClientToken(String clientToken) { this.clientToken = clientToken; } /** *

* Token to enable idempotency for VM import requests. *

* * @return Token to enable idempotency for VM import requests. */ public String getClientToken() { return this.clientToken; } /** *

* Token to enable idempotency for VM import requests. *

* * @param clientToken * Token to enable idempotency for VM import requests. * @return Returns a reference to this object so that method calls can be chained together. */ public ImportSnapshotRequest withClientToken(String clientToken) { setClientToken(clientToken); return this; } /** *

* The description string for the import snapshot task. *

* * @param description * The description string for the import snapshot task. */ public void setDescription(String description) { this.description = description; } /** *

* The description string for the import snapshot task. *

* * @return The description string for the import snapshot task. */ public String getDescription() { return this.description; } /** *

* The description string for the import snapshot task. *

* * @param description * The description string for the import snapshot task. * @return Returns a reference to this object so that method calls can be chained together. */ public ImportSnapshotRequest withDescription(String description) { setDescription(description); return this; } /** *

* Information about the disk container. *

* * @param diskContainer * Information about the disk container. */ public void setDiskContainer(SnapshotDiskContainer diskContainer) { this.diskContainer = diskContainer; } /** *

* Information about the disk container. *

* * @return Information about the disk container. */ public SnapshotDiskContainer getDiskContainer() { return this.diskContainer; } /** *

* Information about the disk container. *

* * @param diskContainer * Information about the disk container. * @return Returns a reference to this object so that method calls can be chained together. */ public ImportSnapshotRequest withDiskContainer(SnapshotDiskContainer diskContainer) { setDiskContainer(diskContainer); return this; } /** *

* Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key for EBS * is used unless you specify a non-default KMS key using KmsKeyId. For more information, see Amazon EBS Encryption in the * Amazon Elastic Compute Cloud User Guide. *

* * @param encrypted * Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key * for EBS is used unless you specify a non-default KMS key using KmsKeyId. For more * information, see Amazon * EBS Encryption in the Amazon Elastic Compute Cloud User Guide. */ public void setEncrypted(Boolean encrypted) { this.encrypted = encrypted; } /** *

* Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key for EBS * is used unless you specify a non-default KMS key using KmsKeyId. For more information, see Amazon EBS Encryption in the * Amazon Elastic Compute Cloud User Guide. *

* * @return Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key * for EBS is used unless you specify a non-default KMS key using KmsKeyId. For more * information, see Amazon * EBS Encryption in the Amazon Elastic Compute Cloud User Guide. */ public Boolean getEncrypted() { return this.encrypted; } /** *

* Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key for EBS * is used unless you specify a non-default KMS key using KmsKeyId. For more information, see Amazon EBS Encryption in the * Amazon Elastic Compute Cloud User Guide. *

* * @param encrypted * Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key * for EBS is used unless you specify a non-default KMS key using KmsKeyId. For more * information, see Amazon * EBS Encryption in the Amazon Elastic Compute Cloud User Guide. * @return Returns a reference to this object so that method calls can be chained together. */ public ImportSnapshotRequest withEncrypted(Boolean encrypted) { setEncrypted(encrypted); return this; } /** *

* Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key for EBS * is used unless you specify a non-default KMS key using KmsKeyId. For more information, see Amazon EBS Encryption in the * Amazon Elastic Compute Cloud User Guide. *

* * @return Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key * for EBS is used unless you specify a non-default KMS key using KmsKeyId. For more * information, see Amazon * EBS Encryption in the Amazon Elastic Compute Cloud User Guide. */ public Boolean isEncrypted() { return this.encrypted; } /** *

* An identifier for the symmetric KMS key to use when creating the encrypted snapshot. This parameter is only * required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for * EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set. *

*

* The KMS key identifier may be provided in any of the following formats: *

* *

* Amazon Web Services parses KmsKeyId asynchronously, meaning that the action you call may appear to * complete even though you provided an invalid identifier. This action will eventually report failure. *

*

* The specified KMS key must exist in the Region that the snapshot is being copied to. *

*

* Amazon EBS does not support asymmetric KMS keys. *

* * @param kmsKeyId * An identifier for the symmetric KMS key to use when creating the encrypted snapshot. This parameter is * only required if you want to use a non-default KMS key; if this parameter is not specified, the default * KMS key for EBS is used. If a KmsKeyId is specified, the Encrypted flag must * also be set.

*

* The KMS key identifier may be provided in any of the following formats: *

* *

* Amazon Web Services parses KmsKeyId asynchronously, meaning that the action you call may * appear to complete even though you provided an invalid identifier. This action will eventually report * failure. *

*

* The specified KMS key must exist in the Region that the snapshot is being copied to. *

*

* Amazon EBS does not support asymmetric KMS keys. */ public void setKmsKeyId(String kmsKeyId) { this.kmsKeyId = kmsKeyId; } /** *

* An identifier for the symmetric KMS key to use when creating the encrypted snapshot. This parameter is only * required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for * EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set. *

*

* The KMS key identifier may be provided in any of the following formats: *

* *

* Amazon Web Services parses KmsKeyId asynchronously, meaning that the action you call may appear to * complete even though you provided an invalid identifier. This action will eventually report failure. *

*

* The specified KMS key must exist in the Region that the snapshot is being copied to. *

*

* Amazon EBS does not support asymmetric KMS keys. *

* * @return An identifier for the symmetric KMS key to use when creating the encrypted snapshot. This parameter is * only required if you want to use a non-default KMS key; if this parameter is not specified, the default * KMS key for EBS is used. If a KmsKeyId is specified, the Encrypted flag must * also be set.

*

* The KMS key identifier may be provided in any of the following formats: *

* *

* Amazon Web Services parses KmsKeyId asynchronously, meaning that the action you call may * appear to complete even though you provided an invalid identifier. This action will eventually report * failure. *

*

* The specified KMS key must exist in the Region that the snapshot is being copied to. *

*

* Amazon EBS does not support asymmetric KMS keys. */ public String getKmsKeyId() { return this.kmsKeyId; } /** *

* An identifier for the symmetric KMS key to use when creating the encrypted snapshot. This parameter is only * required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for * EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set. *

*

* The KMS key identifier may be provided in any of the following formats: *

* *

* Amazon Web Services parses KmsKeyId asynchronously, meaning that the action you call may appear to * complete even though you provided an invalid identifier. This action will eventually report failure. *

*

* The specified KMS key must exist in the Region that the snapshot is being copied to. *

*

* Amazon EBS does not support asymmetric KMS keys. *

* * @param kmsKeyId * An identifier for the symmetric KMS key to use when creating the encrypted snapshot. This parameter is * only required if you want to use a non-default KMS key; if this parameter is not specified, the default * KMS key for EBS is used. If a KmsKeyId is specified, the Encrypted flag must * also be set.

*

* The KMS key identifier may be provided in any of the following formats: *

* *

* Amazon Web Services parses KmsKeyId asynchronously, meaning that the action you call may * appear to complete even though you provided an invalid identifier. This action will eventually report * failure. *

*

* The specified KMS key must exist in the Region that the snapshot is being copied to. *

*

* Amazon EBS does not support asymmetric KMS keys. * @return Returns a reference to this object so that method calls can be chained together. */ public ImportSnapshotRequest withKmsKeyId(String kmsKeyId) { setKmsKeyId(kmsKeyId); return this; } /** *

* The name of the role to use when not using the default role, 'vmimport'. *

* * @param roleName * The name of the role to use when not using the default role, 'vmimport'. */ public void setRoleName(String roleName) { this.roleName = roleName; } /** *

* The name of the role to use when not using the default role, 'vmimport'. *

* * @return The name of the role to use when not using the default role, 'vmimport'. */ public String getRoleName() { return this.roleName; } /** *

* The name of the role to use when not using the default role, 'vmimport'. *

* * @param roleName * The name of the role to use when not using the default role, 'vmimport'. * @return Returns a reference to this object so that method calls can be chained together. */ public ImportSnapshotRequest withRoleName(String roleName) { setRoleName(roleName); return this; } /** *

* The tags to apply to the import snapshot task during creation. *

* * @return The tags to apply to the import snapshot task during creation. */ public java.util.List getTagSpecifications() { if (tagSpecifications == null) { tagSpecifications = new com.amazonaws.internal.SdkInternalList(); } return tagSpecifications; } /** *

* The tags to apply to the import snapshot task during creation. *

* * @param tagSpecifications * The tags to apply to the import snapshot task during creation. */ public void setTagSpecifications(java.util.Collection tagSpecifications) { if (tagSpecifications == null) { this.tagSpecifications = null; return; } this.tagSpecifications = new com.amazonaws.internal.SdkInternalList(tagSpecifications); } /** *

* The tags to apply to the import snapshot task during creation. *

*

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setTagSpecifications(java.util.Collection)} or {@link #withTagSpecifications(java.util.Collection)} if * you want to override the existing values. *

* * @param tagSpecifications * The tags to apply to the import snapshot task during creation. * @return Returns a reference to this object so that method calls can be chained together. */ public ImportSnapshotRequest withTagSpecifications(TagSpecification... tagSpecifications) { if (this.tagSpecifications == null) { setTagSpecifications(new com.amazonaws.internal.SdkInternalList(tagSpecifications.length)); } for (TagSpecification ele : tagSpecifications) { this.tagSpecifications.add(ele); } return this; } /** *

* The tags to apply to the import snapshot task during creation. *

* * @param tagSpecifications * The tags to apply to the import snapshot task during creation. * @return Returns a reference to this object so that method calls can be chained together. */ public ImportSnapshotRequest withTagSpecifications(java.util.Collection tagSpecifications) { setTagSpecifications(tagSpecifications); return this; } /** * This method is intended for internal use only. Returns the marshaled request configured with additional * parameters to enable operation dry-run. */ @Override public Request getDryRunRequest() { Request request = new ImportSnapshotRequestMarshaller().marshall(this); request.addParameter("DryRun", Boolean.toString(true)); return request; } /** * 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 (getClientData() != null) sb.append("ClientData: ").append(getClientData()).append(","); if (getClientToken() != null) sb.append("ClientToken: ").append(getClientToken()).append(","); if (getDescription() != null) sb.append("Description: ").append(getDescription()).append(","); if (getDiskContainer() != null) sb.append("DiskContainer: ").append(getDiskContainer()).append(","); if (getEncrypted() != null) sb.append("Encrypted: ").append(getEncrypted()).append(","); if (getKmsKeyId() != null) sb.append("KmsKeyId: ").append(getKmsKeyId()).append(","); if (getRoleName() != null) sb.append("RoleName: ").append(getRoleName()).append(","); if (getTagSpecifications() != null) sb.append("TagSpecifications: ").append(getTagSpecifications()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof ImportSnapshotRequest == false) return false; ImportSnapshotRequest other = (ImportSnapshotRequest) obj; if (other.getClientData() == null ^ this.getClientData() == null) return false; if (other.getClientData() != null && other.getClientData().equals(this.getClientData()) == 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.getDescription() == null ^ this.getDescription() == null) return false; if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false) return false; if (other.getDiskContainer() == null ^ this.getDiskContainer() == null) return false; if (other.getDiskContainer() != null && other.getDiskContainer().equals(this.getDiskContainer()) == false) return false; if (other.getEncrypted() == null ^ this.getEncrypted() == null) return false; if (other.getEncrypted() != null && other.getEncrypted().equals(this.getEncrypted()) == 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.getRoleName() == null ^ this.getRoleName() == null) return false; if (other.getRoleName() != null && other.getRoleName().equals(this.getRoleName()) == false) return false; if (other.getTagSpecifications() == null ^ this.getTagSpecifications() == null) return false; if (other.getTagSpecifications() != null && other.getTagSpecifications().equals(this.getTagSpecifications()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getClientData() == null) ? 0 : getClientData().hashCode()); hashCode = prime * hashCode + ((getClientToken() == null) ? 0 : getClientToken().hashCode()); hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode()); hashCode = prime * hashCode + ((getDiskContainer() == null) ? 0 : getDiskContainer().hashCode()); hashCode = prime * hashCode + ((getEncrypted() == null) ? 0 : getEncrypted().hashCode()); hashCode = prime * hashCode + ((getKmsKeyId() == null) ? 0 : getKmsKeyId().hashCode()); hashCode = prime * hashCode + ((getRoleName() == null) ? 0 : getRoleName().hashCode()); hashCode = prime * hashCode + ((getTagSpecifications() == null) ? 0 : getTagSpecifications().hashCode()); return hashCode; } @Override public ImportSnapshotRequest clone() { return (ImportSnapshotRequest) super.clone(); } }