Package com.google.cloud.storage

Class Storage.BucketListOption

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

  • Method Details

    • pageSize

      @TransportCompatibility({HTTP,GRPC}) public static Storage.BucketListOption pageSize(long pageSize)
      Returns an option to specify the maximum number of buckets returned per page.

    • pageToken

      @TransportCompatibility({HTTP,GRPC}) public static Storage.BucketListOption pageToken(@NonNull String pageToken)
      Returns an option to specify the page token from which to start listing buckets.

    • prefix

      @TransportCompatibility({HTTP,GRPC}) public static Storage.BucketListOption prefix(@NonNull String prefix)
      Returns an option to set a prefix to filter results to buckets whose names begin with this prefix.

    • userProject

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

    • fields

      @TransportCompatibility({HTTP,GRPC}) public static Storage.BucketListOption fields(Storage.BucketField... fields)
      Returns an option to specify the bucket's fields to be returned by the RPC call. If this option is not provided all bucket's fields are returned. BucketListOption.fields) can be used to specify only the fields of interest. Bucket name is always returned, even if not specified.

    • extraHeaders

      @TransportCompatibility({HTTP,GRPC}) public static Storage.BucketListOption 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.BucketListOption[] dedupe(Storage.BucketListOption... 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.BucketListOption[] dedupe(Collection<Storage.BucketListOption> collection, Storage.BucketListOption... 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.BucketListOption[] dedupe(Storage.BucketListOption[] array, Storage.BucketListOption... 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