Class HmacKey (5.18.3)

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

See HMAC keys documentation

Inheritance

ServiceObject < HmacKeyMetadata | undefined> > HmacKey

Package

@google-cloud/storage

Constructors

(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 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' 
 ); 
 

Properties

  metadata 
 : 
  
 HmacKeyMetadata 
  
 | 
  
 undefined 
 ; 
 
Design a Mobile Site
View Site in Mobile | Classic
Share by: