Package com.google.cloud.storage
Class Storage.BlobSourceOption
java.lang.Object
com.google.cloud.storage.Option<com.google.cloud.storage.UnifiedOpts.ObjectSourceOpt>
com.google.cloud.storage.Storage.BlobSourceOption
- All Implemented Interfaces:
Serializable
- Enclosing interface:
- Storage
public static class Storage.BlobSourceOption
extends Option<com.google.cloud.storage.UnifiedOpts.ObjectSourceOpt>
Class for specifying blob source options.
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionstatic Storage.BlobSourceOption
decryptionKey
(@NonNull String key) Returns an option to set a customer-supplied AES256 key for server-side encryption of the blob.static Storage.BlobSourceOption
decryptionKey
(@NonNull Key key) Returns an option to set a customer-supplied AES256 key for server-side encryption of the blob.static Storage.BlobSourceOption[]
dedupe
(Storage.BlobSourceOption... os) Deduplicate any options which are the same parameter.static Storage.BlobSourceOption[]
dedupe
(Storage.BlobSourceOption[] array, Storage.BlobSourceOption... os) Deduplicate any options which are the same parameter.static Storage.BlobSourceOption[]
dedupe
(Collection<Storage.BlobSourceOption> collection, Storage.BlobSourceOption... os) Deduplicate any options which are the same parameter.boolean
Deprecated.static Storage.BlobSourceOption
Returns an option for blob's data generation match.static Storage.BlobSourceOption
generationMatch
(long generation) Returns an option for blob's data generation match.static Storage.BlobSourceOption
Deprecated.This option is invalid, and can never result in a valid response from the server.static Storage.BlobSourceOption
generationNotMatch
(long generation) Returns an option for blob's data generation mismatch.int
hashCode()
Deprecated.static Storage.BlobSourceOption
metagenerationMatch
(long metageneration) Returns an option for blob's metageneration match.static Storage.BlobSourceOption
metagenerationNotMatch
(long metageneration) Returns an option for blob's metageneration mismatch.static Storage.BlobSourceOption
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.BlobSourceOption
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.BlobSourceOption 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.BlobSourceOption 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.BlobSourceOption 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.BlobSourceOption 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.BlobSourceOption 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. -
decryptionKey
@TransportCompatibility({HTTP,GRPC}) public static Storage.BlobSourceOption decryptionKey(@NonNull Key key) Returns an option to set a customer-supplied AES256 key for server-side encryption of the blob. -
decryptionKey
@TransportCompatibility({HTTP,GRPC}) public static Storage.BlobSourceOption decryptionKey(@NonNull String key) Returns an option to set a customer-supplied AES256 key for server-side encryption of the blob.- Parameters:
key
- the AES256 encoded in base64
-
userProject
@TransportCompatibility({HTTP,GRPC}) public static Storage.BlobSourceOption 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. -
shouldReturnRawInputStream
@TransportCompatibility({HTTP,GRPC}) public static Storage.BlobSourceOption 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.BlobSourceOption[] dedupe(Collection<Storage.BlobSourceOption> collection, Storage.BlobSourceOption... 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.BlobSourceOption[] dedupe(Storage.BlobSourceOption[] array, Storage.BlobSourceOption... 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.
-