Package com.google.cloud.storage

Class Storage.BlobTargetOption

java.lang.Object

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

com.google.cloud.storage.Storage.BlobTargetOption

All Implemented Interfaces:

Serializable

Enclosing interface:

Storage

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

Class for specifying blob target options.

See Also:

• Serialized Form

Method Summary

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

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

doesNotExist

@TransportCompatibility({HTTP,GRPC})
public static Storage.BlobTargetOption doesNotExist()

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

generationMatch

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

generationMatch

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

generationNotMatch

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

generationNotMatch

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

metagenerationMatch

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

metagenerationMatch

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

metagenerationNotMatch

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

metagenerationNotMatch

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

disableGzipContent

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

detectContentType

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

encryptionKey

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

userProject

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

encryptionKey

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

Parameters:

key - the AES256 encoded in base64

kmsKeyName

@TransportCompatibility({HTTP,GRPC})
public static Storage.BlobTargetOption kmsKeyName(@NonNull String kmsKeyName)

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

overrideUnlockedRetention

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

dedupe

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.

dedupe

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.

dedupe

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.

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