Class Storage.BucketTargetOption (2.49.0)

public static class Storage.BucketTargetOption extends Option<UnifiedOpts.BucketTargetOpt>

Class for specifying bucket target options.

Inheritance

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

Static Methods

dedupe(Storage.BucketTargetOption[] os)

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

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

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

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

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

enableObjectRetention(boolean enable)

public static Storage.BucketTargetOption enableObjectRetention(boolean enable)

Returns an option for enabling Object Retention on this bucket. Enabling this will create an ObjectRetention object in the created bucket (You must use this option, creating your own ObjectRetention object in the request won't work).

Parameter
Name Description
enable boolean
Returns
Type Description
Storage.BucketTargetOption

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

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

metagenerationMatch()

public static Storage.BucketTargetOption metagenerationMatch()

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

Returns
Type Description
Storage.BucketTargetOption

metagenerationNotMatch()

public static Storage.BucketTargetOption metagenerationNotMatch()

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

Returns
Type Description
Storage.BucketTargetOption

predefinedAcl(@NonNull Storage.PredefinedAcl acl)

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

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

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

predefinedDefaultObjectAcl(@NonNull Storage.PredefinedAcl acl)

public static Storage.BucketTargetOption predefinedDefaultObjectAcl(@NonNull Storage.PredefinedAcl acl)

Returns an option for specifying bucket's default ACL configuration for blobs.

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

projection(@NonNull String projection)

public static Storage.BucketTargetOption projection(@NonNull String projection)

Returns an option to define the projection in the API request. In some cases this option may be needed to be set to noAcl to omit ACL data from the response. The default value is full See Also: Buckets: patch

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

userProject(@NonNull String userProject)

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

Returns an option to define the billing user project. This option is required by buckets with requester_pays flag enabled to assign operation costs.

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