Skip to content

Commit 0c2d6f6

Browse files
committed
---
yaml --- r: 2455 b: refs/heads/update-datastore c: 7193d0d h: refs/heads/master i: 2453: 5817c1e 2451: acc1908 2447: b46b4a2
1 parent 8f252bb commit 0c2d6f6

2 files changed

Lines changed: 56 additions & 13 deletions

File tree

  • branches/update-datastore/gcloud-java-storage/src/main/java/com/google/gcloud/storage

[refs]

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ refs/heads/gh-pages: 4e0561bb4504bf647db669a14417b2b2c87ba45d
55
refs/heads/bigquery: 762fa5830e6c398c0396177e3e7fd243bd62cfc3
66
refs/heads/pubsub-alpha: 1a0e970f265af871e02274085b9662b3fe29058b
77
refs/heads/resource-manager: ebf4adc5ee835cd2086c4ac5b4e78d01a5a005a7
8-
refs/heads/update-datastore: b9ef50883ddda7e19f1f9ec4599dca4c279c6ce8
8+
refs/heads/update-datastore: 7193d0d02a252f9c8cb0ece901fc6e16e59f5413
99
refs/tags/0.0.9: 22f1839238f66c39e67ed4dfdcd273b1ae2e8444
1010
refs/tags/v0.0.10: 207ebd2a3472fddee69fe1298eb90429e3306efd
1111
refs/tags/v0.0.11: ffbfba48a6426ff63c08ff2117e58681f251fbf2

branches/update-datastore/gcloud-java-storage/src/main/java/com/google/gcloud/storage/BlobInfo.java

