Class Storage.BucketListOption (2.49.0) 

public static class Storage.BucketListOption extends Option<UnifiedOpts.BucketListOpt>

Class for specifying bucket list options.

Inheritance

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

Static Methods

dedupe(Storage.BucketListOption[] os)

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.

Parameter
Name Description
os BucketListOption[]
Returns
Type Description
BucketListOption[]

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

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.

Parameters
Name Description
array BucketListOption[]
os BucketListOption[]
Returns
Type Description
BucketListOption[]

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

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.

Parameters
Name Description
collection Collection<BucketListOption>
os BucketListOption[]
Returns
Type Description
BucketListOption[]

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

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

fields(Storage.BucketField[] fields)

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.

Parameter
Name Description
fields BucketField[]
Returns
Type Description
Storage.BucketListOption

pageSize(long pageSize)

public static Storage.BucketListOption pageSize(long pageSize)

Returns an option to specify the maximum number of buckets returned per page.

Parameter
Name Description
pageSize long
Returns
Type Description
Storage.BucketListOption

pageToken(@NonNull String pageToken)

public static Storage.BucketListOption pageToken(@NonNull String pageToken)

Returns an option to specify the page token from which to start listing buckets.

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

prefix(@NonNull String prefix)

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.

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

userProject(@NonNull String userProject)

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.

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