Skip to content

Commit 50e5938

Browse files
authored
docs: label legacy storage classes in documentation (#267)
Fixes #254
1 parent e11ff16 commit 50e5938

File tree

1 file changed

+34
-14
lines changed

1 file changed

+34
-14
lines changed

google-cloud-storage/src/main/java/com/google/cloud/storage/StorageClass.java

+34-14
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,9 @@
2020
import com.google.cloud.StringEnumValue;
2121

2222
/**
23-
* Enums for the storage classes. See https://cloud.google.com/storage/docs/storage-classes for
24-
* details.
23+
* Enums for the storage classes. See <a
24+
* href="https://cloud.google.com/storage/docs/storage-classes">https://cloud.google.com/storage/docs/storage-classes</a>
25+
* for details.
2526
*/
2627
public final class StorageClass extends StringEnumValue {
2728
private static final long serialVersionUID = -6938125060419556331L;
@@ -42,42 +43,61 @@ public StorageClass apply(String constant) {
4243
new StringEnumType(StorageClass.class, CONSTRUCTOR);
4344

4445
/**
45-
* Standard storage class. See: https://cloud.google.com/storage/docs/storage-classes for details
46+
* Standard storage class.
47+
*
48+
* @see <a
49+
* href="https://cloud.google.com/storage/docs/storage-classes#standard">https://cloud.google.com/storage/docs/storage-classes#standard</a>
4650
*/
4751
public static final StorageClass STANDARD = type.createAndRegister("STANDARD");
4852

4953
/**
50-
* Nearline storage class. See: https://cloud.google.com/storage/docs/storage-classes for details
54+
* Nearline storage class.
55+
*
56+
* @see <a
57+
* href="https://cloud.google.com/storage/docs/storage-classes#nearline">https://cloud.google.com/storage/docs/storage-classes#nearline</a>
5158
*/
5259
public static final StorageClass NEARLINE = type.createAndRegister("NEARLINE");
5360

5461
/**
55-
* Coldline storage class. See: https://cloud.google.com/storage/docs/storage-classes for details
62+
* Coldline storage class.
63+
*
64+
* @see <a
65+
* href="https://cloud.google.com/storage/docs/storage-classes#coldline">https://cloud.google.com/storage/docs/storage-classes#coldline</a>
5666
*/
5767
public static final StorageClass COLDLINE = type.createAndRegister("COLDLINE");
5868

5969
/**
60-
* Archive storage class. See: https://cloud.google.com/storage/docs/storage-classes for details
70+
* Archive storage class.
71+
*
72+
* @see <a
73+
* href="https://cloud.google.com/storage/docs/storage-classes#archive">https://cloud.google.com/storage/docs/storage-classes#archive</a>
6174
*/
6275
public static final StorageClass ARCHIVE = type.createAndRegister("ARCHIVE");
6376

6477
/**
65-
* Regional storage class. This is supported as a legacy storage class and will be deprecated in
66-
* the future. See: https://cloud.google.com/storage/docs/storage-classes for details
78+
* Legacy Regional storage class, use {@link #STANDARD} instead. This class will be deprecated in
79+
* the future.
80+
*
81+
* @see <a
82+
* href="https://cloud.google.com/storage/docs/storage-classes#legacy">https://cloud.google.com/storage/docs/storage-classes#legacy</a>
6783
*/
6884
public static final StorageClass REGIONAL = type.createAndRegister("REGIONAL");
6985

7086
/**
71-
* Multi-regional storage class. This is supported as a legacy storage class and will be
72-
* deprecated in the future. See: https://cloud.google.com/storage/docs/storage-classes for
73-
* details
87+
* Legacy Multi-regional storage class, use {@link #STANDARD} instead. This class will be
88+
* deprecated in the future.
89+
*
90+
* @see <a
91+
* href="https://cloud.google.com/storage/docs/storage-classes#legacy">https://cloud.google.com/storage/docs/storage-classes#legacy</a>
7492
*/
7593
public static final StorageClass MULTI_REGIONAL = type.createAndRegister("MULTI_REGIONAL");
7694

7795
/**
78-
* Durable Reduced Availability storage class. This is supported as a legacy storage class and
79-
* will be deprecated in the future. See: https://cloud.google.com/storage/docs/storage-classes
80-
* for details
96+
* Legacy Durable Reduced Availability storage class, use {@link #STANDARD} instead. This class
97+
* will be deprecated in the future.
98+
*
99+
* @see <a
100+
* href="https://cloud.google.com/storage/docs/storage-classes#legacy">https://cloud.google.com/storage/docs/storage-classes#legacy</a>
81101
*/
82102
public static final StorageClass DURABLE_REDUCED_AVAILABILITY =
83103
type.createAndRegister("DURABLE_REDUCED_AVAILABILITY");

0 commit comments

Comments
 (0)