Lines changed: 55 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,8 @@ Builder id(String id) {
138138

139139
/**
140140
* Sets the blob's data content type.
141+
*
142+
* @see <a href="https://tools.ietf.org/html/rfc2616#section-14.17">Content-Type</a>
141143
*/
142144
public Builder contentType(String contentType) {
143145
this.contentType = firstNonNull(contentType, Data.<String>nullOf(String.class));
@@ -146,6 +148,8 @@ public Builder contentType(String contentType) {
146148

147149
/**
148150
* Sets the blob's data content disposition.
151+
*
152+
* @see <a href="https://tools.ietf.org/html/rfc6266">Content-Disposition</a>
149153
*/
150154
public Builder contentDisposition(String contentDisposition) {
151155
this.contentDisposition = firstNonNull(contentDisposition, Data.<String>nullOf(String.class));
@@ -154,6 +158,8 @@ public Builder contentDisposition(String contentDisposition) {
154158

155159
/**
156160
* Sets the blob's data content language.
161+
*
162+
* @see <a href="http://tools.ietf.org/html/bcp47">Content-Language</a>
157163
*/
158164
public Builder contentLanguage(String contentLanguage) {
159165
this.contentLanguage = firstNonNull(contentLanguage, Data.<String>nullOf(String.class));
@@ -162,6 +168,8 @@ public Builder contentLanguage(String contentLanguage) {
162168

163169
/**
164170
* Sets the blob's data content encoding.
171+
*
172+
* @see <a href="https://tools.ietf.org/html/rfc7231#section-3.1.2.2">Content-Encoding</a>
165173
*/
166174
public Builder contentEncoding(String contentEncoding) {
167175
this.contentEncoding = firstNonNull(contentEncoding, Data.<String>nullOf(String.class));
@@ -175,6 +183,8 @@ Builder componentCount(Integer componentCount) {
175183

176184
/**
177185
* Sets the blob's data cache control.
186+
*
187+
* @see <a href="https://tools.ietf.org/html/rfc7234#section-5.2">Cache-Control</a>
178188
*/
179189
public Builder cacheControl(String cacheControl) {
180190
this.cacheControl = firstNonNull(cacheControl, Data.<String>nullOf(String.class));
@@ -214,15 +224,22 @@ Builder selfLink(String selfLink) {
214224

215225
/**
216226
* Sets the MD5 hash of blob's data. MD5 value must be encoded in base64.
227+
*
228+
* @see <a href="https://cloud.google.com/storage/docs/hashes-etags#_JSONAPI">
229+
* Hashes and ETags: Best Practices</a>
217230
*/
218231
public Builder md5(String md5) {
219232
this.md5 = firstNonNull(md5, Data.<String>nullOf(String.class));
220233
return this;
221234
}
222235

223236
/**
224-
* Sets the CRC32C checksum of blob's data. CRC32C value must be encoded in base64 in big-endian
225-
* order.
237+
* Sets the CRC32C checksum of blob's data as described in
238+
* <a href="http://tools.ietf.org/html/rfc4960#appendix-B">RFC 4960, Appendix B;</a> encoded in
239+
* base64 in big-endian order.
240+
*
241+
* @see <a href="https://cloud.google.com/storage/docs/hashes-etags#_JSONAPI">
242+
* Hashes and ETags: Best Practices</a>
226243
*/
227244
public Builder crc32c(String crc32c) {
228245
this.crc32c = firstNonNull(crc32c, Data.<String>nullOf(String.class));
@@ -235,7 +252,7 @@ Builder mediaLink(String mediaLink) {
235252
}
236253

237254
/**
238-
* Sets the blob's metadata.
255+
* Sets the blob's user provided metadata.
239256
*/
240257
public Builder metadata(Map<String, String> metadata) {
241258
this.metadata = metadata != null
@@ -326,6 +343,8 @@ public String name() {
326343

327344
/**
328345
* Returns the blob's data cache control.
346+
*
347+
* @see <a href="https://tools.ietf.org/html/rfc7234#section-5.2">Cache-Control</a>
329348
*/
330349
public String cacheControl() {
331350
return Data.isNull(cacheControl) ? null : cacheControl;
@@ -342,50 +361,62 @@ public List<Acl> acl() {
342361
}
343362

344363
/**
345-
* Returns the blob's owner.
364+
* Returns the blob's owner. This will always be the uploader of the blob.
346365
*/
347366
public Acl.Entity owner() {
348367
return owner;
349368
}
350369

351370
/**
352-
* Returns the blob's data size in bytes.
371+
* Returns the content length of the data in bytes.
372+
*
373+
* @see <a href="https://tools.ietf.org/html/rfc2616#section-14.13">Content-Length</a>
353374
*/
354375
public Long size() {
355376
return size;
356377
}
357378

358379
/**
359380
* Returns the blob's data content type.
381+
*
382+
* @see <a href="https://tools.ietf.org/html/rfc2616#section-14.17">Content-Type</a>
360383
*/
361384
public String contentType() {
362385
return Data.isNull(contentType) ? null : contentType;
363386
}
364387

365388
/**
366389
* Returns the blob's data content encoding.
390+
*
391+
* @see <a href="https://tools.ietf.org/html/rfc7231#section-3.1.2.2">Content-Encoding</a>
367392
*/
368393
public String contentEncoding() {
369394
return Data.isNull(contentEncoding) ? null : contentEncoding;
370395
}
371396

372397
/**
373398
* Returns the blob's data content disposition.
399+
*
400+
* @see <a href="https://tools.ietf.org/html/rfc6266">Content-Disposition</a>
374401
*/
375402
public String contentDisposition() {
376403
return Data.isNull(contentDisposition) ? null : contentDisposition;
377404
}
378405

379406
/**
380407
* Returns the blob's data content language.
408+
*
409+
* @see <a href="http://tools.ietf.org/html/bcp47">Content-Language</a>
381410
*/
382411
public String contentLanguage() {
383412
return Data.isNull(contentLanguage) ? null : contentLanguage;
384413
}
385414

386415
/**
387-
* Returns the number of components that make up this object. Components are accumulated through
388-
* the {@link Storage#compose(Storage.ComposeRequest)} operation.
416+
* Returns the number of components that make up this blob. Components are accumulated through
417+
* the {@link Storage#compose(Storage.ComposeRequest)} operation and are limited to a count of
418+
* 1024, counting 1 for each non-composite component blob and componentCount for each composite
419+
* component blob. This value is set only for composite blobs.
389420
*
390421
* @see <a href="https://cloud.google.com/storage/docs/composite-objects#_Count">Component Count
391422
* Property</a>
@@ -395,7 +426,9 @@ public Integer componentCount() {
395426
}
396427

397428
/**
398-
* Returns blob resource's entity tag.
429+
* Returns HTTP 1.1 Entity tag for the blob.
430+
*
431+
* @see <a href="http://tools.ietf.org/html/rfc2616#section-3.11">Entity Tags</a>
399432
*/
400433
public String etag() {
401434
return etag;
@@ -410,13 +443,21 @@ public String selfLink() {
410443

411444
/**
412445
* Returns the MD5 hash of blob's data encoded in base64.
446+
*
447+
* @see <a href="https://cloud.google.com/storage/docs/hashes-etags#_JSONAPI">
448+
* Hashes and ETags: Best Practices</a>
413449
*/
414450
public String md5() {
415451
return Data.isNull(md5) ? null : md5;
416452
}
417453

418454
/**
419-
* Returns the CRC32C checksum of blob's data encoded in base64 in big-endian order.
455+
* Returns the CRC32C checksum of blob's data as described in
456+
* <a href="http://tools.ietf.org/html/rfc4960#appendix-B">RFC 4960, Appendix B;</a> encoded in
457+
* base64 in big-endian order.
458+
*
459+
* @see <a href="https://cloud.google.com/storage/docs/hashes-etags#_JSONAPI">
460+
* Hashes and ETags: Best Practices</a>
420461
*/
421462
public String crc32c() {
422463
return Data.isNull(crc32c) ? null : crc32c;
@@ -430,21 +471,23 @@ public String mediaLink() {
430471
}
431472

432473
/**
433-
* Returns blob's metadata.
474+
* Returns blob's user provided metadata.
434475
*/
435476
public Map<String, String> metadata() {
436477
return metadata == null || Data.isNull(metadata) ? null : Collections.unmodifiableMap(metadata);
437478
}
438479

439480
/**
440-
* Returns blob's data generation.
481+
* Returns blob's data generation. Used for blob versioning.
441482
*/
442483
public Long generation() {
443484
return generation;
444485
}
445486

446487
/**
447-
* Returns blob's metageneration.
488+
* Returns blob's metageneration. Used for preconditions and for detecting changes in metadata.
489+
* A metageneration number is only meaningful in the context of a particular generation of a
490+
* particular blob.
448491
*/
449492
public Long metageneration() {
450493
return metageneration;

0 commit comments

Comments
 (0)