google-compute-engine/src/main/java/org/jclouds/googlecomputeengine/GoogleComputeEngineApi.java

/*
 * 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.googlecomputeengine;

import java.io.Closeable;

import javax.ws.rs.Path;
import javax.ws.rs.PathParam;

import org.jclouds.googlecomputeengine.features.DiskApi;
import org.jclouds.googlecomputeengine.features.FirewallApi;
import org.jclouds.googlecomputeengine.features.GlobalOperationApi;
import org.jclouds.googlecomputeengine.features.ImageApi;
import org.jclouds.googlecomputeengine.features.InstanceApi;
import org.jclouds.googlecomputeengine.features.KernelApi;
import org.jclouds.googlecomputeengine.features.MachineTypeApi;
import org.jclouds.googlecomputeengine.features.NetworkApi;
import org.jclouds.googlecomputeengine.features.ProjectApi;
import org.jclouds.googlecomputeengine.features.ZoneApi;
import org.jclouds.googlecomputeengine.features.ZoneOperationApi;
import org.jclouds.rest.annotations.Delegate;

import com.google.common.annotations.Beta;


/**
 * Provides access to GoogleCompute.
 * <p/>
 *
 * @author David Alves
 * @see <a href="https://developers.google.com/compute/docs/reference/v1beta15">api doc</a>
 */
@Beta
public interface GoogleComputeEngineApi extends Closeable {

   /**
    * Provides access to Disk features
    *
    * @param projectName the name of the project
    */
   @Delegate
   @Path("/projects/{project}")
   DiskApi getDiskApiForProject(@PathParam("project") String projectName);

   /**
    * Provides access to Firewall features
    *
    * @param projectName the name of the project
    */
   @Delegate
   @Path("/projects/{project}")
   FirewallApi getFirewallApiForProject(@PathParam("project") String projectName);

   /**
    * Provides access to Global Operation features
    *
    * @param projectName the name of the project
    */
   @Delegate
   @Path("/projects/{project}")
   GlobalOperationApi getGlobalOperationApiForProject(@PathParam("project") String projectName);

   /**
    * Provides access to Image features
    *
    * @param projectName the name of the project
    */
   @Delegate
   @Path("/projects/{project}")
   ImageApi getImageApiForProject(@PathParam("project") String projectName);

   /**
    * Provides access to Instance features
    *
    * @param projectName the name of the project
    */
   @Delegate
   @Path("/projects/{project}")
   InstanceApi getInstanceApiForProject(@PathParam("project") String projectName);

   /**
    * Provides access to Kernel features
    *
    * @param projectName the name of the project
    */
   @Delegate
   @Path("/projects/{project}")
   KernelApi getKernelApiForProject(@PathParam("project") String projectName);

   /**
    * Provides access to MachineType features
    *
    * @param projectName the name of the project
    */
   @Delegate
   @Path("/projects/{project}")
   MachineTypeApi getMachineTypeApiForProject(@PathParam("project") String projectName);

   /**
    * Provides access to Network features
    *
    * @param projectName the name of the project
    */
   @Delegate
   @Path("/projects/{project}")
   NetworkApi getNetworkApiForProject(@PathParam("project") String projectName);

   /**
    * Provides access to Project features
    */
   @Delegate
   ProjectApi getProjectApi();

   /**
    * Provides access to Zone features
    *
    * @param projectName the name of the project
    */
   @Delegate
   @Path("/projects/{project}")
   ZoneApi getZoneApiForProject(@PathParam("project") String projectName);

   /**
    * Provides access to Zone Operation features
    *
    * @param projectName the name of the project
    */
   @Delegate
   @Path("/projects/{project}")
   ZoneOperationApi getZoneOperationApiForProject(@PathParam("project") String projectName);

}