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
Inherited Members
com.google.cloud.storage.UnifiedOpts.OptionShim.equals(java.lang.Object)
com.google.cloud.storage.UnifiedOpts.OptionShim.hashCode()
com.google.cloud.storage.UnifiedOpts.OptionShim.toString()
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 |
| Name |
Description |
key |
@org.checkerframework.checker.nullness.qual.NonNull java.lang.String
the AES256 encoded in base64
|
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 |
| Name |
Description |
key |
@org.checkerframework.checker.nullness.qual.NonNull java.security.Key
|
dedupe(Storage.BlobGetOption[] os)
public static Storage.BlobGetOption[] dedupe(Storage.BlobGetOption[] os)
Deduplicate any options which are the same parameter. The value which comes last in
os will be the value included in the return.
dedupe(Storage.BlobGetOption[] array, Storage.BlobGetOption[] os)
public static Storage.BlobGetOption[] dedupe(Storage.BlobGetOption[] array, Storage.BlobGetOption[] os)
Deduplicate any options which are the same parameter.
The value which comes last in collection and os will be the value included
in the return. All options from os will override their counterparts in
collection.
dedupe(Collection<Storage.BlobGetOption> collection, Storage.BlobGetOption[] os)
public static Storage.BlobGetOption[] dedupe(Collection<Storage.BlobGetOption> collection, Storage.BlobGetOption[] os)
Deduplicate any options which are the same parameter.
The value which comes last in collection and os will be the value included
in the return. All options from os will override their counterparts in
collection.
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[]
|
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.
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
|
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.
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
|
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
|
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
|
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
|
softDeleted(boolean softDeleted)
public static Storage.BlobGetOption softDeleted(boolean softDeleted)
Returns an option for whether the request should return a soft-deleted object. If an object
has been soft-deleted (Deleted while a Soft Delete Policy) is in place, this must be true or
the request will return null.
| Parameter |
| Name |
Description |
softDeleted |
boolean
|
userProject(@NonNull String userProject)
public static Storage.BlobGetOption userProject(@NonNull 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 |
@org.checkerframework.checker.nullness.qual.NonNull java.lang.String
|
