org.jclouds.aws.ec2.options.DescribeRegionsOptions 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.Arrays;
import java.util.Set;

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

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

 * EC2Client connection = // get connection
 * Future> images = connection.getRegionsAndRegionsServices().describeRegions(regions("us-east-1a", "us-east-1b"));
 * 
 * 
 * @author Adrian Cole
 * @see 
 */
public class DescribeRegionsOptions extends BaseEC2RequestOptions {

   /**
    * Name of a Region.
    */
   public DescribeRegionsOptions regions(String... regions) {
      String[] regionStrings = Arrays.copyOf(regions, regions.length, String[].class);
      indexFormValuesWithPrefix("RegionName", regionStrings);
      return this;
   }

   public Set getZones() {
      return getFormValuesWithKeysPrefixedBy("RegionName.");
   }

   public static class Builder {

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

   }
}