Class Bucket.BlobTargetOption (2.45.0)

Version 2.45.0

• 2.46.0 (latest)
• 2.45.0
• 2.44.1
• 2.43.2
• 2.42.0
• 2.41.0
• 2.40.1
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.1
• 2.34.0
• 2.33.0
• 2.32.1
• 2.30.1
• 2.29.1
• 2.28.0
• 2.27.1
• 2.24.0
• 2.23.0
• 2.22.6
• 2.21.0
• 2.20.2
• 2.19.0
• 2.18.0
• 2.17.2
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.1
• 2.12.0
• 2.11.3
• 2.10.0
• 2.9.3
• 2.8.1
• 2.7.1
• 2.6.1
• 2.5.1
• 2.4.5
• 2.3.0
• 2.2.3
• 2.1.10

public static class Bucket.BlobTargetOption extends Option<UnifiedOpts.ObjectTargetOpt>

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

Inheritance

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

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()

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

dedupe(Bucket.BlobTargetOption[] os)

public static Bucket.BlobTargetOption[] dedupe(Bucket.BlobTargetOption[] os)

Deduplicate any options which are the same parameter. The value which comes last in os will be the value included in the return.

Parameter
Name	Description
os	BlobTargetOption[]

Returns
Type	Description
BlobTargetOption[]

dedupe(Bucket.BlobTargetOption[] array, Bucket.BlobTargetOption[] os)

public static Bucket.BlobTargetOption[] dedupe(Bucket.BlobTargetOption[] array, Bucket.BlobTargetOption[] os)

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.

Parameters
Name	Description
array	BlobTargetOption[]
os	BlobTargetOption[]

Returns
Type	Description
BlobTargetOption[]

dedupe(Collection<Bucket.BlobTargetOption> collection, Bucket.BlobTargetOption[] os)

public static Bucket.BlobTargetOption[] dedupe(Collection<Bucket.BlobTargetOption> collection, Bucket.BlobTargetOption[] os)

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.

Parameters
Name	Description
collection	Collection<BlobTargetOption>
os	BlobTargetOption[]

Returns
Type	Description
BlobTargetOption[]

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(@NonNull String key)

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

Returns
Type	Description
Bucket.BlobTargetOption

encryptionKey(@NonNull Key key)

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

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(@NonNull String kmsKeyName)

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

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

overrideUnlockedRetention(boolean overrideUnlockedRetention)

public static Bucket.BlobTargetOption overrideUnlockedRetention(boolean overrideUnlockedRetention)

Returns an option for overriding an Unlocked Retention policy. This must be set to true in order to change a policy from Unlocked to Locked, to set it to null, or to reduce its retainUntilTime attribute.

Parameter
Name	Description
overrideUnlockedRetention	boolean

Returns
Type	Description
Bucket.BlobTargetOption

predefinedAcl(@NonNull Storage.PredefinedAcl acl)

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

Returns
Type	Description
Bucket.BlobTargetOption

userProject(@NonNull String userProject)

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

Returns
Type	Description
Bucket.BlobTargetOption