com.amazonaws.services.ec2.model.DeleteVolumeRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* 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.DeleteVolumeRequestMarshaller;
/**
* Container for the parameters to the {@link com.amazonaws.services.ec2.AmazonEC2#deleteVolume(DeleteVolumeRequest) DeleteVolume operation}.
*
* Deletes the specified Amazon EBS volume. The volume must be in the
* available state (not attached to an instance).
*
*
* NOTE: The volume may remain in the deleting state for several
* minutes.
*
*
* For more information, see
* Deleting an Amazon EBS Volume
* in the Amazon Elastic Compute Cloud User Guide .
*
*
* @see com.amazonaws.services.ec2.AmazonEC2#deleteVolume(DeleteVolumeRequest)
*/
public class DeleteVolumeRequest extends AmazonWebServiceRequest implements Serializable, DryRunSupportedRequest {
/**
* The ID of the volume.
*/
private String volumeId;
/**
* Default constructor for a new DeleteVolumeRequest object. Callers should use the
* setter or fluent setter (with...) methods to initialize this object after creating it.
*/
public DeleteVolumeRequest() {}
/**
* Constructs a new DeleteVolumeRequest 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 DeleteVolumeRequest(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.
*
* 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 DeleteVolumeRequest withVolumeId(String volumeId) {
this.volumeId = volumeId;
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 DeleteVolumeRequestMarshaller().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() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getVolumeId() == null) ? 0 : getVolumeId().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof DeleteVolumeRequest == false) return false;
DeleteVolumeRequest other = (DeleteVolumeRequest)obj;
if (other.getVolumeId() == null ^ this.getVolumeId() == null) return false;
if (other.getVolumeId() != null && other.getVolumeId().equals(this.getVolumeId()) == false) return false;
return true;
}
}