Move InstanceInfo inner classes outside

gcloud-java-compute/src/main/java/com/google/gcloud/compute/Metadata.java

@@ -0,0 +1,212 @@
+/*
+ * Copyright 2016 Google Inc. All Rights Reserved.
+ *
+ * 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 com.google.gcloud.compute;
+
+import static com.google.common.base.Preconditions.checkNotNull;
+
+import com.google.common.base.Function;
+import com.google.common.base.MoreObjects;
+import com.google.common.collect.ImmutableMap;
+import com.google.common.collect.Lists;
+import com.google.common.collect.Maps;
+
+import java.io.Serializable;
+import java.util.List;
+import java.util.Map;
+import java.util.Objects;
+
+/**
+ * Metadata for Google Compute Engine Instance as ket/value pairs. This includes custom metadata
+ * and predefined keys.
+ *
+ * @see <a href="https://cloud.google.com/compute/docs/metadata">Metadata</a>
+ */
+public final class Metadata implements Serializable {
+
+  static final Function<com.google.api.services.compute.model.Metadata, Metadata>
+      FROM_PB_FUNCTION =
+      new Function<com.google.api.services.compute.model.Metadata, Metadata>() {
+        @Override
+        public Metadata apply(com.google.api.services.compute.model.Metadata pb) {
+          return Metadata.fromPb(pb);
+        }
+      };
+  static final Function<Metadata, com.google.api.services.compute.model.Metadata> TO_PB_FUNCTION =
+      new Function<Metadata, com.google.api.services.compute.model.Metadata>() {
+        @Override
+        public com.google.api.services.compute.model.Metadata apply(Metadata metadata) {
+          return metadata.toPb();
+        }
+      };
+
+  private static final long serialVersionUID = -945038809838910107L;
+
+  private final Map<String, String> values;
+  private final String fingerprint;
+
+  /**
+   * A builder for {@code Metadata} objects.
+   */
+  public static final class Builder {
+
+    private Map<String, String> values;
+    private String fingerprint;
+
+    Builder() {
+      values = Maps.newHashMap();
+    }
+
+    Builder(Metadata metadata) {
+      this.values = metadata.values != null ? Maps.newHashMap(metadata.values)
+          : Maps.<String, String>newHashMap();
+      this.fingerprint = metadata.fingerprint;
+    }
+
+    /**
+     * Sets the metadata for the instance as key/value pairs. The total size of all keys and
+     * values must be less than 512 KB. Keys must conform to the following regexp:
+     * {@code [a-zA-Z0-9-_]+}, and be less than 128 bytes in length. This is reflected as part of
+     * a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with
+     * any other metadata keys for the project. Values must be less than or equal to 32768 bytes.
+     */
+    public Builder values(Map<String, String> values) {
+      this.values = Maps.newHashMap(checkNotNull(values));
+      return this;
+    }
+
+    /**
+     * Adds a key/value pair to the instance metadata. The total size of all keys and values must
+     * be less than 512 KB. Keys must conform to the following regexp: {@code [a-zA-Z0-9-_]+}, and
+     * be less than 128 bytes in length. This is reflected as part of a URL in the metadata
+     * server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata
+     * keys for the project. Values must be less than or equal to 32768 bytes.
+     */
+    public Builder add(String key, String value) {
+      this.values.put(key, value);
+      return this;
+    }
+
+    /**
+     * Sets the fingerprint for the metadata. This value can be used to update instance's
+     * metadata.
+     */
+    public Builder fingerprint(String fingerprint) {
+      this.fingerprint = fingerprint;
+      return this;
+    }
+
+    /**
+     * Creates a {@code Metadata} object.
+     */
+    public Metadata build() {
+      return new Metadata(this);
+    }
+  }
+
+  private Metadata(Builder builder) {
+    this.values = ImmutableMap.copyOf(builder.values);
+    this.fingerprint = builder.fingerprint;
+  }
+
+  /**
+   * Returns instance's metadata as key/value pairs.
+   */
+  public Map<String, String> values() {
+    return values;
+  }
+
+  /**
+   * Returns the fingerprint for the metadata. This value can be used to update instance's
+   * metadata.
+   */
+  public String fingerprint() {
+    return fingerprint;
+  }
+
+  /**
+   * Returns a builder for the current instance metadata.
+   */
+  public Builder toBuilder() {
+    return new Builder(this);
+  }
+
+  @Override
+  public String toString() {
+    return MoreObjects.toStringHelper(this)
+        .add("values", values)
+        .add("fingerprint", fingerprint)
+        .toString();
+  }
+
+  @Override
+  public int hashCode() {
+    return Objects.hash(values, fingerprint);
+  }
+
+  @Override
+  public boolean equals(Object obj) {
+    return obj == this
+        || obj instanceof Metadata
+        && Objects.equals(toPb(), ((Metadata) obj).toPb());
+  }
+
+  com.google.api.services.compute.model.Metadata toPb() {
+    com.google.api.services.compute.model.Metadata metadataPb =
+        new com.google.api.services.compute.model.Metadata();
+    metadataPb.setFingerprint(fingerprint);
+    List<com.google.api.services.compute.model.Metadata.Items> itemsPb =
+        Lists.newArrayListWithCapacity(values.size());
+    for (Map.Entry<String, String> entry : values.entrySet()) {
+      itemsPb.add(new com.google.api.services.compute.model.Metadata.Items()
+          .setKey(entry.getKey()).setValue(entry.getValue()));
+    }
+    metadataPb.setItems(itemsPb);
+    metadataPb.setFingerprint(fingerprint);
+    return metadataPb;
+  }
+
+  /**
+   * Returns a builder for a {@code Metadata} object.
+   */
+  public static Builder builder() {
+    return new Builder();
+  }
+
+  /**
+   * Returns a {@code Metadata} object given the the metadata as a map. The total size of all keys
+   * and values must be less than 512 KB. Keys must conform to the following regexp:
+   * {@code [a-zA-Z0-9-_]+}, and be less than 128 bytes in length. This is reflected as part of a
+   * URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any
+   * other metadata keys for the project. Values must be less than or equal to 32768 bytes.
+   */
+  public static Metadata of(Map<String, String> values) {
+    return builder().values(values).build();
+  }
+
+  static Metadata fromPb(com.google.api.services.compute.model.Metadata metadataPb) {
+    Builder builder = builder();
+    if (metadataPb.getItems() != null) {
+      Map<String, String> metadataValues =
+          Maps.newHashMapWithExpectedSize(metadataPb.getItems().size());
+      for (com.google.api.services.compute.model.Metadata.Items item : metadataPb.getItems()) {
+        metadataValues.put(item.getKey(), item.getValue());
+      }
+      builder.values(metadataValues);
+    }
+    return builder.fingerprint(metadataPb.getFingerprint()).build();
+  }
+}

