Class Storage.BlobWriteOption (2.38.0)
Version 2.38.0keyboard_arrow_down
public static class Storage . BlobWriteOption extends Option<UnifiedOpts . ObjectTargetOpt > implements Serializable
Class for specifying blob write options.
Inheritance
java.lang.Object >
com.google.cloud.storage.UnifiedOpts.OptionShim >
Option >
Storage.BlobWriteOption
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
crc32cMatch()
public static Storage . BlobWriteOption 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.
dedupe(Storage.BlobWriteOption[] os)
public static Storage . BlobWriteOption [] dedupe ( Storage . BlobWriteOption [] os )
Beta
This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.
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.BlobWriteOption[] array, Storage.BlobWriteOption[] os)
public static Storage . BlobWriteOption [] dedupe ( Storage . BlobWriteOption [] array , Storage . BlobWriteOption [] os )
Beta
This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.
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.BlobWriteOption> collection, Storage.BlobWriteOption[] os)
public static Storage . BlobWriteOption [] dedupe ( Collection<Storage . BlobWriteOption > collection , Storage . BlobWriteOption [] os )
Beta
This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.
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.
detectContentType()
public static Storage . BlobWriteOption 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()
disableGzipContent()
public static Storage . BlobWriteOption disableGzipContent ()
Returns an option that signals automatic gzip compression should not be performed en route to
the bucket.
doesNotExist()
public static Storage . BlobWriteOption doesNotExist ()
Returns an option that causes an operation to succeed only if the target blob does not exist.
encryptionKey(@NonNull String key)
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.
Parameter
Name Description
key@org.checkerframework.checker.nullness.qual.NonNull java.lang.String the AES256 encoded in base64
encryptionKey(@NonNull Key key)
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.
Parameter
Name Description
key@org.checkerframework.checker.nullness.qual.NonNull java.security.Key
generationMatch()
public static Storage . BlobWriteOption 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(long generation)
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.
Parameter
Name Description
generationlong
generationNotMatch()
public static Storage . BlobWriteOption generationNotMatch ()
Returns an option for blob's data generation mismatch. If this option is used the request
will fail if generation matches.
generationNotMatch(long generation)
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.
Parameter
Name Description
generationlong
kmsKeyName(@NonNull String kmsKeyName)
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.
Parameter
Name Description
kmsKeyName@org.checkerframework.checker.nullness.qual.NonNull java.lang.String the KMS key resource id
md5Match() (deprecated)
public static Storage . BlobWriteOption 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.
public static Storage . BlobWriteOption metagenerationMatch ()
Returns an option for blob's metageneration match. If this option is used the request will
fail if metageneration does not match.
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.
Parameter
Name Description
metagenerationlong
public static Storage . BlobWriteOption metagenerationNotMatch ()
Returns an option for blob's metageneration mismatch. If this option is used the request will
fail if metageneration matches.
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.
Parameter
Name Description
metagenerationlong
predefinedAcl(@NonNull Storage.PredefinedAcl acl)
public static Storage . BlobWriteOption predefinedAcl ( @NonNull Storage . PredefinedAcl acl )
Returns an option for specifying blob's predefined ACL configuration.
Parameter
Name Description
acl@org.checkerframework.checker.nullness.qual.NonNull com.google.cloud.storage.Storage.PredefinedAcl
userProject(@NonNull String userProject)
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.
Parameter
Name Description
userProject@org.checkerframework.checker.nullness.qual.NonNull java.lang.String
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-29 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-29 UTC."],[],[]]
