Class HmacKey (6.7.0)
An HmacKey object contains metadata of an HMAC key created from a service account through theStorage client using .
Package
@google-cloud/storageConstructors
(constructor)(storage, accessId, options)
constructor(storage:Storage,accessId:string,options?:HmacKeyOptions);Constructs an HmacKey object.
Note: this only create a local reference to an HMAC key, to create an HMAC key, use .
| Parameters | |
|---|---|
| Name | Description |
storage | StorageThe Storage instance this HMAC key is attached to. |
accessId | stringThe unique accessId for this HMAC key. |
options | HmacKeyOptionsConstructor configurations. |
const{Storage}=require('@google-cloud/storage');conststorage=newStorage();consthmacKey=storage.hmacKey('access-id');Properties
metadata
metadata:HmacKeyMetadata|undefined;storage
storage:Storage;Methods
setMetadata(metadata, options)
setMetadata(metadata:Metadata,options?:SetMetadataOptions):Promise<SetMetadataResponse>;Set the metadata for this object.
| Parameters | |
|---|---|
| Name | Description |
metadata | MetadataThe metadata to set on this object. |
options | SetMetadataOptionsConfiguration options. |
| Returns | |
|---|---|
| Type | Description |
Promise<SetMetadataResponse> | |
setMetadata(metadata, callback)
setMetadata(metadata:Metadata,callback:MetadataCallback):void;| Parameters | |
|---|---|
| Name | Description |
metadata | Metadata |
callback | MetadataCallback |
| Returns | |
|---|---|
| Type | Description |
void | |
setMetadata(metadata, options, callback)
setMetadata(metadata:Metadata,options:SetMetadataOptions,callback:MetadataCallback):void;| Parameters | |
|---|---|
| Name | Description |
metadata | Metadata |
options | SetMetadataOptions |
callback | MetadataCallback |
| Returns | |
|---|---|
| Type | Description |
void | |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-30 UTC.