An HmacKey object contains metadata of an HMAC key created from a service account through the Storage 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
accessId
string
The unique accessId for this HMAC key.
options
HmacKeyOptions
Constructor configurations.
const
{
Storage
}
=
require
(
' @google-cloud/storage
'
);
const
storage
=
new
Storage
();
const
hmacKey
=
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
Metadata
The metadata to set on this object.
options
SetMetadataOptions
Configuration 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
