Better javadoc for RemoteComputeHelper.baseResourceName

mziccard · mziccard · commit 514e3fe873d5 · 2016-04-29T09:51:22.000+02:00
diff --git a/gcloud-java-compute/src/main/java/com/google/gcloud/compute/testing/RemoteComputeHelper.java b/gcloud-java-compute/src/main/java/com/google/gcloud/compute/testing/RemoteComputeHelper.java
@@ -54,7 +54,9 @@ public ComputeOptions options() {
 
   /**
    * Returns a base name for testing resources generated using a random UUID. This base name can be
-   * prepended to resource names to prevent name clashes.
+   * prepended to resource names to prevent name clashes. This method always returns a 30 characters
+   * long prefix. Since Compute Engine resource names can be at most 63 characters long your suffix
+   * should be no longer than 33 characters.
    */
   public static String baseResourceName() {
     return "test-" + UUID.randomUUID().toString().replace("-", "").substring(0, 24) + "-";
@@ -69,8 +71,7 @@ public static String baseResourceName() {
    * @return A {@code RemoteComputeHelper} object for the provided options
    * @throws ComputeHelperException if {@code keyStream} is not a valid JSON key stream
    */
-  public static RemoteComputeHelper create(String projectId, InputStream keyStream)
-      throws ComputeHelperException {
+  public static RemoteComputeHelper create(String projectId, InputStream keyStream) {
     try {
       ComputeOptions computeOptions = ComputeOptions.builder()
           .authCredentials(AuthCredentials.createForJson(keyStream))
