com.google.cloud.storage

Class Bucket.BlobTargetOption

java.lang.Object

com.google.cloud.storage.Option

com.google.cloud.storage.Bucket.BlobTargetOption

All Implemented Interfaces:

Serializable

Enclosing class:

Bucket

public static class Bucket.BlobTargetOption
extends Option

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

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
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(Key key) Returns an option to set a customer-supplied AES256 key for server-side encryption of the blob.
static Bucket.BlobTargetOption	encryptionKey(String key) Returns an option to set a customer-supplied AES256 key for server-side encryption of the blob.
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.
static Bucket.BlobTargetOption	kmsKeyName(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	predefinedAcl(Storage.PredefinedAcl acl) Returns an option for specifying blob's predefined ACL configuration.
static Bucket.BlobTargetOption	userProject(String userProject) Returns an option for blob's billing user project.

Methods inherited from class com.google.cloud.storage.Option

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Method Detail

predefinedAcl

public static Bucket.BlobTargetOption predefinedAcl(Storage.PredefinedAcl acl)

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

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

generationMatch

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

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

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

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

public static Bucket.BlobTargetOption encryptionKey(Key key)

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

encryptionKey

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

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

public static Bucket.BlobTargetOption userProject(String userProject)

Returns an option for blob's billing user project. This option is only used by the buckets with 'requester_pays' flag.