Class Storage.BlobTargetOption (2.40.0) 

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

Class for specifying blob target options.

Inheritance

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

Static Methods

dedupe(Storage.BlobTargetOption[] os)

public static Storage.BlobTargetOption[] dedupe(Storage.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(Storage.BlobTargetOption[] array, Storage.BlobTargetOption[] os)

public static Storage.BlobTargetOption[] dedupe(Storage.BlobTargetOption[] array, Storage.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<Storage.BlobTargetOption> collection, Storage.BlobTargetOption[] os)

public static Storage.BlobTargetOption[] dedupe(Collection<Storage.BlobTargetOption> collection, Storage.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[]

detectContentType()

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

Returns
Type Description
Storage.BlobTargetOption

disableGzipContent()

public static Storage.BlobTargetOption disableGzipContent()

Returns an option for blob's data disabledGzipContent. If this option is used, the request will create a blob with disableGzipContent; at present, this is only for upload.

Returns
Type Description
Storage.BlobTargetOption

doesNotExist()

public static Storage.BlobTargetOption doesNotExist()

Returns an option that causes an operation to succeed only if the target blob does not exist.

Returns
Type Description
Storage.BlobTargetOption

encryptionKey(@NonNull String key)

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

encryptionKey(@NonNull Key key)

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

generationMatch()

public static Storage.BlobTargetOption generationMatch()

Returns an option for blob's data generation match. If this option is used the request will fail if generation does not match.

Returns
Type Description
Storage.BlobTargetOption

generationMatch(long generation)

public static Storage.BlobTargetOption 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
generation long
Returns
Type Description
Storage.BlobTargetOption

generationNotMatch()

public static Storage.BlobTargetOption generationNotMatch()

Returns an option for blob's data generation mismatch. If this option is used the request will fail if generation matches.

Returns
Type Description
Storage.BlobTargetOption

generationNotMatch(long generation)

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

Parameter
Name Description
generation long
Returns
Type Description
Storage.BlobTargetOption

kmsKeyName(@NonNull String kmsKeyName)

public static Storage.BlobTargetOption kmsKeyName(@NonNull String kmsKeyName)

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

Parameter
Name Description
kmsKeyName @org.checkerframework.checker.nullness.qual.NonNull java.lang.String
Returns
Type Description
Storage.BlobTargetOption

metagenerationMatch()

public static Storage.BlobTargetOption metagenerationMatch()

Returns an option for blob's metageneration match. If this option is used the request will fail if metageneration does not match.

Returns
Type Description
Storage.BlobTargetOption

metagenerationMatch(long metageneration)

public static Storage.BlobTargetOption metagenerationMatch(long metageneration)

Returns an option for blob's metageneration match. If this option is used the request will fail if blob's metageneration does not match the provided value.

Parameter
Name Description
metageneration long
Returns
Type Description
Storage.BlobTargetOption

metagenerationNotMatch()

public static Storage.BlobTargetOption metagenerationNotMatch()

Returns an option for blob's metageneration mismatch. If this option is used the request will fail if metageneration matches.

Returns
Type Description
Storage.BlobTargetOption

metagenerationNotMatch(long metageneration)

public static Storage.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.

Parameter
Name Description
metageneration long
Returns
Type Description
Storage.BlobTargetOption

overrideUnlockedRetention(boolean overrideUnlockedRetention)

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

predefinedAcl(@NonNull Storage.PredefinedAcl acl)

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

userProject(@NonNull String userProject)

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