Package com.google.cloud.storage

Class Storage.BlobSourceOption

java.lang.Object

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

com.google.cloud.storage.Storage.BlobSourceOption

All Implemented Interfaces:

Serializable

Enclosing interface:

Storage

public static class Storage.BlobSourceOption
extends Option<com.google.cloud.storage.UnifiedOpts.ObjectSourceOpt>

Class for specifying blob source options.

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
static Storage.BlobSourceOption	decryptionKey(@NonNull String key)	Returns an option to set a customer-supplied AES256 key for server-side encryption of the blob.
static Storage.BlobSourceOption	decryptionKey(@NonNull Key key)	Returns an option to set a customer-supplied AES256 key for server-side encryption of the blob.
static Storage.BlobSourceOption[]	dedupe(Storage.BlobSourceOption... os)	Deduplicate any options which are the same parameter.
static Storage.BlobSourceOption[]	dedupe(Storage.BlobSourceOption[] array, Storage.BlobSourceOption... os)	Deduplicate any options which are the same parameter.
static Storage.BlobSourceOption[]	dedupe(Collection<Storage.BlobSourceOption> collection, Storage.BlobSourceOption... os)	Deduplicate any options which are the same parameter.
boolean	equals(Object o)	Deprecated.
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()	Deprecated. This option is invalid, and can never result in a valid response from the server.
static Storage.BlobSourceOption	generationNotMatch(long generation)	Returns an option for blob's data generation mismatch.
int	hashCode()	Deprecated.
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	shouldReturnRawInputStream(boolean shouldReturnRawInputStream)	Returns an option for whether the request should return the raw input stream, instead of automatically decompressing the content.
String	toString()	Deprecated.
static Storage.BlobSourceOption	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

generationMatch

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

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

@Deprecated
@TransportCompatibility({HTTP,GRPC})
public static Storage.BlobSourceOption generationNotMatch()

Deprecated.

This option is invalid, and can never result in a valid response from the server. use generationNotMatch(long) instead.

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

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

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

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

@TransportCompatibility({HTTP,GRPC})
public static Storage.BlobSourceOption decryptionKey(@NonNull Key key)

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

decryptionKey

@TransportCompatibility({HTTP,GRPC})
public static Storage.BlobSourceOption decryptionKey(@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

userProject

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

shouldReturnRawInputStream

@TransportCompatibility({HTTP,GRPC})
public static Storage.BlobSourceOption shouldReturnRawInputStream(boolean shouldReturnRawInputStream)

Returns an option for whether the request should return the raw input stream, instead of automatically decompressing the content. By default, this is false for Blob.downloadTo(), but true for ReadChannel.read().

dedupe

@BetaApi
public static Storage.BlobSourceOption[] dedupe(Storage.BlobSourceOption... 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 Storage.BlobSourceOption[] dedupe(Collection<Storage.BlobSourceOption> collection,
 Storage.BlobSourceOption... 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 Storage.BlobSourceOption[] dedupe(Storage.BlobSourceOption[] array,
 Storage.BlobSourceOption... 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