Package com.google.cloud.storage

Class Storage.BucketTargetOption

java.lang.Object
com.google.cloud.storage.Option<com.google.cloud.storage.UnifiedOpts.BucketTargetOpt>
com.google.cloud.storage.Storage.BucketTargetOption
All Implemented Interfaces:
Serializable
Enclosing interface:
Storage
public static class Storage.BucketTargetOption extends Option<com.google.cloud.storage.UnifiedOpts.BucketTargetOpt>
Class for specifying bucket target options.
See Also:

  • Method Details

    • predefinedAcl

      @TransportCompatibility({HTTP,GRPC}) public static Storage.BucketTargetOption predefinedAcl(@NonNull Storage.PredefinedAcl acl)
      Returns an option for specifying bucket's predefined ACL configuration.

    • predefinedDefaultObjectAcl

      @TransportCompatibility({HTTP,GRPC}) public static Storage.BucketTargetOption predefinedDefaultObjectAcl(@NonNull Storage.PredefinedAcl acl)
      Returns an option for specifying bucket's default ACL configuration for blobs.

    • enableObjectRetention

      @TransportCompatibility(HTTP) 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).

    • metagenerationMatch

      @TransportCompatibility({HTTP,GRPC}) 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.

    • metagenerationNotMatch

      @TransportCompatibility({HTTP,GRPC}) 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.

    • userProject

      @TransportCompatibility({HTTP,GRPC}) 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.

    • projection

      @TransportCompatibility(HTTP) 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:

    • extraHeaders

      @TransportCompatibility({HTTP,GRPC}) public static Storage.BucketTargetOption extraHeaders(@NonNull com.google.common.collect.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
      Since:
      2.49.0

    • dedupe

      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.

    • dedupe

      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.

    • dedupe

      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.

    • equals

      public boolean equals(Object o)
      Deprecated.
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Deprecated.
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Deprecated.
      Overrides:
      toString in class Object