/*
* Copyright 2010-2014 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 com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.Request;
import com.amazonaws.services.ec2.model.transform.DetachVolumeRequestMarshaller;
/**
* Container for the parameters to the {@link com.amazonaws.services.ec2.AmazonEC2#detachVolume(DetachVolumeRequest) DetachVolume operation}.
* <p>
* Detaches an Amazon EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the
* volume. Failure to do so results in the volume being stuck in a busy state while detaching.
* </p>
* <p>
* If an Amazon EBS volume is the root device of an instance, it can't be detached while the instance is running. To detach the root volume, stop the
* instance first.
* </p>
* <p>
* If the root volume is detached from an instance with an AWS Marketplace product code, then the AWS Marketplace product codes from that volume are no
* longer associated with the instance.
* </p>
* <p>
* For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-detaching-volume.html"> Detaching an Amazon EBS Volume </a>
* in the <i>Amazon Elastic Compute Cloud User Guide</i> .
* </p>
*
* @see com.amazonaws.services.ec2.AmazonEC2#detachVolume(DetachVolumeRequest)
*/
public class DetachVolumeRequest extends AmazonWebServiceRequest implements Serializable, DryRunSupportedRequest<DetachVolumeRequest> {
/**
* The ID of the volume.
*/
private String volumeId;
/**
* The ID of the instance.
*/
private String instanceId;
/**
* The device name.
*/
private String device;
/**
* Forces detachment if the previous detachment attempt did not occur
* cleanly (for example, logging into an instance, unmounting the volume,
* and detaching normally). This option can lead to data loss or a
* corrupted file system. Use this option only as a last resort to detach
* a volume from a failed instance. The instance won't have an
* opportunity to flush file system caches or file system metadata. If
* you use this option, you must perform file system check and repair
* procedures.
*/
private Boolean force;
/**
* Default constructor for a new DetachVolumeRequest object. Callers should use the
* setter or fluent setter (with...) methods to initialize this object after creating it.
*/
public DetachVolumeRequest() {}
/**
* Constructs a new DetachVolumeRequest object.
* Callers should use the setter or fluent setter (with...) methods to
* initialize any additional object members.
*
* @param volumeId The ID of the volume.
*/
public DetachVolumeRequest(String volumeId) {
setVolumeId(volumeId);
}
/**
* The ID of the volume.
*
* @return The ID of the volume.
*/
public String getVolumeId() {
return volumeId;
}
/**
* The ID of the volume.
*
* @param volumeId The ID of the volume.
*/
public void setVolumeId(String volumeId) {
this.volumeId = volumeId;
}
/**
* The ID of the volume.
* <p>
* Returns a reference to this object so that method calls can be chained together.
*
* @param volumeId The ID of the volume.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DetachVolumeRequest withVolumeId(String volumeId) {
this.volumeId = volumeId;
return this;
}
/**
* The ID of the instance.
*
* @return The ID of the instance.
*/
public String getInstanceId() {
return instanceId;
}
/**
* The ID of the instance.
*
* @param instanceId The ID of the instance.
*/
public void setInstanceId(String instanceId) {
this.instanceId = instanceId;
}
/**
* The ID of the instance.
* <p>
* Returns a reference to this object so that method calls can be chained together.
*
* @param instanceId The ID of the instance.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DetachVolumeRequest withInstanceId(String instanceId) {
this.instanceId = instanceId;
return this;
}
/**
* The device name.
*
* @return The device name.
*/
public String getDevice() {
return device;
}
/**
* The device name.
*
* @param device The device name.
*/
public void setDevice(String device) {
this.device = device;
}
/**
* The device name.
* <p>
* Returns a reference to this object so that method calls can be chained together.
*
* @param device The device name.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DetachVolumeRequest withDevice(String device) {
this.device = device;
return this;
}
/**
* Forces detachment if the previous detachment attempt did not occur
* cleanly (for example, logging into an instance, unmounting the volume,
* and detaching normally). This option can lead to data loss or a
* corrupted file system. Use this option only as a last resort to detach
* a volume from a failed instance. The instance won't have an
* opportunity to flush file system caches or file system metadata. If
* you use this option, you must perform file system check and repair
* procedures.
*
* @return Forces detachment if the previous detachment attempt did not occur
* cleanly (for example, logging into an instance, unmounting the volume,
* and detaching normally). This option can lead to data loss or a
* corrupted file system. Use this option only as a last resort to detach
* a volume from a failed instance. The instance won't have an
* opportunity to flush file system caches or file system metadata. If
* you use this option, you must perform file system check and repair
* procedures.
*/
public Boolean isForce() {
return force;
}
/**
* Forces detachment if the previous detachment attempt did not occur
* cleanly (for example, logging into an instance, unmounting the volume,
* and detaching normally). This option can lead to data loss or a
* corrupted file system. Use this option only as a last resort to detach
* a volume from a failed instance. The instance won't have an
* opportunity to flush file system caches or file system metadata. If
* you use this option, you must perform file system check and repair
* procedures.
*
* @param force Forces detachment if the previous detachment attempt did not occur
* cleanly (for example, logging into an instance, unmounting the volume,
* and detaching normally). This option can lead to data loss or a
* corrupted file system. Use this option only as a last resort to detach
* a volume from a failed instance. The instance won't have an
* opportunity to flush file system caches or file system metadata. If
* you use this option, you must perform file system check and repair
* procedures.
*/
public void setForce(Boolean force) {
this.force = force;
}
/**
* Forces detachment if the previous detachment attempt did not occur
* cleanly (for example, logging into an instance, unmounting the volume,
* and detaching normally). This option can lead to data loss or a
* corrupted file system. Use this option only as a last resort to detach
* a volume from a failed instance. The instance won't have an
* opportunity to flush file system caches or file system metadata. If
* you use this option, you must perform file system check and repair
* procedures.
* <p>
* Returns a reference to this object so that method calls can be chained together.
*
* @param force Forces detachment if the previous detachment attempt did not occur
* cleanly (for example, logging into an instance, unmounting the volume,
* and detaching normally). This option can lead to data loss or a
* corrupted file system. Use this option only as a last resort to detach
* a volume from a failed instance. The instance won't have an
* opportunity to flush file system caches or file system metadata. If
* you use this option, you must perform file system check and repair
* procedures.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DetachVolumeRequest withForce(Boolean force) {
this.force = force;
return this;
}
/**
* Forces detachment if the previous detachment attempt did not occur
* cleanly (for example, logging into an instance, unmounting the volume,
* and detaching normally). This option can lead to data loss or a
* corrupted file system. Use this option only as a last resort to detach
* a volume from a failed instance. The instance won't have an
* opportunity to flush file system caches or file system metadata. If
* you use this option, you must perform file system check and repair
* procedures.
*
* @return Forces detachment if the previous detachment attempt did not occur
* cleanly (for example, logging into an instance, unmounting the volume,
* and detaching normally). This option can lead to data loss or a
* corrupted file system. Use this option only as a last resort to detach
* a volume from a failed instance. The instance won't have an
* opportunity to flush file system caches or file system metadata. If
* you use this option, you must perform file system check and repair
* procedures.
*/
public Boolean getForce() {
return force;
}
/**
* This method is intended for internal use only.
* Returns the marshaled request configured with additional parameters to
* enable operation dry-run.
*/
@Override
public Request<DetachVolumeRequest> getDryRunRequest() {
Request<DetachVolumeRequest> request = new DetachVolumeRequestMarshaller().marshall(this);
request.addParameter("DryRun", Boolean.toString(true));
return request;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getVolumeId() != null) sb.append("VolumeId: " + getVolumeId() + ",");
if (getInstanceId() != null) sb.append("InstanceId: " + getInstanceId() + ",");
if (getDevice() != null) sb.append("Device: " + getDevice() + ",");
if (isForce() != null) sb.append("Force: " + isForce() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getVolumeId() == null) ? 0 : getVolumeId().hashCode());
hashCode = prime * hashCode + ((getInstanceId() == null) ? 0 : getInstanceId().hashCode());
hashCode = prime * hashCode + ((getDevice() == null) ? 0 : getDevice().hashCode());
hashCode = prime * hashCode + ((isForce() == null) ? 0 : isForce().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof DetachVolumeRequest == false) return false;
DetachVolumeRequest other = (DetachVolumeRequest)obj;
if (other.getVolumeId() == null ^ this.getVolumeId() == null) return false;
if (other.getVolumeId() != null && other.getVolumeId().equals(this.getVolumeId()) == false) return false;
if (other.getInstanceId() == null ^ this.getInstanceId() == null) return false;
if (other.getInstanceId() != null && other.getInstanceId().equals(this.getInstanceId()) == false) return false;
if (other.getDevice() == null ^ this.getDevice() == null) return false;
if (other.getDevice() != null && other.getDevice().equals(this.getDevice()) == false) return false;
if (other.isForce() == null ^ this.isForce() == null) return false;
if (other.isForce() != null && other.isForce().equals(this.isForce()) == false) return false;
return true;
}
}