org.jclouds.ec2.options.DetachVolumeOptions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ec2 Show documentation
jclouds components to access an implementation of EC2
There is a newer version: 2.7.0
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License 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 org.jclouds.ec2.options;

import static com.google.common.base.Preconditions.checkNotNull;

import org.jclouds.ec2.options.internal.BaseEC2RequestOptions;

/**
 * Contains options supported in the Form API for the DetachVolume operation. 
 * Usage The recommended way to instantiate a DetachVolumeOptions object is to statically
 * import DetachVolumeOptions.Builder.* and invoke a static creation method followed by an instance
 * mutator (if needed):
 * 
 * 
 * import static org.jclouds.ec2.options.DetachVolumeOptions.Builder.*
 * 

 * EC2Api client = // get connection
 * client.getElasticBlockStoreApi().get().detachVolumeInRegion(null, id, fromDevice("123125").force());
 * 
 * 
 * @see 
 */
public class DetachVolumeOptions extends BaseEC2RequestOptions {
   /**
    * The ID of the instance.
    */
   public DetachVolumeOptions fromInstance(String instanceId) {
      formParameters.put("InstanceId", checkNotNull(instanceId, "instanceId"));
      return this;
   }

   public String getInstance() {
      return getFirstFormOrNull("InstanceId");

   }

   /**
    * The device name.
    */
   public DetachVolumeOptions fromDevice(String device) {
      formParameters.put("Device", checkNotNull(device, "device"));
      return this;
   }

   public String getDevice() {
      return getFirstFormOrNull("Device");

   }

   public static class Builder {
      /**
       * @see DetachVolumeOptions#fromInstance(String )
       */
      public static DetachVolumeOptions fromInstance(String instance) {
         DetachVolumeOptions options = new DetachVolumeOptions();
         return options.fromInstance(instance);
      }

      /**
       * @see DetachVolumeOptions#fromDevice(String )
       */
      public static DetachVolumeOptions fromDevice(String device) {
         DetachVolumeOptions options = new DetachVolumeOptions();
         return options.fromDevice(device);
      }

   }
}