org.jclouds.aws.ec2.options.DescribeSnapshotsOptions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jclouds-aws Show documentation
jclouds Core components to access Amazon AWS
The newest version!
/**
 *
 * Copyright (C) 2010 Cloud Conscious, LLC. 
 *
 * ====================================================================
 * Licensed 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.aws.ec2.options;

import java.util.Set;

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

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

 * EC2Client connection = // get connection
 * Set snapshots = connection.getElasticBlockStoreServices().describeSnapshots(restorableBy("123125").snapshotIds(1000, 1004));
 * 
 * 
 * @author Adrian Cole
 * @see 
 */
public class DescribeSnapshotsOptions extends BaseEC2RequestOptions {

   /**
    * Account ID of a user that can create volumes from the snapshot.
    * 
    */
   public DescribeSnapshotsOptions restorableBy(String... accountIds) {
      indexFormValuesWithPrefix("RestorableBy", accountIds);
      return this;
   }

   public String getRestorableBy() {
      return getFirstFormOrNull("RestorableBy");
   }

   /**
    * The ID of the Amazon EBS snapshot.
    */
   public DescribeSnapshotsOptions snapshotIds(String... snapshotIds) {
      indexFormValuesWithPrefix("SnapshotId", snapshotIds);
      return this;
   }

   public Set getSnapshotIds() {
      return getFormValuesWithKeysPrefixedBy("SnapshotId.");
   }

   /**
    * Returns snapshots owned by the specified owner. Multiple owners can be specified.
    * 

    * Valid Values: self | amazon | AWS Account ID
    */
   public DescribeSnapshotsOptions ownedBy(String... owners) {
      indexFormValuesWithPrefix("Owner", owners);
      return this;
   }

   public Set getOwners() {
      return getFormValuesWithKeysPrefixedBy("Owner.");
   }

   public static class Builder {

      /**
       * @see DescribeSnapshotsOptions#restorableBy(String[] )
       */
      public static DescribeSnapshotsOptions restorableBy(String... accountIds) {
         DescribeSnapshotsOptions options = new DescribeSnapshotsOptions();
         return options.restorableBy(accountIds);
      }

      /**
       * @see DescribeSnapshotsOptions#snapshotIds(String[] )
       */
      public static DescribeSnapshotsOptions snapshotIds(String... snapshotIds) {
         DescribeSnapshotsOptions options = new DescribeSnapshotsOptions();
         return options.snapshotIds(snapshotIds);
      }

      /**
       * @see DescribeSnapshotsOptions#ownedBy(String[] )
       */
      public static DescribeSnapshotsOptions ownedBy(String... owners) {
         DescribeSnapshotsOptions options = new DescribeSnapshotsOptions();
         return options.ownedBy(owners);
      }

   }
}