Fix Compute operations issues

- Fix javadoc errors
- Fix OperationId and Operation tests
- Fix RegionOperationId equals

Author: mziccard

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

@@ -244,15 +244,16 @@ enum OperationField {
     NAME("name"),
     OPERATION_TYPE("operationType"),
     PROGRESS("progress"),
+    REGION("region"),
     SELF_LINK("selfLink"),
     START_TIME("startTime"),
     STATUS("status"),
     STATUS_MESSAGE("statusMessage"),
-    REGION("region"),
     TARGET_ID("targetId"),
     TARGET_LINK("targetLink"),
     USER("user"),
-    WARNINGS("warnings");
+    WARNINGS("warnings"),
+    ZONE("zone");
 
     private final String selector;
 
@@ -292,7 +293,7 @@ enum ComparisonOperator {
       EQ,
 
       /**
-       * Defines an inequality filter.
+       * Defines a not-equals filter.
        */
       NE
     }
@@ -350,7 +351,7 @@ public static DiskTypeFilter equals(DiskTypeField field, String value) {
     }
 
     /**
-     * Returns an equality filter for the given field and string value. For string fields,
+     * Returns a not-equals filter for the given field and string value. For string fields,
      * {@code value} is interpreted as a regular expression using RE2 syntax. {@code value} must
      * match the entire field.
      *
@@ -368,7 +369,7 @@ public static DiskTypeFilter equals(DiskTypeField field, long value) {
     }
 
     /**
-     * Returns an inequality filter for the given field and long value.
+     * Returns a not-equals filter for the given field and long value.
      */
     public static DiskTypeFilter notEquals(DiskTypeField field, long value) {
       return new DiskTypeFilter(checkNotNull(field), ComparisonOperator.NE, value);
@@ -398,7 +399,7 @@ public static MachineTypeFilter equals(MachineTypeField field, String value) {
     }
 
     /**
-     * Returns an equality filter for the given field and string value. For string fields,
+     * Returns a not-equals filter for the given field and string value. For string fields,
      * {@code value} is interpreted as a regular expression using RE2 syntax. {@code value} must
      * match the entire field.
      *
@@ -416,7 +417,7 @@ public static MachineTypeFilter equals(MachineTypeField field, long value) {
     }
 
     /**
-     * Returns an inequality filter for the given field and long value.
+     * Returns a not-equals filter for the given field and long value.
      */
     public static MachineTypeFilter notEquals(MachineTypeField field, long value) {
       return new MachineTypeFilter(checkNotNull(field), ComparisonOperator.NE, value);
@@ -446,7 +447,7 @@ public static RegionFilter equals(RegionField field, String value) {
     }
 
     /**
-     * Returns an equality filter for the given field and string value. For string fields,
+     * Returns a not-equals filter for the given field and string value. For string fields,
      * {@code value} is interpreted as a regular expression using RE2 syntax. {@code value} must
      * match the entire field.
      *
@@ -480,7 +481,7 @@ public static ZoneFilter equals(ZoneField field, String value) {
     }
 
     /**
-     * Returns an equality filter for the given field and string value. For string fields,
+     * Returns a not-equals filter for the given field and string value. For string fields,
      * {@code value} is interpreted as a regular expression using RE2 syntax. {@code value} must
      * match the entire field.
      *
@@ -514,7 +515,7 @@ public static OperationFilter equals(OperationField field, String value) {
     }
 
     /**
-     * Returns an equality filter for the given field and string value. For string fields,
+     * Returns a not-equals filter for the given field and string value. For string fields,
      * {@code value} is interpreted as a regular expression using RE2 syntax. {@code value} must
      * match the entire field.
      *
@@ -532,7 +533,7 @@ public static OperationFilter equals(OperationField field, long value) {
     }
 
     /**
-     * Returns an inequality filter for the given field and long value.
+     * Returns a not-equals filter for the given field and long value.
      */
     public static OperationFilter notEquals(OperationField field, long value) {
       return new OperationFilter(checkNotNull(field), ComparisonOperator.NE, value);
@@ -546,7 +547,7 @@ public static OperationFilter equals(OperationField field, int value) {
     }
 
     /**
-     * Returns an inequality filter for the given field and integer value.
+     * Returns a not-equals filter for the given field and integer value.
      */
     public static OperationFilter notEquals(OperationField field, int value) {
       return new OperationFilter(checkNotNull(field), ComparisonOperator.NE, value);
@@ -566,8 +567,8 @@ private DiskTypeOption(ComputeRpc.Option option, Object value) {
 
     /**
      * Returns an option to specify the disk type's fields to be returned by the RPC call. If this
-     * option is not provided all disk type's fields are returned. {@code DiskTypeOption.fields} can
-     * be used to specify only the fields of interest. {@link DiskType#diskTypeId()} is always
+     * option is not provided, all disk type's fields are returned. {@code DiskTypeOption.fields}
+     * can be used to specify only the fields of interest. {@link DiskType#diskTypeId()} is always
      * returned, even if not specified.
      */
     public static DiskTypeOption fields(DiskTypeField... fields) {
@@ -587,7 +588,7 @@ private DiskTypeListOption(ComputeRpc.Option option, Object value) {
     }
 
     /**
-     * Returns an option to specify a filter to the disk types being listed.
+     * Returns an option to specify a filter on the disk types being listed.
      */
     public static DiskTypeListOption filter(DiskTypeFilter filter) {
       return new DiskTypeListOption(ComputeRpc.Option.FILTER, filter.toPb());
@@ -609,9 +610,9 @@ public static DiskTypeListOption startPageToken(String pageToken) {
 
     /**
      * Returns an option to specify the disk type's fields to be returned by the RPC call. If this
-     * option is not provided all disk type's fields are returned. {@code DiskTypeListOption.fields}
-     * can be used to specify only the fields of interest. {@link DiskType#diskTypeId()} is always
-     * returned, even if not specified.
+     * option is not provided, all disk type's fields are returned.
+     * {@code DiskTypeListOption.fields} can be used to specify only the fields of interest.
+     * {@link DiskType#diskTypeId()} is always returned, even if not specified.
      */
     public static DiskTypeListOption fields(DiskTypeField... fields) {
       StringBuilder builder = new StringBuilder();
@@ -632,7 +633,7 @@ private DiskTypeAggregatedListOption(ComputeRpc.Option option, Object value) {
     }
 
     /**
-     * Returns an option to specify a filter to the disk types being listed.
+     * Returns an option to specify a filter on the disk types being listed.
      */
     public static DiskTypeAggregatedListOption filter(DiskTypeFilter filter) {
       return new DiskTypeAggregatedListOption(ComputeRpc.Option.FILTER, filter.toPb());
@@ -666,7 +667,7 @@ private MachineTypeOption(ComputeRpc.Option option, Object value) {
 
     /**
      * Returns an option to specify the machine type's fields to be returned by the RPC call. If
-     * this option is not provided all machine type's fields are returned.
+     * this option is not provided, all machine type's fields are returned.
      * {@code MachineTypeOption.fields} can be used to specify only the fields of interest.
      * {@link MachineType#machineTypeId()} is always returned, even if not specified.
      */
@@ -687,7 +688,7 @@ private MachineTypeListOption(ComputeRpc.Option option, Object value) {
     }
 
     /**
-     * Returns an option to specify a filter to the machine types being listed.
+     * Returns an option to specify a filter on the machine types being listed.
      */
     public static MachineTypeListOption filter(MachineTypeFilter filter) {
       return new MachineTypeListOption(ComputeRpc.Option.FILTER, filter.toPb());
@@ -709,7 +710,7 @@ public static MachineTypeListOption startPageToken(String pageToken) {
 
     /**
      * Returns an option to specify the machine type's fields to be returned by the RPC call. If
-     * this option is not provided all machine type's fields are returned.
+     * this option is not provided, all machine type's fields are returned.
      * {@code MachineTypeListOption.fields} can be used to specify only the fields of interest.
      * {@link MachineType#machineTypeId()} is always returned, even if not specified.
      */
@@ -732,7 +733,7 @@ private MachineTypeAggregatedListOption(ComputeRpc.Option option, Object value)
     }
 
     /**
-     * Returns an option to specify a filter to the machine types being listed.
+     * Returns an option to specify a filter on the machine types being listed.
      */
     public static MachineTypeAggregatedListOption filter(MachineTypeFilter filter) {
       return new MachineTypeAggregatedListOption(ComputeRpc.Option.FILTER, filter.toPb());
@@ -766,7 +767,7 @@ private RegionOption(ComputeRpc.Option option, Object value) {
 
     /**
      * Returns an option to specify the region's fields to be returned by the RPC call. If this
-     * option is not provided all region's fields are returned. {@code RegionOption.fields} can be
+     * option is not provided, all region's fields are returned. {@code RegionOption.fields} can be
      * used to specify only the fields of interest. {@link Region#regionId()} is always
      * returned, even if not specified.
      */
@@ -787,7 +788,7 @@ private RegionListOption(ComputeRpc.Option option, Object value) {
     }
 
     /**
-     * Returns an option to specify a filter to the regions being listed.
+     * Returns an option to specify a filter on the regions being listed.
      */
     public static RegionListOption filter(RegionFilter filter) {
       return new RegionListOption(ComputeRpc.Option.FILTER, filter.toPb());
@@ -809,7 +810,7 @@ public static RegionListOption startPageToken(String pageToken) {
 
     /**
      * Returns an option to specify the region's fields to be returned by the RPC call. If this
-     * option is not provided all region's fields are returned. {@code RegionListOption.fields} can
+     * option is not provided, all region's fields are returned. {@code RegionListOption.fields} can
      * be used to specify only the fields of interest. {@link Region#regionId()} is always
      * returned, even if not specified.
      */
@@ -833,7 +834,7 @@ private ZoneOption(ComputeRpc.Option option, Object value) {
 
     /**
      * Returns an option to specify the zone's fields to be returned by the RPC call. If this option
-     * is not provided all zone's fields are returned. {@code ZoneOption.fields} can be used to
+     * is not provided, all zone's fields are returned. {@code ZoneOption.fields} can be used to
      * specify only the fields of interest. {@link Zone#zoneId()} is always returned, even if
      * not specified.
      */
@@ -854,7 +855,7 @@ private ZoneListOption(ComputeRpc.Option option, Object value) {
     }
 
     /**
-     * Returns an option to specify a filter to the zones being listed.
+     * Returns an option to specify a filter on the zones being listed.
      */
     public static ZoneListOption filter(ZoneFilter filter) {
       return new ZoneListOption(ComputeRpc.Option.FILTER, filter.toPb());
@@ -876,7 +877,7 @@ public static ZoneListOption startPageToken(String pageToken) {
 
     /**
      * Returns an option to specify the zone's fields to be returned by the RPC call. If this option
-     * is not provided all zone's fields are returned. {@code ZoneListOption.fields} can be used to
+     * is not provided, all zone's fields are returned. {@code ZoneListOption.fields} can be used to
      * specify only the fields of interest. {@link Zone#zoneId()} is always returned, even if
      * not specified.
      */
@@ -900,9 +901,9 @@ private LicenseOption(ComputeRpc.Option option, Object value) {
 
     /**
      * Returns an option to specify the license's fields to be returned by the RPC call. If this
-     * option is not provided all license's fields are returned. {@code LicenseOption.fields} can be
-     * used to specify only the fields of interest. {@link License#licenseId()} is always returned,
-     * even if not specified.
+     * option is not provided, all license's fields are returned. {@code LicenseOption.fields} can
+     * be used to specify only the fields of interest. {@link License#licenseId()} is always
+     * returned, even if not specified.
      */
     public static LicenseOption fields(LicenseField... fields) {
       return new LicenseOption(ComputeRpc.Option.FIELDS, LicenseField.selector(fields));
@@ -922,7 +923,7 @@ private OperationOption(ComputeRpc.Option option, Object value) {
 
     /**
      * Returns an option to specify the operation's fields to be returned by the RPC call. If this
-     * option is not provided all operation's fields are returned. {@code OperationOption.fields}
+     * option is not provided, all operation's fields are returned. {@code OperationOption.fields}
      * can be used to specify only the fields of interest. {@link Operation#operationId()} is
      * always returned, even if not specified.
      */
@@ -943,7 +944,7 @@ private OperationListOption(ComputeRpc.Option option, Object value) {
     }
 
     /**
-     * Returns an option to specify a filter to the operations being listed.
+     * Returns an option to specify a filter on the operations being listed.
      */
     public static OperationListOption filter(OperationFilter filter) {
       return new OperationListOption(ComputeRpc.Option.FILTER, filter.toPb());
@@ -965,7 +966,7 @@ public static OperationListOption startPageToken(String pageToken) {
 
     /**
      * Returns an option to specify the operation's fields to be returned by the RPC call. If this
-     * option is not provided all operation's fields are returned.
+     * option is not provided, all operation's fields are returned.
      * {@code OperationListOption.fields} can be used to specify only the fields of interest.
      * {@link Operation#operationId()} is always returned, even if not specified.
      */

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

@@ -195,7 +195,7 @@ public Page<Operation> nextPage() {
 
   private static class ZoneOperationPageFetcher implements NextPageFetcher<Operation> {
 
-    private static final long serialVersionUID = 4111705358926164078L;
+    private static final long serialVersionUID = -9012504536518197793L;
     private final Map<ComputeRpc.Option, ?> requestOptions;
     private final ComputeOptions serviceOptions;
     private final String zone;

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

@@ -38,10 +38,10 @@
 
 /**
  * Google Compute Engine operations. Operation identity can be obtained via {@link #operationId()}.
- * For global operations {@link #operationId()} returns an {@link GlobalOperationId}, for region
- * operations {@link #operationId()} returns a {@link RegionOperationId}, for zone operations
- * {@link #operationId()} returns a {@link ZoneOperationId}. To get an {@code Operation} object with
- * the most recent information use {@link #reload(Compute.OperationOption...)}.
+ * {@link #operationId()} returns {@link GlobalOperationId} for global operations,
+ * {@link RegionOperationId} for region operations, and {@link ZoneOperationId} for zone operations.
+ * To get an {@code Operation} object with the most recent information use
+ * {@link #reload(Compute.OperationOption...)}.
  */
 public final class Operation implements Serializable {
 
@@ -71,7 +71,7 @@ public final class Operation implements Serializable {
   private final String description;
 
   /**
-   * Types of operations.
+   * Status of an operation.
    */
   public enum Status {
     PENDING,
@@ -286,9 +286,6 @@ public int hashCode() {
     }
   }
 
-  /**
-   * Builder for Compute Engine operations.
-   */
   static final class Builder {
 
     private Compute compute;
@@ -310,7 +307,6 @@ static final class Builder {
     private List<OperationWarning> warnings;
     private Integer httpErrorStatusCode;
     private String httpErrorMessage;
-
     private String description;
 
     Builder(Compute compute) {
@@ -460,10 +456,7 @@ Builder description(String description) {
       return this;
     }
 
-    /**
-     * Creates an object.
-     */
-    public Operation build() {
+    Operation build() {
       return new Operation(this);
     }
   }
@@ -515,8 +508,8 @@ public Long creationTimestamp() {
 
   /**
    * Returns the operation's identity. This method returns an {@link GlobalOperationId} for global
-   * operations, returns a {@link RegionOperationId} for region operations and returns a
-   * {@link ZoneOperationId} for zone operations.
+   * operations, a {@link RegionOperationId} for region operations and a {@link ZoneOperationId} for
+   * zone operations.
    *
    * @see <a href="https://www.ietf.org/rfc/rfc1035.txt">RFC1035</a>
    */
@@ -658,7 +651,7 @@ public boolean exists() throws ComputeException {
   /**
    * Checks if this operation has completed its execution, either failing or succeeding. If the
    * operation does not exist this method returns {@code false}. To correctly wait for operation's
-   * completion check that the operation exists first, using {@link #exists()}:
+   * completion, check that the operation exists first using {@link #exists()}:
    * <pre> {@code
    * if (operation.exists()) {
    *   while(!operation.isDone()) {

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

@@ -32,7 +32,7 @@ public interface OperationId {
   String operation();
 
   /**
-   * Returns a fully qualified URL to the entity.
+   * Returns a fully qualified URL to the operation.
    */
   String selfLink();
 }

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

@@ -62,7 +62,9 @@ public int hashCode() {
 
   @Override
   public boolean equals(Object obj) {
-    return obj instanceof RegionOperationId && baseEquals((RegionOperationId) obj);
+    return obj instanceof RegionOperationId
+        && baseEquals((RegionOperationId) obj)
+        && Objects.equals(operation, ((RegionOperationId) obj).operation);
   }
 
   @Override