Class Bucket.BlobWriteOption (2.14.0) 

public static class Bucket.BlobWriteOption extends UnifiedOpts.OptionShim<UnifiedOpts.ObjectTargetOpt> implements Serializable

Class for specifying blob write options when Bucket methods are used.

Inheritance

java.lang.Object > com.google.cloud.storage.UnifiedOpts.OptionShim > Bucket.BlobWriteOption

Implements

Serializable

Static Methods

crc32cMatch(String crc32c)

public static Bucket.BlobWriteOption crc32cMatch(String crc32c)

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 the provided value.

Parameter
Name Description
crc32c String
Returns
Type Description
Bucket.BlobWriteOption

doesNotExist()

public static Bucket.BlobWriteOption doesNotExist()

Returns an option that causes an operation to succeed only if the target blob does not exist. This option can not be provided together with #generationMatch(long) or #generationNotMatch(long).

Returns
Type Description
Bucket.BlobWriteOption

encryptionKey(String key)

public static Bucket.BlobWriteOption encryptionKey(String key)

Returns an option to set a customer-supplied AES256 key for server-side encryption of the blob.

Parameter
Name Description
key String

the AES256 encoded in base64
Returns
Type Description
Bucket.BlobWriteOption

encryptionKey(Key key)

public static Bucket.BlobWriteOption encryptionKey(Key key)

Returns an option to set a customer-supplied AES256 key for server-side encryption of the blob.

Parameter
Name Description
key Key
Returns
Type Description
Bucket.BlobWriteOption

generationMatch(long generation)

public static Bucket.BlobWriteOption generationMatch(long generation)

Returns an option for blob's data generation match. If this option is used the request will fail if generation does not match the provided value. This option can not be provided together with #generationNotMatch(long) or #doesNotExist().

Parameter
Name Description
generation long
Returns
Type Description
Bucket.BlobWriteOption

generationNotMatch(long generation)

public static Bucket.BlobWriteOption generationNotMatch(long generation)

Returns an option for blob's data generation mismatch. If this option is used the request will fail if generation matches the provided value. This option can not be provided together with #generationMatch(long) or #doesNotExist().

Parameter
Name Description
generation long
Returns
Type Description
Bucket.BlobWriteOption

md5Match(String md5)

public static Bucket.BlobWriteOption md5Match(String md5)

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 the provided value.

Parameter
Name Description
md5 String
Returns
Type Description
Bucket.BlobWriteOption

metagenerationMatch(long metageneration)

public static Bucket.BlobWriteOption metagenerationMatch(long metageneration)

Returns an option for blob's metageneration match. If this option is used the request will fail if metageneration does not match the provided value. This option can not be provided together with #metagenerationNotMatch(long).

Parameter
Name Description
metageneration long
Returns
Type Description
Bucket.BlobWriteOption

metagenerationNotMatch(long metageneration)

public static Bucket.BlobWriteOption metagenerationNotMatch(long metageneration)

Returns an option for blob's metageneration mismatch. If this option is used the request will fail if metageneration matches the provided value. This option can not be provided together with #metagenerationMatch(long).

Parameter
Name Description
metageneration long
Returns
Type Description
Bucket.BlobWriteOption

predefinedAcl(Storage.PredefinedAcl acl)

public static Bucket.BlobWriteOption predefinedAcl(Storage.PredefinedAcl acl)

Returns an option for specifying blob's predefined ACL configuration.

Parameter
Name Description
acl Storage.PredefinedAcl
Returns
Type Description
Bucket.BlobWriteOption

userProject(String userProject)

public static Bucket.BlobWriteOption userProject(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 String
Returns
Type Description
Bucket.BlobWriteOption