Class Storage.BlobGetOption (2.3.0) 

public static class Storage.BlobGetOption extends Option

Class for specifying blob get options.

Inheritance

java.lang.Object > Option > Storage.BlobGetOption

Static Methods

decryptionKey(String key)

public static Storage.BlobGetOption decryptionKey(String key)

Returns an option to set a customer-supplied AES256 key for server-side decryption of the blob.

Parameter
Name Description
key String

the AES256 encoded in base64
Returns
Type Description
Storage.BlobGetOption

decryptionKey(Key key)

public static Storage.BlobGetOption decryptionKey(Key key)

Returns an option to set a customer-supplied AES256 key for server-side decryption of the blob.

Parameter
Name Description
key Key
Returns
Type Description
Storage.BlobGetOption

fields(Storage.BlobField[] fields)

public static Storage.BlobGetOption fields(Storage.BlobField[] fields)

Returns an option to specify the blob's fields to be returned by the RPC call. If this option is not provided all blob's fields are returned. BlobGetOption.fields) can be used to specify only the fields of interest. Blob name and bucket are always returned, even if not specified.

Parameter
Name Description
fields BlobField[]
Returns
Type Description
Storage.BlobGetOption

generationMatch()

public static Storage.BlobGetOption generationMatch()

Returns an option for blob's data generation match. If this option is used the request will fail if blob's generation does not match. The generation value to compare with the actual blob's generation is taken from a source BlobId object. When this option is passed to a Storage method and BlobId#getGeneration() is null or no BlobId is provided an exception is thrown.

Returns
Type Description
Storage.BlobGetOption

generationMatch(long generation)

public static Storage.BlobGetOption generationMatch(long generation)

Returns an option for blob's data generation match. If this option is used the request will fail if blob's generation does not match the provided value.

Parameter
Name Description
generation long
Returns
Type Description
Storage.BlobGetOption

generationNotMatch()

public static Storage.BlobGetOption generationNotMatch()

Returns an option for blob's data generation mismatch. If this option is used the request will fail if blob's generation matches. The generation value to compare with the actual blob's generation is taken from a source BlobId object. When this option is passed to a Storage method and BlobId#getGeneration() is null or no BlobId is provided an exception is thrown.

Returns
Type Description
Storage.BlobGetOption

generationNotMatch(long generation)

public static Storage.BlobGetOption generationNotMatch(long generation)

Returns an option for blob's data generation mismatch. If this option is used the request will fail if blob's generation matches the provided value.

Parameter
Name Description
generation long
Returns
Type Description
Storage.BlobGetOption

metagenerationMatch(long metageneration)

public static Storage.BlobGetOption metagenerationMatch(long metageneration)

Returns an option for blob's metageneration match. If this option is used the request will fail if blob's metageneration does not match the provided value.

Parameter
Name Description
metageneration long
Returns
Type Description
Storage.BlobGetOption

metagenerationNotMatch(long metageneration)

public static Storage.BlobGetOption metagenerationNotMatch(long metageneration)

Returns an option for blob's metageneration mismatch. If this option is used the request will fail if blob's metageneration matches the provided value.

Parameter
Name Description
metageneration long
Returns
Type Description
Storage.BlobGetOption

shouldReturnRawInputStream(boolean shouldReturnRawInputStream)

public static Storage.BlobGetOption shouldReturnRawInputStream(boolean shouldReturnRawInputStream)

Returns an option for whether the request should return the raw input stream, instead of automatically decompressing the content. By default, this is false for Blob.downloadTo(), but true for ReadChannel.read().

Parameter
Name Description
shouldReturnRawInputStream boolean
Returns
Type Description
Storage.BlobGetOption

userProject(String userProject)

public static Storage.BlobGetOption userProject(String userProject)

Returns an option for blob's billing user project. This option is only used by the buckets with 'requester_pays' flag.

Parameter
Name Description
userProject String
Returns
Type Description
Storage.BlobGetOption