Class Storage.ListHmacKeysOption (2.18.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

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

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`