Package com.google.cloud.storage
Class Storage.BlobGetOption
java.lang.Object
com.google.cloud.storage.Option<com.google.cloud.storage.UnifiedOpts.ObjectSourceOpt>
com.google.cloud.storage.Storage.BlobGetOption
- All Implemented Interfaces:
Serializable
- Enclosing interface:
- Storage
public static class Storage.BlobGetOption
extends Option<com.google.cloud.storage.UnifiedOpts.ObjectSourceOpt>
Class for specifying blob get options.
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionstatic Storage.BlobGetOption
decryptionKey
(@NonNull String key) Returns an option to set a customer-supplied AES256 key for server-side decryption of the blob.static Storage.BlobGetOption
decryptionKey
(@NonNull Key key) Returns an option to set a customer-supplied AES256 key for server-side decryption of the blob.static Storage.BlobGetOption[]
dedupe
(Storage.BlobGetOption... os) Deduplicate any options which are the same parameter.static Storage.BlobGetOption[]
dedupe
(Storage.BlobGetOption[] array, Storage.BlobGetOption... os) Deduplicate any options which are the same parameter.static Storage.BlobGetOption[]
dedupe
(Collection<Storage.BlobGetOption> collection, Storage.BlobGetOption... os) Deduplicate any options which are the same parameter.boolean
Deprecated.static Storage.BlobGetOption
fields
(Storage.BlobField... fields) Returns an option to specify the blob's fields to be returned by the RPC call.static Storage.BlobGetOption
Returns an option for blob's data generation match.static Storage.BlobGetOption
generationMatch
(long generation) Returns an option for blob's data generation match.static Storage.BlobGetOption
Deprecated.This option is invalid, and can never result in a valid response from the server.static Storage.BlobGetOption
generationNotMatch
(long generation) Returns an option for blob's data generation mismatch.int
hashCode()
Deprecated.static Storage.BlobGetOption
metagenerationMatch
(long metageneration) Returns an option for blob's metageneration match.static Storage.BlobGetOption
metagenerationNotMatch
(long metageneration) Returns an option for blob's metageneration mismatch.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.toString()
Deprecated.static Storage.BlobGetOption
userProject
(@NonNull String userProject) Returns an option for blob's billing user project.
-
Method Details
-
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 sourceBlobId
object. When this option is passed to aStorage
method andBlobId.getGeneration()
isnull
or noBlobId
is provided an exception is thrown. -
generationMatch
@TransportCompatibility({HTTP,GRPC}) 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. -
generationNotMatch
@Deprecated @TransportCompatibility({HTTP,GRPC}) public static Storage.BlobGetOption generationNotMatch()Deprecated.This option is invalid, and can never result in a valid response from the server. usegenerationNotMatch(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 sourceBlobId
object. When this option is passed to aStorage
method andBlobId.getGeneration()
isnull
or noBlobId
is provided an exception is thrown. -
generationNotMatch
@TransportCompatibility({HTTP,GRPC}) 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. -
metagenerationMatch
@TransportCompatibility({HTTP,GRPC}) 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. -
metagenerationNotMatch
@TransportCompatibility({HTTP,GRPC}) 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. -
fields
@TransportCompatibility({HTTP,GRPC}) 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. -
userProject
@TransportCompatibility({HTTP,GRPC}) 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. -
decryptionKey
@TransportCompatibility({HTTP,GRPC}) 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. -
decryptionKey
@TransportCompatibility({HTTP,GRPC}) 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.- Parameters:
key
- the AES256 encoded in base64
-
shouldReturnRawInputStream
@TransportCompatibility({HTTP,GRPC}) 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(). -
dedupe
Deduplicate any options which are the same parameter. The value which comes last inos
will be the value included in the return. -
dedupe
@BetaApi 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
andos
will be the value included in the return. All options fromos
will override their counterparts incollection
. -
dedupe
@BetaApi 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
andos
will be the value included in the return. All options fromos
will override their counterparts incollection
. -
equals
Deprecated. -
hashCode
public int hashCode()Deprecated. -
toString
Deprecated.
-