Package com.google.cloud.storage

Class Bucket.BlobTargetOption

java.lang.Object

com.google.cloud.storage.Option<com.google.cloud.storage.UnifiedOpts.ObjectTargetOpt>

com.google.cloud.storage.Bucket.BlobTargetOption

All Implemented Interfaces:

Serializable

Enclosing class:

Bucket

public static class Bucket.BlobTargetOption
extends Option<com.google.cloud.storage.UnifiedOpts.ObjectTargetOpt>

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

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
static Bucket.BlobTargetOption[]	dedupe(Bucket.BlobTargetOption... os)	Deduplicate any options which are the same parameter.
static Bucket.BlobTargetOption[]	dedupe(Bucket.BlobTargetOption[] array, Bucket.BlobTargetOption... os)	Deduplicate any options which are the same parameter.
static Bucket.BlobTargetOption[]	dedupe(Collection<Bucket.BlobTargetOption> collection, Bucket.BlobTargetOption... os)	Deduplicate any options which are the same parameter.
static Bucket.BlobTargetOption	doesNotExist()	Returns an option that causes an operation to succeed only if the target blob does not exist.
static Bucket.BlobTargetOption	encryptionKey(@NonNull String key)	Returns an option to set a customer-supplied AES256 key for server-side encryption of the blob.
static Bucket.BlobTargetOption	encryptionKey(@NonNull Key key)	Returns an option to set a customer-supplied AES256 key for server-side encryption of the blob.
boolean	equals(Object o)	Deprecated.
static Bucket.BlobTargetOption	generationMatch(long generation)	Returns an option for blob's data generation match.
static Bucket.BlobTargetOption	generationNotMatch(long generation)	Returns an option for blob's data generation mismatch.
int	hashCode()	Deprecated.
static Bucket.BlobTargetOption	kmsKeyName(@NonNull String kmsKeyName)	Returns an option to set a customer-managed KMS key for server-side encryption of the blob.
static Bucket.BlobTargetOption	metagenerationMatch(long metageneration)	Returns an option for blob's metageneration match.
static Bucket.BlobTargetOption	metagenerationNotMatch(long metageneration)	Returns an option for blob's metageneration mismatch.
static Bucket.BlobTargetOption	overrideUnlockedRetention(boolean overrideUnlockedRetention)	Returns an option for overriding an Unlocked Retention policy.
static Bucket.BlobTargetOption	predefinedAcl(@NonNull Storage.PredefinedAcl acl)	Returns an option for specifying blob's predefined ACL configuration.
String	toString()	Deprecated.
static Bucket.BlobTargetOption	userProject(@NonNull String userProject)	Returns an option for blob's billing user project.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

predefinedAcl

@TransportCompatibility({HTTP,GRPC})
public static Bucket.BlobTargetOption predefinedAcl(@NonNull Storage.PredefinedAcl acl)

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

doesNotExist

@TransportCompatibility({HTTP,GRPC})
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).

generationMatch

@TransportCompatibility({HTTP,GRPC})
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().

generationNotMatch

@TransportCompatibility({HTTP,GRPC})
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().

metagenerationMatch

@TransportCompatibility({HTTP,GRPC})
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).

metagenerationNotMatch

@TransportCompatibility({HTTP,GRPC})
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).

encryptionKey

@TransportCompatibility({HTTP,GRPC})
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.

encryptionKey

@TransportCompatibility({HTTP,GRPC})
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.

Parameters:

key - the AES256 encoded in base64

kmsKeyName

@TransportCompatibility({HTTP,GRPC})
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.

Parameters:

kmsKeyName - the KMS key resource id

userProject

@TransportCompatibility({HTTP,GRPC})
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.

overrideUnlockedRetention

@TransportCompatibility(HTTP)
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.

dedupe

@BetaApi
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

@BetaApi
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.

dedupe

@BetaApi
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.

equals

public boolean equals(Object o)

Deprecated.

Overrides:

equals in class Object

hashCode

public int hashCode()

Deprecated.

Overrides:

hashCode in class Object

toString

public String toString()

Deprecated.

Overrides:

toString in class Object