org.jclouds.ec2.options.CreateSnapshotOptions 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 CreateSnapshot operation. 
 * Usage The recommended way to instantiate a CreateSnapshotOptions object is to statically
 * import CreateSnapshotOptions.Builder.* and invoke a static creation method followed by an
 * instance mutator (if needed):
 * 
 * 
 * import static org.jclouds.ec2.options.CreateSnapshotOptions.Builder.*
 * 

 * EC2Api connection = // get connection
 * Snapshot snapshot = connection.getElasticBlockStoreApi().get().createSnapshotInRegion(volumeId, withDescription("123125"));
 * 
 * 
 * @see 
 */
public class CreateSnapshotOptions extends BaseEC2RequestOptions {

   /**
    * Description of the Amazon EBS snapshot.
    * 

    * 
    * Up to 255 characters
    */
   public CreateSnapshotOptions withDescription(String description) {
      formParameters.put("Description", checkNotNull(description, "description"));
      return this;
   }

   public String getDescription() {
      return getFirstFormOrNull("Description");

   }

   public static class Builder {

      /**
       * @see CreateSnapshotOptions#withDescription(String )
       */
      public static CreateSnapshotOptions withDescription(String identityId) {
         CreateSnapshotOptions options = new CreateSnapshotOptions();
         return options.withDescription(identityId);
      }

   }
}