From 5d2da6a8f9fc98eaab515d5f9d69504c00bb6555 Mon Sep 17 00:00:00 2001 From: dmitry-fa Date: Thu, 16 Apr 2020 22:11:15 +0300 Subject: [PATCH 1/3] docs: label legacy storage classes in documentation --- .../google/cloud/storage/StorageClass.java | 38 +++++++++++++------ 1 file changed, 27 insertions(+), 11 deletions(-) diff --git a/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageClass.java b/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageClass.java index a345a31fc6..90c0a97983 100644 --- a/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageClass.java +++ b/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageClass.java @@ -20,8 +20,9 @@ import com.google.cloud.StringEnumValue; /** - * Enums for the storage classes. See https://cloud.google.com/storage/docs/storage-classes for - * details. + * Enums for the storage classes. See https://cloud.google.com/storage/docs/storage-classes + * for details. */ public final class StorageClass extends StringEnumValue { private static final long serialVersionUID = -6938125060419556331L; @@ -42,42 +43,57 @@ public StorageClass apply(String constant) { new StringEnumType(StorageClass.class, CONSTRUCTOR); /** - * Standard storage class. See: https://cloud.google.com/storage/docs/storage-classes for details + * Standard storage class. See: https://cloud.google.com/storage/docs/storage-classes#standard + * for details */ public static final StorageClass STANDARD = type.createAndRegister("STANDARD"); /** - * Nearline storage class. See: https://cloud.google.com/storage/docs/storage-classes for details + * Nearline storage class. See: https://cloud.google.com/storage/docs/storage-classes#nearline + * for details. */ public static final StorageClass NEARLINE = type.createAndRegister("NEARLINE"); /** - * Coldline storage class. See: https://cloud.google.com/storage/docs/storage-classes for details + * Coldline storage class. See: https://cloud.google.com/storage/docs/storage-classes#coldline + * for details. */ public static final StorageClass COLDLINE = type.createAndRegister("COLDLINE"); /** - * Archive storage class. See: https://cloud.google.com/storage/docs/storage-classes for details + * Archive storage class. See: https://cloud.google.com/storage/docs/storage-classes#archive + * for details. */ public static final StorageClass ARCHIVE = type.createAndRegister("ARCHIVE"); /** * Regional storage class. This is supported as a legacy storage class and will be deprecated in - * the future. See: https://cloud.google.com/storage/docs/storage-classes for details + * the future. This class cannot be set. Unless you already are using it, you should use {@link + * #STANDARD} instead. See Additional classes for + * details. */ public static final StorageClass REGIONAL = type.createAndRegister("REGIONAL"); /** * Multi-regional storage class. This is supported as a legacy storage class and will be - * deprecated in the future. See: https://cloud.google.com/storage/docs/storage-classes for - * details + * deprecated in the future. This class cannot be set. Unless you already are using it, you should + * use {@link #STANDARD} instead. See Additional classes for + * details. */ public static final StorageClass MULTI_REGIONAL = type.createAndRegister("MULTI_REGIONAL"); /** * Durable Reduced Availability storage class. This is supported as a legacy storage class and - * will be deprecated in the future. See: https://cloud.google.com/storage/docs/storage-classes - * for details + * will be deprecated in the future. This class cannot be set. Unless you already are using it, + * you should use {@link #STANDARD} instead. See Additional classes for + * details. */ public static final StorageClass DURABLE_REDUCED_AVAILABILITY = type.createAndRegister("DURABLE_REDUCED_AVAILABILITY"); From 86c523358e5dc418f8557a2b39d4c3cc0ecfcd39 Mon Sep 17 00:00:00 2001 From: dmitry-fa Date: Fri, 17 Apr 2020 10:50:53 +0300 Subject: [PATCH 2/3] docs: label legacy storage classes in documentation --- .../google/cloud/storage/StorageClass.java | 49 +++++++++++-------- 1 file changed, 28 insertions(+), 21 deletions(-) diff --git a/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageClass.java b/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageClass.java index 90c0a97983..c57b4226da 100644 --- a/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageClass.java +++ b/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageClass.java @@ -43,57 +43,64 @@ public StorageClass apply(String constant) { new StringEnumType(StorageClass.class, CONSTRUCTOR); /** - * Standard storage class. See: https://cloud.google.com/storage/docs/storage-classes#standard - * for details + * Standard storage class. + * + * @see https://cloud.google.com/storage/docs/storage-classes#standard */ public static final StorageClass STANDARD = type.createAndRegister("STANDARD"); /** - * Nearline storage class. See: https://cloud.google.com/storage/docs/storage-classes#nearline - * for details. + * Nearline storage class. + * + * @see https://cloud.google.com/storage/docs/storage-classes#nearline */ public static final StorageClass NEARLINE = type.createAndRegister("NEARLINE"); /** - * Coldline storage class. See: https://cloud.google.com/storage/docs/storage-classes#coldline - * for details. + * Coldline storage class. + * + * @see https://cloud.google.com/storage/docs/storage-classes#coldline */ public static final StorageClass COLDLINE = type.createAndRegister("COLDLINE"); /** - * Archive storage class. See: https://cloud.google.com/storage/docs/storage-classes#archive - * for details. + * Archive storage class. + * + * @see https://cloud.google.com/storage/docs/storage-classes#archive */ public static final StorageClass ARCHIVE = type.createAndRegister("ARCHIVE"); /** * Regional storage class. This is supported as a legacy storage class and will be deprecated in * the future. This class cannot be set. Unless you already are using it, you should use {@link - * #STANDARD} instead. See Additional classes for - * details. + * #STANDARD} instead. + * + * @see https://cloud.google.com/storage/docs/storage-classes#legacy */ public static final StorageClass REGIONAL = type.createAndRegister("REGIONAL"); /** * Multi-regional storage class. This is supported as a legacy storage class and will be * deprecated in the future. This class cannot be set. Unless you already are using it, you should - * use {@link #STANDARD} instead. See Additional classes for - * details. + * use {@link #STANDARD} instead. + * + * @see https://cloud.google.com/storage/docs/storage-classes#legacy */ public static final StorageClass MULTI_REGIONAL = type.createAndRegister("MULTI_REGIONAL"); /** * Durable Reduced Availability storage class. This is supported as a legacy storage class and * will be deprecated in the future. This class cannot be set. Unless you already are using it, - * you should use {@link #STANDARD} instead. See Additional classes for - * details. + * you should use {@link #STANDARD} instead. + * + * @see https://cloud.google.com/storage/docs/storage-classes#legacy */ public static final StorageClass DURABLE_REDUCED_AVAILABILITY = type.createAndRegister("DURABLE_REDUCED_AVAILABILITY"); From 490505c3d3284cef3481662f2ade55cf3829cac6 Mon Sep 17 00:00:00 2001 From: dmitry-fa Date: Fri, 17 Apr 2020 21:25:02 +0300 Subject: [PATCH 3/3] docs: label legacy storage classes in documentation --- .../com/google/cloud/storage/StorageClass.java | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageClass.java b/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageClass.java index c57b4226da..5cf979878c 100644 --- a/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageClass.java +++ b/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageClass.java @@ -75,9 +75,8 @@ public StorageClass apply(String constant) { public static final StorageClass ARCHIVE = type.createAndRegister("ARCHIVE"); /** - * Regional storage class. This is supported as a legacy storage class and will be deprecated in - * the future. This class cannot be set. Unless you already are using it, you should use {@link - * #STANDARD} instead. + * Legacy Regional storage class, use {@link #STANDARD} instead. This class will be deprecated in + * the future. * * @see https://cloud.google.com/storage/docs/storage-classes#legacy @@ -85,9 +84,8 @@ public StorageClass apply(String constant) { public static final StorageClass REGIONAL = type.createAndRegister("REGIONAL"); /** - * Multi-regional storage class. This is supported as a legacy storage class and will be - * deprecated in the future. This class cannot be set. Unless you already are using it, you should - * use {@link #STANDARD} instead. + * Legacy Multi-regional storage class, use {@link #STANDARD} instead. This class will be + * deprecated in the future. * * @see https://cloud.google.com/storage/docs/storage-classes#legacy @@ -95,9 +93,8 @@ public StorageClass apply(String constant) { public static final StorageClass MULTI_REGIONAL = type.createAndRegister("MULTI_REGIONAL"); /** - * Durable Reduced Availability storage class. This is supported as a legacy storage class and - * will be deprecated in the future. This class cannot be set. Unless you already are using it, - * you should use {@link #STANDARD} instead. + * Legacy Durable Reduced Availability storage class, use {@link #STANDARD} instead. This class + * will be deprecated in the future. * * @see https://cloud.google.com/storage/docs/storage-classes#legacy