org.jclouds.aws.ec2.options.DescribeImagesOptions 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 static com.google.common.base.Preconditions.checkNotNull;

import java.util.Set;

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

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

 * EC2Client connection = // get connection
 * Future> images = connection.getAMIServices().describeImages(executableBy("123125").imageIds(1000, 1004));
 * 
 * 
 * @author Adrian Cole
 * @see 
 */
public class DescribeImagesOptions extends BaseEC2RequestOptions {
   public static final DescribeImagesOptions NONE = new DescribeImagesOptions();

   /**
    * AMIs for which the specified user has explicit launch permissions.
    * 
    */
   public DescribeImagesOptions executableBy(String identityId) {
      formParameters.put("ExecutableBy", checkNotNull(identityId, "identityId"));
      return this;
   }

   public String getExecutableBy() {
      return getFirstFormOrNull("ExecutableBy");
   }

   /**
    * AMI IDs to describe.
    */
   public DescribeImagesOptions imageIds(String... imageIds) {
      indexFormValuesWithPrefix("ImageId", imageIds);
      return this;
   }

   public Set getImageIds() {
      return getFormValuesWithKeysPrefixedBy("ImageId.");
   }

   /**
    * Returns AMIs owned by the specified owner. Multiple owners can be specified.
    */
   public DescribeImagesOptions ownedBy(String... owners) {
      indexFormValuesWithPrefix("Owner", owners);
      return this;
   }

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

   public static class Builder {

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

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

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

   }
}