Class Storage.ListHmacKeysOption (2.50.0)

public static class Storage.ListHmacKeysOption extends Option<UnifiedOpts.HmacKeyListOpt>

Class for specifying listHmacKeys options

Inheritance

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

Static Methods

dedupe(Storage.ListHmacKeysOption[] os)

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

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

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

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

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

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

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

maxResults(long pageSize)

public static Storage.ListHmacKeysOption maxResults(long pageSize)

Returns an option for the maximum amount of HMAC keys returned per page.

Parameter
Name Description
pageSize long
Returns
Type Description
Storage.ListHmacKeysOption

pageToken(@NonNull String pageToken)

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

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

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

projectId(@NonNull String projectId)

public static Storage.ListHmacKeysOption projectId(@NonNull String projectId)

Returns an option to specify the Project ID for this request. If not specified, defaults to Application Default Credentials.

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

serviceAccount(@NonNull ServiceAccount serviceAccount)

public static Storage.ListHmacKeysOption serviceAccount(@NonNull ServiceAccount serviceAccount)

Returns an option for the Service Account whose keys to list. If this option is not used, keys for all accounts will be listed.

Parameter
Name Description
serviceAccount @org.checkerframework.checker.nullness.qual.NonNull com.google.cloud.storage.ServiceAccount
Returns
Type Description
Storage.ListHmacKeysOption

showDeletedKeys(boolean showDeletedKeys)

public static Storage.ListHmacKeysOption showDeletedKeys(boolean showDeletedKeys)

Returns an option to specify whether to show deleted keys in the result. This option is false by default.

Parameter
Name Description
showDeletedKeys boolean
Returns
Type Description
Storage.ListHmacKeysOption

userProject(@NonNull String userProject)

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

Returns an option to specify the project to be billed for this request. Required for Requester Pays buckets.

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