Class HmacKey (6.4.2)

An HmacKey object contains metadata of an HMAC key created from a service account through the Storage client using .

Inheritance

ServiceObject<HmacKeyMetadata | undefined> > HmacKey

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	`Storage` The Storage instance this HMAC key is attached to.
accessId	`string` The unique accessId for this HMAC key.
options	`HmacKeyOptions` Constructor configurations.

Example


const {Storage} = require('@google-cloud/storage');
const storage = new Storage();
const hmacKey = storage.hmacKey('access-id');

metadata: HmacKeyMetadata | undefined;

storage: Storage;

A reference to the Storage associated with this HmacKey instance. HmacKey#storage {Storage}

setMetadata(metadata: Metadata, options?: SetMetadataOptions): Promise<SetMetadataResponse>;

Set the metadata for this object.

Parameters

Name	Description
metadata	`Metadata` The metadata to set on this object.
options	`SetMetadataOptions` Configuration options.

Returns

Type	Description
Promise<SetMetadataResponse>

setMetadata(metadata: Metadata, callback: MetadataCallback): void;

Parameters

Returns

Type	Description
void

setMetadata(metadata: Metadata, options: SetMetadataOptions, callback: MetadataCallback): void;

Parameters

Returns

Type	Description
void