Class Bucket.BlobTargetOption (2.13.1)

public static class Bucket.BlobTargetOption extends Option

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

Inheritance

Object > Option > Bucket.BlobTargetOption

Static Methods

doesNotExist()

public static Bucket.BlobTargetOption 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.BlobTargetOption

encryptionKey(String key)

public static Bucket.BlobTargetOption 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.BlobTargetOption

encryptionKey(Key key)

public static Bucket.BlobTargetOption 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.BlobTargetOption

generationMatch(long generation)

public static Bucket.BlobTargetOption 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.BlobTargetOption

generationNotMatch(long generation)

public static Bucket.BlobTargetOption 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. This option can not be provided together with #generationMatch(long) or #doesNotExist().

Parameter
Name Description
generation long
Returns
Type Description
Bucket.BlobTargetOption

kmsKeyName(String kmsKeyName)

public static Bucket.BlobTargetOption kmsKeyName(String kmsKeyName)

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

Parameter
Name Description
kmsKeyName String

the KMS key resource id

Returns
Type Description
Bucket.BlobTargetOption

metagenerationMatch(long metageneration)

public static Bucket.BlobTargetOption 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.BlobTargetOption

metagenerationNotMatch(long metageneration)

public static Bucket.BlobTargetOption 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.BlobTargetOption

predefinedAcl(Storage.PredefinedAcl acl)

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

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

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

userProject(String userProject)

public static Bucket.BlobTargetOption 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.BlobTargetOption