Class Blob.BlobSourceOption (2.39.0)

Version 2.39.0

• 2.44.1 (latest)
• 2.43.2
• 2.42.0
• 2.41.0
• 2.40.1
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.1
• 2.34.0
• 2.33.0
• 2.32.1
• 2.30.1
• 2.29.1
• 2.28.0
• 2.27.1
• 2.24.0
• 2.23.0
• 2.22.6
• 2.21.0
• 2.20.2
• 2.19.0
• 2.18.0
• 2.17.2
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.1
• 2.12.0
• 2.11.3
• 2.10.0
• 2.9.3
• 2.8.1
• 2.7.1
• 2.6.1
• 2.5.1
• 2.4.5
• 2.3.0
• 2.2.3
• 2.1.10

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

Class for specifying blob source options when Blob methods are used.

Inheritance

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

Inherited Members

com.google.cloud.storage.UnifiedOpts.OptionShim.equals(java.lang.Object)

com.google.cloud.storage.UnifiedOpts.OptionShim.hashCode()

com.google.cloud.storage.UnifiedOpts.OptionShim.toString()

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

decryptionKey(@NonNull String key)

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

decryptionKey(@NonNull Key key)

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

dedupe(Blob.BlobSourceOption[] os)

public static Blob.BlobSourceOption[] dedupe(Blob.BlobSourceOption[] os)

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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(Blob.BlobSourceOption[] array, Blob.BlobSourceOption[] os)

public static Blob.BlobSourceOption[] dedupe(Blob.BlobSourceOption[] array, Blob.BlobSourceOption[] os)

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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<Blob.BlobSourceOption> collection, Blob.BlobSourceOption[] os)

public static Blob.BlobSourceOption[] dedupe(Collection<Blob.BlobSourceOption> collection, Blob.BlobSourceOption[] os)

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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 Blob.BlobSourceOption generationMatch()

Returns an option for blob's generation match. If this option is used the request will fail if generation does not match.

Returns
Type	Description
Blob.BlobSourceOption

generationNotMatch() (deprecated)

public static Blob.BlobSourceOption generationNotMatch()

Deprecated. This option is invalid, and can never result in a valid response from the server.

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

Returns
Type	Description
Blob.BlobSourceOption

metagenerationMatch()

public static Blob.BlobSourceOption metagenerationMatch()

Returns an option for blob's metageneration match. If this option is used the request will fail if metageneration does not match.

Returns
Type	Description
Blob.BlobSourceOption

metagenerationNotMatch()

public static Blob.BlobSourceOption metagenerationNotMatch()

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

Returns
Type	Description
Blob.BlobSourceOption

shouldReturnRawInputStream(boolean shouldReturnRawInputStream)

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

userProject(@NonNull String userProject)

public static Blob.BlobSourceOption userProject(@NonNull String userProject)

Returns an option for blob's billing user project. This option is used only if the blob's bucket has requester_pays flag enabled.

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

Returns
Type	Description
Blob.BlobSourceOption