Package com.google.cloud.storage
Class Storage.BlobWriteOption
java.lang.Object
com.google.cloud.storage.Option<com.google.cloud.storage.UnifiedOpts.ObjectTargetOpt>
com.google.cloud.storage.Storage.BlobWriteOption
- All Implemented Interfaces:
Serializable
- Enclosing interface:
- Storage
public static class Storage.BlobWriteOption
extends Option<com.google.cloud.storage.UnifiedOpts.ObjectTargetOpt>
implements Serializable
Class for specifying blob write options.
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionstatic Storage.BlobWriteOption
Returns an option for blob's data CRC32C checksum match.static Storage.BlobWriteOption[]
dedupe
(Storage.BlobWriteOption... os) Deduplicate any options which are the same parameter.static Storage.BlobWriteOption[]
dedupe
(Storage.BlobWriteOption[] array, Storage.BlobWriteOption... os) Deduplicate any options which are the same parameter.static Storage.BlobWriteOption[]
dedupe
(Collection<Storage.BlobWriteOption> collection, Storage.BlobWriteOption... os) Deduplicate any options which are the same parameter.static Storage.BlobWriteOption
Returns an option for detecting content type.static Storage.BlobWriteOption
Returns an option that signals automatic gzip compression should not be performed en route to the bucket.static Storage.BlobWriteOption
Returns an option that causes an operation to succeed only if the target blob does not exist.static Storage.BlobWriteOption
encryptionKey
(@NonNull String key) Returns an option to set a customer-supplied AES256 key for server-side encryption of the blob.static Storage.BlobWriteOption
encryptionKey
(@NonNull Key key) Returns an option to set a customer-supplied AES256 key for server-side encryption of the blob.boolean
Deprecated.static Storage.BlobWriteOption
Returns an option for blob's data generation match.static Storage.BlobWriteOption
generationMatch
(long generation) Returns an option for blob's data generation match.static Storage.BlobWriteOption
Returns an option for blob's data generation mismatch.static Storage.BlobWriteOption
generationNotMatch
(long generation) Returns an option for blob's data generation mismatch.int
hashCode()
Deprecated.static Storage.BlobWriteOption
kmsKeyName
(@NonNull String kmsKeyName) Returns an option to set a customer-managed KMS key for server-side encryption of the blob.static Storage.BlobWriteOption
md5Match()
Deprecated.Please compute and use a crc32c checksum instead.static Storage.BlobWriteOption
Returns an option for blob's metageneration match.static Storage.BlobWriteOption
metagenerationMatch
(long metageneration) Returns an option for blob's metageneration match.static Storage.BlobWriteOption
Returns an option for blob's metageneration mismatch.static Storage.BlobWriteOption
metagenerationNotMatch
(long metageneration) Returns an option for blob's metageneration mismatch.static Storage.BlobWriteOption
predefinedAcl
(@NonNull Storage.PredefinedAcl acl) Returns an option for specifying blob's predefined ACL configuration.toString()
Deprecated.static Storage.BlobWriteOption
userProject
(@NonNull String userProject) Returns an option for blob's billing user project.
-
Method Details
-
predefinedAcl
@TransportCompatibility({HTTP,GRPC}) public static Storage.BlobWriteOption predefinedAcl(@NonNull Storage.PredefinedAcl acl) Returns an option for specifying blob's predefined ACL configuration. -
doesNotExist
Returns an option that causes an operation to succeed only if the target blob does not exist. -
generationMatch
Returns an option for blob's data generation match. If this option is used the request will fail if generation does not match. -
generationMatch
@TransportCompatibility({HTTP,GRPC}) public static Storage.BlobWriteOption 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
Returns an option for blob's data generation mismatch. If this option is used the request will fail if generation matches. -
generationNotMatch
@TransportCompatibility({HTTP,GRPC}) public static Storage.BlobWriteOption 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 does not match the provided value. -
metagenerationMatch
Returns an option for blob's metageneration match. If this option is used the request will fail if metageneration does not match. -
metagenerationMatch
@TransportCompatibility({HTTP,GRPC}) public static Storage.BlobWriteOption metagenerationMatch(long metageneration) Returns an option for blob's metageneration match. If this option is used the request will fail if blob's generation does not match the provided value. -
metagenerationNotMatch
Returns an option for blob's metageneration mismatch. If this option is used the request will fail if metageneration matches. -
metagenerationNotMatch
@TransportCompatibility({HTTP,GRPC}) public static Storage.BlobWriteOption metagenerationNotMatch(long metageneration) Returns an option for blob's metageneration mismatch. If this option is used the request will fail if blob's generation does not match the provided value. -
md5Match
Deprecated.Please compute and use a crc32c checksum instead.crc32cMatch()
Returns an option for blob's data MD5 hash match. If this option is used the request will fail if blobs' data MD5 hash does not match. -
crc32cMatch
Returns an option for blob's data CRC32C checksum match. If this option is used the request will fail if blobs' data CRC32C checksum does not match. -
encryptionKey
@TransportCompatibility({HTTP,GRPC}) public static Storage.BlobWriteOption encryptionKey(@NonNull Key key) Returns an option to set a customer-supplied AES256 key for server-side encryption of the blob. -
encryptionKey
@TransportCompatibility({HTTP,GRPC}) public static Storage.BlobWriteOption encryptionKey(@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
-
kmsKeyName
@TransportCompatibility({HTTP,GRPC}) public static Storage.BlobWriteOption kmsKeyName(@NonNull String kmsKeyName) Returns an option to set a customer-managed KMS key for server-side encryption of the blob.- Parameters:
kmsKeyName
- the KMS key resource id
-
userProject
@TransportCompatibility({HTTP,GRPC}) public static Storage.BlobWriteOption 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. -
disableGzipContent
Returns an option that signals automatic gzip compression should not be performed en route to the bucket. -
detectContentType
Returns an option for detecting content type. If this option is used, the content type is detected from the blob name if not explicitly set. This option is on the client side only, it does not appear in a RPC call.Content type detection is based on the database presented by
URLConnection.getFileNameMap()
-
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.BlobWriteOption[] dedupe(Collection<Storage.BlobWriteOption> collection, Storage.BlobWriteOption... 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.BlobWriteOption[] dedupe(Storage.BlobWriteOption[] array, Storage.BlobWriteOption... 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.
-