Class Storage.BlobWriteOption (2.49.0)
Stay organized with collections Save and categorize content based on your preferences.

public static class Storage.BlobWriteOption extends Option<UnifiedOpts.ObjectTargetOpt> implements Serializable

Class for specifying blob write options.

Inheritance

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

Implements

Serializable

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

crc32cMatch()

public static Storage.BlobWriteOption crc32cMatch()

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

Returns
Type	Description
`Storage.BlobWriteOption`

dedupe(Storage.BlobWriteOption[] os)

public static Storage.BlobWriteOption[] dedupe(Storage.BlobWriteOption[] 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`	`BlobWriteOption[]`

Returns
Type	Description
`BlobWriteOption[]`

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

public static Storage.BlobWriteOption[] dedupe(Storage.BlobWriteOption[] array, Storage.BlobWriteOption[] 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`	`BlobWriteOption[]`
`os`	`BlobWriteOption[]`

Returns
Type	Description
`BlobWriteOption[]`

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

public static Storage.BlobWriteOption[] dedupe(Collection<Storage.BlobWriteOption> collection, Storage.BlobWriteOption[] 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<BlobWriteOption>`
`os`	`BlobWriteOption[]`

Returns
Type	Description
`BlobWriteOption[]`

detectContentType()

public static Storage.BlobWriteOption detectContentType()

Returns an option for detecting content type. If this option is used, the content type is detected from the blob name if not explicitly set. This option is on the client side only, it does not appear in a RPC call.

Content type detection is based on the database presented by URLConnection#getFileNameMap()

Returns
Type	Description
`Storage.BlobWriteOption`

disableGzipContent()

public static Storage.BlobWriteOption disableGzipContent()

Returns an option that signals automatic gzip compression should not be performed en route to the bucket.

Returns
Type	Description
`Storage.BlobWriteOption`

doesNotExist()

public static Storage.BlobWriteOption doesNotExist()

Returns an option that causes an operation to succeed only if the target blob does not exist.

Returns
Type	Description
`Storage.BlobWriteOption`

encryptionKey(@NonNull String key)

public static Storage.BlobWriteOption encryptionKey(@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.BlobWriteOption`

encryptionKey(@NonNull Key key)

public static Storage.BlobWriteOption encryptionKey(@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.BlobWriteOption`

expectedObjectSize(long objectContentSize)

public static Storage.BlobWriteOption expectedObjectSize(long objectContentSize)

Set a precondition on the number of bytes that GCS should expect for a resumable upload. See the docs for X-Upload-Content-Length for more detail.

If the method invoked with this option does not perform a resumable upload, this option will be ignored.

Parameter
Name	Description
`objectContentSize`	`long`

Returns
Type	Description
`Storage.BlobWriteOption`

extraHeaders(@NonNull ImmutableMap<String,String> extraHeaders)

public static Storage.BlobWriteOption extraHeaders(@NonNull ImmutableMap<String,String> extraHeaders)

A set of extra headers to be set for all requests performed within the scope of the operation this option is passed to (a get, read, resumable upload etc).

If the same header name is specified across multiple options provided to a method, the first occurrence will be the value included in the request(s).

The following headers are not allowed to be specified, and will result in an IllegalArgumentException.

Accept-Encoding
Cache-Control
Connection
Content-ID
Content-Length
Content-Range
Content-Transfer-Encoding
Content-Type
Date
ETag
If-Match
If-None-Match
Keep-Alive
Range
TE
Trailer
Transfer-Encoding
User-Agent
X-Goog-Api-Client
X-Goog-Content-Length-Range
X-Goog-Copy-Source-Encryption-Algorithm
X-Goog-Copy-Source-Encryption-Key
X-Goog-Copy-Source-Encryption-Key-Sha256
X-Goog-Encryption-Algorithm
X-Goog-Encryption-Key
X-Goog-Encryption-Key-Sha256
X-Goog-Gcs-Idempotency-Token
X-Goog-Meta-*
X-Goog-User-Project
X-HTTP-Method-Override
X-Upload-Content-Length
X-Upload-Content-Type

Parameter
Name	Description
`extraHeaders`	`@org.checkerframework.checker.nullness.qual.NonNull com.google.common.collect.ImmutableMap<String,String>`

Returns
Type	Description
`Storage.BlobWriteOption`

generationMatch()

public static Storage.BlobWriteOption generationMatch()

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

Returns
Type	Description
`Storage.BlobWriteOption`

generationMatch(long generation)

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

generationNotMatch()

public static Storage.BlobWriteOption generationNotMatch()

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

Returns
Type	Description
`Storage.BlobWriteOption`

generationNotMatch(long generation)

public static Storage.BlobWriteOption 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 does not match the provided value.

Parameter
Name	Description
`generation`	`long`

Returns
Type	Description
`Storage.BlobWriteOption`

kmsKeyName(@NonNull String kmsKeyName)

public static Storage.BlobWriteOption kmsKeyName(@NonNull String kmsKeyName)

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

Parameter
Name	Description
`kmsKeyName`	`@org.checkerframework.checker.nullness.qual.NonNull java.lang.String` the KMS key resource id

Returns
Type	Description
`Storage.BlobWriteOption`

md5Match() (deprecated)

public static Storage.BlobWriteOption md5Match()

Deprecated. Please compute and use a crc32c checksum instead. #crc32cMatch()

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

Returns
Type	Description
`Storage.BlobWriteOption`

metagenerationMatch()

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

metagenerationMatch(long metageneration)

public static Storage.BlobWriteOption metagenerationMatch(long metageneration)

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

Parameter
Name	Description
`metageneration`	`long`

Returns
Type	Description
`Storage.BlobWriteOption`

metagenerationNotMatch()

public static Storage.BlobWriteOption metagenerationNotMatch()

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

Returns
Type	Description
`Storage.BlobWriteOption`

metagenerationNotMatch(long metageneration)

public static Storage.BlobWriteOption metagenerationNotMatch(long metageneration)

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

Parameter
Name	Description
`metageneration`	`long`

Returns
Type	Description
`Storage.BlobWriteOption`

predefinedAcl(@NonNull Storage.PredefinedAcl acl)

public static Storage.BlobWriteOption predefinedAcl(@NonNull Storage.PredefinedAcl acl)

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

Parameter
Name	Description
`acl`	`@org.checkerframework.checker.nullness.qual.NonNull com.google.cloud.storage.Storage.PredefinedAcl`

Returns
Type	Description
`Storage.BlobWriteOption`

userProject(@NonNull String userProject)

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