com.google.cloud.storage

Class Storage.BlobSourceOption

java.lang.Object

com.google.cloud.storage.Option

com.google.cloud.storage.Storage.BlobSourceOption

All Implemented Interfaces:

Serializable

Enclosing interface:

Storage

public static class Storage.BlobSourceOption
extends Option

Class for specifying blob source options.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
static Storage.BlobSourceOption	decryptionKey(Key key) Returns an option to set a customer-supplied AES256 key for server-side encryption of the blob.
static Storage.BlobSourceOption	decryptionKey(String key) Returns an option to set a customer-supplied AES256 key for server-side encryption of the blob.
static Storage.BlobSourceOption	generationMatch() Returns an option for blob's data generation match.
static Storage.BlobSourceOption	generationMatch(long generation) Returns an option for blob's data generation match.
static Storage.BlobSourceOption	generationNotMatch() Returns an option for blob's data generation mismatch.
static Storage.BlobSourceOption	generationNotMatch(long generation) Returns an option for blob's data generation mismatch.
static Storage.BlobSourceOption	metagenerationMatch(long metageneration) Returns an option for blob's metageneration match.
static Storage.BlobSourceOption	metagenerationNotMatch(long metageneration) Returns an option for blob's metageneration mismatch.
static Storage.BlobSourceOption	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

generationMatch

public static Storage.BlobSourceOption generationMatch()

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 generation value to compare with the actual blob's generation is taken from a source BlobId object. When this option is passed to a Storage method and BlobId.getGeneration() is null or no BlobId is provided an exception is thrown.

generationMatch

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

public static Storage.BlobSourceOption generationNotMatch()

Returns an option for blob's data generation mismatch. If this option is used the request will fail if blob's generation matches. The generation value to compare with the actual blob's generation is taken from a source BlobId object. When this option is passed to a Storage method and BlobId.getGeneration() is null or no BlobId is provided an exception is thrown.

generationNotMatch

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

metagenerationMatch

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

public static Storage.BlobSourceOption metagenerationNotMatch(long metageneration)

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

decryptionKey

public static Storage.BlobSourceOption decryptionKey(Key key)

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

decryptionKey

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

userProject

public static Storage.BlobSourceOption userProject(String userProject)

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