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