Class Storage.BlobGetOption (2.20.1)

Stay organized with collections Save and categorize content based on your preferences.
public static class Storage.BlobGetOption extends Option<UnifiedOpts.ObjectSourceOpt>

Class for specifying blob get options.

Inheritance

java.lang.Object > com.google.cloud.storage.UnifiedOpts.OptionShim > Option > Storage.BlobGetOption

Static Methods

decryptionKey(@NonNull String key)

public static Storage.BlobGetOption decryptionKey(@NonNull String key)

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

Parameter
NameDescription
key@org.checkerframework.checker.nullness.qual.NonNull java.lang.String

the AES256 encoded in base64

Returns
TypeDescription
Storage.BlobGetOption

decryptionKey(@NonNull Key key)

public static Storage.BlobGetOption decryptionKey(@NonNull Key key)

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

Parameter
NameDescription
key@org.checkerframework.checker.nullness.qual.NonNull java.security.Key
Returns
TypeDescription
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
NameDescription
fieldsBlobField[]
Returns
TypeDescription
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
TypeDescription
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
NameDescription
generationlong
Returns
TypeDescription
Storage.BlobGetOption

generationNotMatch() (deprecated)

public static Storage.BlobGetOption generationNotMatch()

Deprecated. This option is invalid, and can never result in a valid response from the server. use #generationNotMatch(long) instead.

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