Class Storage.BucketSourceOption (2.49.0) 

public static class Storage.BucketSourceOption extends Option<UnifiedOpts.BucketSourceOpt>

Class for specifying bucket source options.

Inheritance

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

Static Methods

dedupe(Storage.BucketSourceOption[] os)

public static Storage.BucketSourceOption[] dedupe(Storage.BucketSourceOption[] 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 BucketSourceOption[]
Returns
Type Description
BucketSourceOption[]

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

public static Storage.BucketSourceOption[] dedupe(Storage.BucketSourceOption[] array, Storage.BucketSourceOption[] 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 BucketSourceOption[]
os BucketSourceOption[]
Returns
Type Description
BucketSourceOption[]

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

public static Storage.BucketSourceOption[] dedupe(Collection<Storage.BucketSourceOption> collection, Storage.BucketSourceOption[] 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<BucketSourceOption>
os BucketSourceOption[]
Returns
Type Description
BucketSourceOption[]

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

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

  1. Accept-Encoding
  2. Cache-Control
  3. Connection
  4. Content-ID
  5. Content-Length
  6. Content-Range
  7. Content-Transfer-Encoding
  8. Content-Type
  9. Date
  10. ETag
  11. If-Match
  12. If-None-Match
  13. Keep-Alive
  14. Range
  15. TE
  16. Trailer
  17. Transfer-Encoding
  18. User-Agent
  19. X-Goog-Api-Client
  20. X-Goog-Content-Length-Range
  21. X-Goog-Copy-Source-Encryption-Algorithm
  22. X-Goog-Copy-Source-Encryption-Key
  23. X-Goog-Copy-Source-Encryption-Key-Sha256
  24. X-Goog-Encryption-Algorithm
  25. X-Goog-Encryption-Key
  26. X-Goog-Encryption-Key-Sha256
  27. X-Goog-Gcs-Idempotency-Token
  28. X-Goog-Meta-*
  29. X-Goog-User-Project
  30. X-HTTP-Method-Override
  31. X-Upload-Content-Length
  32. 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.BucketSourceOption

metagenerationMatch(long metageneration)

public static Storage.BucketSourceOption metagenerationMatch(long metageneration)

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

Parameter
Name Description
metageneration long
Returns
Type Description
Storage.BucketSourceOption

metagenerationNotMatch(long metageneration)

public static Storage.BucketSourceOption metagenerationNotMatch(long metageneration)

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

Parameter
Name Description
metageneration long
Returns
Type Description
Storage.BucketSourceOption

requestedPolicyVersion(long version)

public static Storage.BucketSourceOption requestedPolicyVersion(long version)
Parameter
Name Description
version long
Returns
Type Description
Storage.BucketSourceOption

userProject(@NonNull String userProject)

public static Storage.BucketSourceOption userProject(@NonNull String userProject)

Returns an option for bucket'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.BucketSourceOption