Class Storage.BlobSourceOption (2.44.1) 

public static class Storage.BlobSourceOption extends Option<UnifiedOpts.ObjectSourceOpt>

Class for specifying blob source options.

Inheritance

java.lang.Object > com.google.cloud.storage.UnifiedOpts.OptionShim > Option > Storage.BlobSourceOption

Static Methods

decryptionKey(@NonNull String key)

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.

Parameter
Name Description
key @org.checkerframework.checker.nullness.qual.NonNull java.lang.String

the AES256 encoded in base64
Returns
Type Description
Storage.BlobSourceOption

decryptionKey(@NonNull Key key)

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.

Parameter
Name Description
key @org.checkerframework.checker.nullness.qual.NonNull java.security.Key
Returns
Type Description
Storage.BlobSourceOption

dedupe(Storage.BlobSourceOption[] os)

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.

Parameter
Name Description
os BlobSourceOption[]
Returns
Type Description
BlobSourceOption[]

dedupe(Storage.BlobSourceOption[] array, Storage.BlobSourceOption[] os)

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.

Parameters
Name Description
array BlobSourceOption[]
os BlobSourceOption[]
Returns
Type Description
BlobSourceOption[]

dedupe(Collection<Storage.BlobSourceOption> collection, Storage.BlobSourceOption[] os)

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.

Parameters
Name Description
collection Collection<BlobSourceOption>
os BlobSourceOption[]
Returns
Type Description
BlobSourceOption[]

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.

Returns
Type Description
Storage.BlobSourceOption

generationMatch(long generation)

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.

Parameter
Name Description
generation long
Returns
Type Description
Storage.BlobSourceOption

generationNotMatch() (deprecated)

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.

Returns
Type Description
Storage.BlobSourceOption

generationNotMatch(long generation)

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.

Parameter
Name Description
generation long
Returns
Type Description
Storage.BlobSourceOption

metagenerationMatch(long metageneration)

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.

Parameter
Name Description
metageneration long
Returns
Type Description
Storage.BlobSourceOption

metagenerationNotMatch(long metageneration)

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.

Parameter
Name Description
metageneration long
Returns
Type Description
Storage.BlobSourceOption

shouldReturnRawInputStream(boolean shouldReturnRawInputStream)

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

Parameter
Name Description
shouldReturnRawInputStream boolean
Returns
Type Description
Storage.BlobSourceOption

userProject(@NonNull String userProject)

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.

Parameter
Name Description
userProject @org.checkerframework.checker.nullness.qual.NonNull java.lang.String
Returns
Type Description
Storage.BlobSourceOption