org.jclouds.googlecomputeengine.domain.NewInstance Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-compute-engine Show documentation
jclouds components to access GoogleCompute
There is a newer version: 2.6.0
Show newest version
/*
 * 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.domain;

import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Preconditions.checkNotNull;

import java.net.URI;
import java.util.Arrays;
import java.util.List;

import org.jclouds.googlecomputeengine.domain.Instance.NetworkInterface.AccessConfig;
import org.jclouds.googlecomputeengine.domain.Instance.NetworkInterface.AccessConfig.Type;
import org.jclouds.googlecomputeengine.domain.Instance.Scheduling;
import org.jclouds.googlecomputeengine.domain.Instance.ServiceAccount;
import org.jclouds.javax.annotation.Nullable;
import org.jclouds.json.SerializedNames;

import com.google.auto.value.AutoValue;
import com.google.common.collect.ImmutableList;

/** Parameter to {@linkplain org.jclouds.googlecomputeengine.features.InstanceApi#create(NewInstance)}. */
@AutoValue
public abstract class NewInstance {
   @AutoValue
   public abstract static class NetworkInterface {
      abstract URI network();
      @Nullable abstract URI subnetwork();

      abstract List accessConfigs();

      public static NetworkInterface create(URI network, URI subnetwork) {
         return create(network, subnetwork,
             Arrays.asList(AccessConfig.create(null, Type.ONE_TO_ONE_NAT, null)));
      }

      @SerializedNames({ "network", "subnetwork", "accessConfigs" })
      public static NetworkInterface create(URI network, URI subnetwork, List accessConfigs) {
         return new AutoValue_NewInstance_NetworkInterface(network, subnetwork, accessConfigs);
      }

      NetworkInterface() {
      }
   }

   public abstract String name();

   public abstract URI machineType();

   @Nullable public abstract Boolean canIpForward();

   public abstract List networkInterfaces();

   public abstract List disks();

   @Nullable public abstract String description();

   public abstract Tags tags();

   /** Add metadata via {@link Metadata#items()}. */
   public abstract Metadata metadata();

   @Nullable public abstract List serviceAccounts();

   @Nullable public abstract Scheduling scheduling();

   /** Convenience for creating a new instance with only a boot disk and minimal parameters. */
   public static NewInstance create(String name, URI machineType, URI network, URI subnetwork, URI sourceImage) {
      return create(name, machineType, network, subnetwork, Arrays.asList(AttachDisk.newBootDisk(sourceImage)), null,
              null);
   }

   public static NewInstance create(String name, URI machineType, URI network, @Nullable URI subnetwork,
                                    List disks, @Nullable String description, @Nullable Tags tags) {
      checkArgument(disks.get(0).boot(), "disk 0 must be a boot disk! %s", disks);
      boolean foundBoot = false;
      for (AttachDisk disk : disks) {
         if (disk.boot()) {
            checkArgument(!foundBoot, "There must be only one boot disk! %s", disks);
            foundBoot = true;
         }
      }
      return create(name, machineType, null, ImmutableList.of(NetworkInterface.create(network, subnetwork)),
            ImmutableList.copyOf(disks), description, tags != null ? tags : Tags.create(), Metadata.create(), null,
            null);
   }

   @SerializedNames({ "name", "machineType", "canIpForward", "networkInterfaces", "disks", "description",
                      "tags", "metadata", "serviceAccounts", "scheduling" })
   static NewInstance create(String name, URI machineType, Boolean canIpForward,
                             List networkInterfaces, List disks, String description,
                             Tags tags, Metadata metadata, List serviceAccounts, Scheduling scheduling) {
      return new AutoValue_NewInstance(name, machineType, canIpForward, networkInterfaces, disks, description,
                                       tags, metadata, serviceAccounts, scheduling);
   }

   NewInstance() {
   }

   public static class Builder {
      private String name;
      private URI machineType;
      private Boolean canIpForward;
      private List networkInterfaces;
      private List disks;
      private String description;
      private Tags tags;
      private Metadata metadata;
      private List serviceAccounts;
      private Scheduling scheduling;

      public Builder(String name, URI machineType, URI network, URI subnetwork, List disks) {
         checkNotNull(name, "NewInstance name cannot be null");
         this.name = name;
         this.machineType = machineType;
         this.networkInterfaces = ImmutableList.of(NetworkInterface.create(network, subnetwork));
         this.disks = disks;
      }

      public Builder(String name, URI machineType, List networks, List disks) {
         checkNotNull(name, "NewInstance name cannot be null");
         this.name = name;
         this.machineType = machineType;
         this.networkInterfaces = ImmutableList.copyOf(networks);
         this.disks = disks;
      }

      public Builder(String name, URI machineType, URI network, URI subnetwork, URI sourceImage) {
         checkNotNull(name, "NewInstance name cannot be null");
         this.name = name;
         this.machineType = machineType;
         this.networkInterfaces = ImmutableList.of(NetworkInterface.create(network, subnetwork));
         this.disks = Arrays.asList(AttachDisk.newBootDisk(sourceImage));
      }

      public Builder canIpForward(Boolean canIpForward){
         this.canIpForward = canIpForward;
         return this;
      }

      public Builder description(String description){
         this.description = description;
         return this;
      }

      public Builder tags(Tags tags){
         this.tags = tags;
         return this;
      }

      public Builder metadata(Metadata metadata){
         this.metadata = metadata;
         return this;
      }

      /**
       * A list of service accounts, with their specified scopes, authorized for this instance.
       * Service accounts generate access tokens that can be accessed through the metadata server
       * and used to authenticate applications on the instance.
       * Note: to add scopes to the default service account on the VM you can use 'default' as
       * a keyword for email.
       */
      public Builder serviceAccounts(List serviceAccounts){
         this.serviceAccounts = serviceAccounts;
         return this;
      }

      public Builder scheduling(Scheduling scheduling){
         this.scheduling = scheduling;
         return this;
      }

      public NewInstance build() {
         return create(name, machineType, canIpForward, networkInterfaces, disks, description, tags != null ? tags : Tags.create(),
                       metadata != null ? metadata : Metadata.create(), serviceAccounts, scheduling);
      }
   }
}