gcloud-java-compute/src/main/java/com/google/gcloud/compute/NetworkInterface.java

@@ -493,7 +493,7 @@ static NetworkInterface fromPb(
       com.google.api.services.compute.model.NetworkInterface interfacePb) {
     Builder builder = builder(NetworkId.fromUrl(interfacePb.getNetwork()))
         .name(interfacePb.getName());
-    if (interfacePb.getSubnetwork() != null){
+    if (interfacePb.getSubnetwork() != null) {
       builder.subnetwork(SubnetworkId.fromUrl(interfacePb.getSubnetwork()));
     }
     builder.networkIp(interfacePb.getNetworkIP());

gcloud-java-compute/src/main/java/com/google/gcloud/compute/SchedulingOptions.java

@@ -0,0 +1,150 @@
+/*
+ * Copyright 2016 Google Inc. All Rights Reserved.
+ *
+ * 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 com.google.gcloud.compute;
+
+import com.google.common.base.MoreObjects;
+
+import java.io.Serializable;
+import java.util.Objects;
+
+/**
+ * A Google Compute Engine instance scheduling options. When there are system events that might
+ * cause your instances to be disrupted, Google Compute Engine automatically manages the
+ * scheduling decisions for your instances. Use {@code SchedulingOptions.preemptible()} to create
+ * a preemptible instance. Use {@code SchedulingOptions.standard()} to configure scheduling
+ * options for a standard instance.
+ *
+ * @see <a href="https://cloud.google.com/compute/docs/instances/setting-instance-scheduling-options">
+ *     Setting Instance Scheduling Options</a>
+ */
+public final class SchedulingOptions implements Serializable {
+
+  private static final long serialVersionUID = 4199610694227857331L;
+
+  private final boolean automaticRestart;
+  private final Maintenance maintenance;
+  private final boolean isPreemptible;
+
+  /**
+   * Defines the maintenance behavior for this instance.
+   */
+  public enum Maintenance {
+    /**
+     * The default behavior for standard instances.
+     */
+    MIGRATE,
+
+    /**
+     * The default and only possible behavior for preemptible instances.
+     */
+    TERMINATE
+  }
+
+  private SchedulingOptions(Boolean automaticRestart, Maintenance maintenance,
+      Boolean isPreemptible) {
+    this.automaticRestart = automaticRestart;
+    this.maintenance = maintenance;
+    this.isPreemptible = isPreemptible;
+  }
+
+  /**
+   * Returns whether the instance should be automatically restarted if it is terminated by Compute
+   * Engine (not terminated by a user).
+   */
+  public Boolean automaticRestart() {
+    return automaticRestart;
+  }
+
+  /**
+   * Returns the maintenance behavior for the instance.
+   */
+  public Maintenance maintenance() {
+    return maintenance;
+  }
+
+  /**
+   * Returns {@code true} if the instance is preemptible, {@code false} otherwhise.
+   *
+   * @see <a href="https://cloud.google.com/compute/docs/instances/preemptible">Preemptible
+   *     Instance</a>
+   */
+  public boolean isPreemptible() {
+    return isPreemptible;
+  }
+
+  @Override
+  public String toString() {
+    return MoreObjects.toStringHelper(this)
+        .add("automaticRestart", automaticRestart)
+        .add("maintenance", maintenance)
+        .add("isPreemptible", isPreemptible)
+        .toString();
+  }
+
+  @Override
+  public int hashCode() {
+    return Objects.hash(automaticRestart, maintenance, isPreemptible);
+  }
+
+  @Override
+  public boolean equals(Object obj) {
+    return obj == this
+        || obj instanceof SchedulingOptions
+        && Objects.equals(toPb(), ((SchedulingOptions) obj).toPb());
+  }
+
+  com.google.api.services.compute.model.Scheduling toPb() {
+    com.google.api.services.compute.model.Scheduling schedulingPb =
+        new com.google.api.services.compute.model.Scheduling();
+    schedulingPb.setAutomaticRestart(automaticRestart);
+    schedulingPb.setPreemptible(isPreemptible);
+    if (maintenance != null) {
+      schedulingPb.setOnHostMaintenance(maintenance.name());
+    }
+    return schedulingPb;
+  }
+
+  /**
+   * Returns a {@code SchedulingOptions} object for a preemptible instance.
+   *
+   * @see <a href="https://cloud.google.com/compute/docs/instances/preemptible">Preemptible
+   *     Instance</a>
+   */
+  public static SchedulingOptions preemptible() {
+    return new SchedulingOptions(false, Maintenance.TERMINATE, true);
+  }
+
+  /**
+   * Returns a {@code SchedulingOptions} object for a standard instance.
+   *
+   * @param automaticRestart specifies whether the instance should be automatically restarted if
+   *     it is terminated by Compute Engine (not terminated by a user)
+   * @param maintenance defines the maintenance behavior for the instance
+   */
+  public static SchedulingOptions standard(boolean automaticRestart, Maintenance maintenance) {
+    return new SchedulingOptions(automaticRestart, maintenance, false);
+  }
+
+  static SchedulingOptions fromPb(com.google.api.services.compute.model.Scheduling schedPb) {
+    Maintenance maintenance = null;
+    if (schedPb.getOnHostMaintenance() != null) {
+      maintenance = Maintenance.valueOf(schedPb.getOnHostMaintenance());
+    }
+    return new SchedulingOptions(schedPb.getAutomaticRestart(), maintenance,
+        schedPb.getPreemptible());
+  }
+}