Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class Storage.ListHmacKeysOption (2.58.1)

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

Inherited Members

com.google.cloud.storage.UnifiedOpts.OptionShim.equals(java.lang.Object)

com.google.cloud.storage.UnifiedOpts.OptionShim.hashCode()

com.google.cloud.storage.UnifiedOpts.OptionShim.toString()

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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.

Accept-Encoding
Cache-Control
Connection
Content-ID
Content-Length
Content-Range
Content-Transfer-Encoding
Content-Type
Date
ETag
If-Match
If-None-Match
Keep-Alive
Range
TE
Trailer
Transfer-Encoding
User-Agent
X-Goog-Api-Client
X-Goog-Content-Length-Range
X-Goog-Copy-Source-Encryption-Algorithm
X-Goog-Copy-Source-Encryption-Key
X-Goog-Copy-Source-Encryption-Key-Sha256
X-Goog-Encryption-Algorithm
X-Goog-Encryption-Key
X-Goog-Encryption-Key-Sha256
X-Goog-Gcs-Idempotency-Token
X-Goog-Meta-*
X-Goog-User-Project
X-HTTP-Method-Override
X-Upload-Content-Length
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`