Constructor
new KeyManagementService(rpcImpl, requestDelimitedopt, responseDelimitedopt)
Constructs a new KeyManagementService service.
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
rpcImpl |
$protobuf.RPCImpl |
RPC implementation |
||
requestDelimited |
boolean |
<optional> |
false |
Whether requests are length-delimited |
responseDelimited |
boolean |
<optional> |
false |
Whether responses are length-delimited |
Extends
- $protobuf.rpc.Service
Methods
asymmetricDecrypt(request, callback) → {undefined}
Calls AsymmetricDecrypt.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IAsymmetricDecryptRequest |
AsymmetricDecryptRequest message or plain object |
callback |
google.cloud.kms.v1.KeyManagementService.AsymmetricDecryptCallback |
Node-style callback called with the error, if any, and AsymmetricDecryptResponse |
Returns:
Type | Description |
---|---|
undefined |
asymmetricDecrypt(request) → {Promise.<google.cloud.kms.v1.AsymmetricDecryptResponse>}
Calls AsymmetricDecrypt.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IAsymmetricDecryptRequest |
AsymmetricDecryptRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.kms.v1.AsymmetricDecryptResponse> |
Promise |
asymmetricSign(request, callback) → {undefined}
Calls AsymmetricSign.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IAsymmetricSignRequest |
AsymmetricSignRequest message or plain object |
callback |
google.cloud.kms.v1.KeyManagementService.AsymmetricSignCallback |
Node-style callback called with the error, if any, and AsymmetricSignResponse |
Returns:
Type | Description |
---|---|
undefined |
asymmetricSign(request) → {Promise.<google.cloud.kms.v1.AsymmetricSignResponse>}
Calls AsymmetricSign.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IAsymmetricSignRequest |
AsymmetricSignRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.kms.v1.AsymmetricSignResponse> |
Promise |
createCryptoKey(request, callback) → {undefined}
Calls CreateCryptoKey.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.ICreateCryptoKeyRequest |
CreateCryptoKeyRequest message or plain object |
callback |
google.cloud.kms.v1.KeyManagementService.CreateCryptoKeyCallback |
Node-style callback called with the error, if any, and CryptoKey |
Returns:
Type | Description |
---|---|
undefined |
createCryptoKey(request) → {Promise.<google.cloud.kms.v1.CryptoKey>}
Calls CreateCryptoKey.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.ICreateCryptoKeyRequest |
CreateCryptoKeyRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.kms.v1.CryptoKey> |
Promise |
createCryptoKeyVersion(request, callback) → {undefined}
Calls CreateCryptoKeyVersion.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.ICreateCryptoKeyVersionRequest |
CreateCryptoKeyVersionRequest message or plain object |
callback |
google.cloud.kms.v1.KeyManagementService.CreateCryptoKeyVersionCallback |
Node-style callback called with the error, if any, and CryptoKeyVersion |
Returns:
Type | Description |
---|---|
undefined |
createCryptoKeyVersion(request) → {Promise.<google.cloud.kms.v1.CryptoKeyVersion>}
Calls CreateCryptoKeyVersion.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.ICreateCryptoKeyVersionRequest |
CreateCryptoKeyVersionRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.kms.v1.CryptoKeyVersion> |
Promise |
createImportJob(request, callback) → {undefined}
Calls CreateImportJob.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.ICreateImportJobRequest |
CreateImportJobRequest message or plain object |
callback |
google.cloud.kms.v1.KeyManagementService.CreateImportJobCallback |
Node-style callback called with the error, if any, and ImportJob |
Returns:
Type | Description |
---|---|
undefined |
createImportJob(request) → {Promise.<google.cloud.kms.v1.ImportJob>}
Calls CreateImportJob.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.ICreateImportJobRequest |
CreateImportJobRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.kms.v1.ImportJob> |
Promise |
createKeyRing(request, callback) → {undefined}
Calls CreateKeyRing.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.ICreateKeyRingRequest |
CreateKeyRingRequest message or plain object |
callback |
google.cloud.kms.v1.KeyManagementService.CreateKeyRingCallback |
Node-style callback called with the error, if any, and KeyRing |
Returns:
Type | Description |
---|---|
undefined |
createKeyRing(request) → {Promise.<google.cloud.kms.v1.KeyRing>}
Calls CreateKeyRing.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.ICreateKeyRingRequest |
CreateKeyRingRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.kms.v1.KeyRing> |
Promise |
decrypt(request, callback) → {undefined}
Calls Decrypt.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IDecryptRequest |
DecryptRequest message or plain object |
callback |
google.cloud.kms.v1.KeyManagementService.DecryptCallback |
Node-style callback called with the error, if any, and DecryptResponse |
Returns:
Type | Description |
---|---|
undefined |
decrypt(request) → {Promise.<google.cloud.kms.v1.DecryptResponse>}
Calls Decrypt.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IDecryptRequest |
DecryptRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.kms.v1.DecryptResponse> |
Promise |
destroyCryptoKeyVersion(request, callback) → {undefined}
Calls DestroyCryptoKeyVersion.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IDestroyCryptoKeyVersionRequest |
DestroyCryptoKeyVersionRequest message or plain object |
callback |
google.cloud.kms.v1.KeyManagementService.DestroyCryptoKeyVersionCallback |
Node-style callback called with the error, if any, and CryptoKeyVersion |
Returns:
Type | Description |
---|---|
undefined |
destroyCryptoKeyVersion(request) → {Promise.<google.cloud.kms.v1.CryptoKeyVersion>}
Calls DestroyCryptoKeyVersion.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IDestroyCryptoKeyVersionRequest |
DestroyCryptoKeyVersionRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.kms.v1.CryptoKeyVersion> |
Promise |
encrypt(request, callback) → {undefined}
Calls Encrypt.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IEncryptRequest |
EncryptRequest message or plain object |
callback |
google.cloud.kms.v1.KeyManagementService.EncryptCallback |
Node-style callback called with the error, if any, and EncryptResponse |
Returns:
Type | Description |
---|---|
undefined |
encrypt(request) → {Promise.<google.cloud.kms.v1.EncryptResponse>}
Calls Encrypt.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IEncryptRequest |
EncryptRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.kms.v1.EncryptResponse> |
Promise |
generateRandomBytes(request, callback) → {undefined}
Calls GenerateRandomBytes.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IGenerateRandomBytesRequest |
GenerateRandomBytesRequest message or plain object |
callback |
google.cloud.kms.v1.KeyManagementService.GenerateRandomBytesCallback |
Node-style callback called with the error, if any, and GenerateRandomBytesResponse |
Returns:
Type | Description |
---|---|
undefined |
generateRandomBytes(request) → {Promise.<google.cloud.kms.v1.GenerateRandomBytesResponse>}
Calls GenerateRandomBytes.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IGenerateRandomBytesRequest |
GenerateRandomBytesRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.kms.v1.GenerateRandomBytesResponse> |
Promise |
getCryptoKey(request, callback) → {undefined}
Calls GetCryptoKey.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IGetCryptoKeyRequest |
GetCryptoKeyRequest message or plain object |
callback |
google.cloud.kms.v1.KeyManagementService.GetCryptoKeyCallback |
Node-style callback called with the error, if any, and CryptoKey |
Returns:
Type | Description |
---|---|
undefined |
getCryptoKey(request) → {Promise.<google.cloud.kms.v1.CryptoKey>}
Calls GetCryptoKey.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IGetCryptoKeyRequest |
GetCryptoKeyRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.kms.v1.CryptoKey> |
Promise |
getCryptoKeyVersion(request, callback) → {undefined}
Calls GetCryptoKeyVersion.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IGetCryptoKeyVersionRequest |
GetCryptoKeyVersionRequest message or plain object |
callback |
google.cloud.kms.v1.KeyManagementService.GetCryptoKeyVersionCallback |
Node-style callback called with the error, if any, and CryptoKeyVersion |
Returns:
Type | Description |
---|---|
undefined |
getCryptoKeyVersion(request) → {Promise.<google.cloud.kms.v1.CryptoKeyVersion>}
Calls GetCryptoKeyVersion.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IGetCryptoKeyVersionRequest |
GetCryptoKeyVersionRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.kms.v1.CryptoKeyVersion> |
Promise |
getImportJob(request, callback) → {undefined}
Calls GetImportJob.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IGetImportJobRequest |
GetImportJobRequest message or plain object |
callback |
google.cloud.kms.v1.KeyManagementService.GetImportJobCallback |
Node-style callback called with the error, if any, and ImportJob |
Returns:
Type | Description |
---|---|
undefined |
getImportJob(request) → {Promise.<google.cloud.kms.v1.ImportJob>}
Calls GetImportJob.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IGetImportJobRequest |
GetImportJobRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.kms.v1.ImportJob> |
Promise |
getKeyRing(request, callback) → {undefined}
Calls GetKeyRing.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IGetKeyRingRequest |
GetKeyRingRequest message or plain object |
callback |
google.cloud.kms.v1.KeyManagementService.GetKeyRingCallback |
Node-style callback called with the error, if any, and KeyRing |
Returns:
Type | Description |
---|---|
undefined |
getKeyRing(request) → {Promise.<google.cloud.kms.v1.KeyRing>}
Calls GetKeyRing.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IGetKeyRingRequest |
GetKeyRingRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.kms.v1.KeyRing> |
Promise |
getPublicKey(request, callback) → {undefined}
Calls GetPublicKey.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IGetPublicKeyRequest |
GetPublicKeyRequest message or plain object |
callback |
google.cloud.kms.v1.KeyManagementService.GetPublicKeyCallback |
Node-style callback called with the error, if any, and PublicKey |
Returns:
Type | Description |
---|---|
undefined |
getPublicKey(request) → {Promise.<google.cloud.kms.v1.PublicKey>}
Calls GetPublicKey.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IGetPublicKeyRequest |
GetPublicKeyRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.kms.v1.PublicKey> |
Promise |
importCryptoKeyVersion(request, callback) → {undefined}
Calls ImportCryptoKeyVersion.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IImportCryptoKeyVersionRequest |
ImportCryptoKeyVersionRequest message or plain object |
callback |
google.cloud.kms.v1.KeyManagementService.ImportCryptoKeyVersionCallback |
Node-style callback called with the error, if any, and CryptoKeyVersion |
Returns:
Type | Description |
---|---|
undefined |
importCryptoKeyVersion(request) → {Promise.<google.cloud.kms.v1.CryptoKeyVersion>}
Calls ImportCryptoKeyVersion.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IImportCryptoKeyVersionRequest |
ImportCryptoKeyVersionRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.kms.v1.CryptoKeyVersion> |
Promise |
listCryptoKeyVersions(request, callback) → {undefined}
Calls ListCryptoKeyVersions.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IListCryptoKeyVersionsRequest |
ListCryptoKeyVersionsRequest message or plain object |
callback |
google.cloud.kms.v1.KeyManagementService.ListCryptoKeyVersionsCallback |
Node-style callback called with the error, if any, and ListCryptoKeyVersionsResponse |
Returns:
Type | Description |
---|---|
undefined |
listCryptoKeyVersions(request) → {Promise.<google.cloud.kms.v1.ListCryptoKeyVersionsResponse>}
Calls ListCryptoKeyVersions.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IListCryptoKeyVersionsRequest |
ListCryptoKeyVersionsRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.kms.v1.ListCryptoKeyVersionsResponse> |
Promise |
listCryptoKeys(request, callback) → {undefined}
Calls ListCryptoKeys.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IListCryptoKeysRequest |
ListCryptoKeysRequest message or plain object |
callback |
google.cloud.kms.v1.KeyManagementService.ListCryptoKeysCallback |
Node-style callback called with the error, if any, and ListCryptoKeysResponse |
Returns:
Type | Description |
---|---|
undefined |
listCryptoKeys(request) → {Promise.<google.cloud.kms.v1.ListCryptoKeysResponse>}
Calls ListCryptoKeys.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IListCryptoKeysRequest |
ListCryptoKeysRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.kms.v1.ListCryptoKeysResponse> |
Promise |
listImportJobs(request, callback) → {undefined}
Calls ListImportJobs.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IListImportJobsRequest |
ListImportJobsRequest message or plain object |
callback |
google.cloud.kms.v1.KeyManagementService.ListImportJobsCallback |
Node-style callback called with the error, if any, and ListImportJobsResponse |
Returns:
Type | Description |
---|---|
undefined |
listImportJobs(request) → {Promise.<google.cloud.kms.v1.ListImportJobsResponse>}
Calls ListImportJobs.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IListImportJobsRequest |
ListImportJobsRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.kms.v1.ListImportJobsResponse> |
Promise |
listKeyRings(request, callback) → {undefined}
Calls ListKeyRings.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IListKeyRingsRequest |
ListKeyRingsRequest message or plain object |
callback |
google.cloud.kms.v1.KeyManagementService.ListKeyRingsCallback |
Node-style callback called with the error, if any, and ListKeyRingsResponse |
Returns:
Type | Description |
---|---|
undefined |
listKeyRings(request) → {Promise.<google.cloud.kms.v1.ListKeyRingsResponse>}
Calls ListKeyRings.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IListKeyRingsRequest |
ListKeyRingsRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.kms.v1.ListKeyRingsResponse> |
Promise |
macSign(request, callback) → {undefined}
Calls MacSign.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IMacSignRequest |
MacSignRequest message or plain object |
callback |
google.cloud.kms.v1.KeyManagementService.MacSignCallback |
Node-style callback called with the error, if any, and MacSignResponse |
Returns:
Type | Description |
---|---|
undefined |
macSign(request) → {Promise.<google.cloud.kms.v1.MacSignResponse>}
Calls MacSign.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IMacSignRequest |
MacSignRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.kms.v1.MacSignResponse> |
Promise |
macVerify(request, callback) → {undefined}
Calls MacVerify.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IMacVerifyRequest |
MacVerifyRequest message or plain object |
callback |
google.cloud.kms.v1.KeyManagementService.MacVerifyCallback |
Node-style callback called with the error, if any, and MacVerifyResponse |
Returns:
Type | Description |
---|---|
undefined |
macVerify(request) → {Promise.<google.cloud.kms.v1.MacVerifyResponse>}
Calls MacVerify.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IMacVerifyRequest |
MacVerifyRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.kms.v1.MacVerifyResponse> |
Promise |
rawDecrypt(request, callback) → {undefined}
Calls RawDecrypt.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IRawDecryptRequest |
RawDecryptRequest message or plain object |
callback |
google.cloud.kms.v1.KeyManagementService.RawDecryptCallback |
Node-style callback called with the error, if any, and RawDecryptResponse |
Returns:
Type | Description |
---|---|
undefined |
rawDecrypt(request) → {Promise.<google.cloud.kms.v1.RawDecryptResponse>}
Calls RawDecrypt.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IRawDecryptRequest |
RawDecryptRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.kms.v1.RawDecryptResponse> |
Promise |
rawEncrypt(request, callback) → {undefined}
Calls RawEncrypt.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IRawEncryptRequest |
RawEncryptRequest message or plain object |
callback |
google.cloud.kms.v1.KeyManagementService.RawEncryptCallback |
Node-style callback called with the error, if any, and RawEncryptResponse |
Returns:
Type | Description |
---|---|
undefined |
rawEncrypt(request) → {Promise.<google.cloud.kms.v1.RawEncryptResponse>}
Calls RawEncrypt.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IRawEncryptRequest |
RawEncryptRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.kms.v1.RawEncryptResponse> |
Promise |
restoreCryptoKeyVersion(request, callback) → {undefined}
Calls RestoreCryptoKeyVersion.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IRestoreCryptoKeyVersionRequest |
RestoreCryptoKeyVersionRequest message or plain object |
callback |
google.cloud.kms.v1.KeyManagementService.RestoreCryptoKeyVersionCallback |
Node-style callback called with the error, if any, and CryptoKeyVersion |
Returns:
Type | Description |
---|---|
undefined |
restoreCryptoKeyVersion(request) → {Promise.<google.cloud.kms.v1.CryptoKeyVersion>}
Calls RestoreCryptoKeyVersion.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IRestoreCryptoKeyVersionRequest |
RestoreCryptoKeyVersionRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.kms.v1.CryptoKeyVersion> |
Promise |
updateCryptoKey(request, callback) → {undefined}
Calls UpdateCryptoKey.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IUpdateCryptoKeyRequest |
UpdateCryptoKeyRequest message or plain object |
callback |
google.cloud.kms.v1.KeyManagementService.UpdateCryptoKeyCallback |
Node-style callback called with the error, if any, and CryptoKey |
Returns:
Type | Description |
---|---|
undefined |
updateCryptoKey(request) → {Promise.<google.cloud.kms.v1.CryptoKey>}
Calls UpdateCryptoKey.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IUpdateCryptoKeyRequest |
UpdateCryptoKeyRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.kms.v1.CryptoKey> |
Promise |
updateCryptoKeyPrimaryVersion(request, callback) → {undefined}
Calls UpdateCryptoKeyPrimaryVersion.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IUpdateCryptoKeyPrimaryVersionRequest |
UpdateCryptoKeyPrimaryVersionRequest message or plain object |
callback |
google.cloud.kms.v1.KeyManagementService.UpdateCryptoKeyPrimaryVersionCallback |
Node-style callback called with the error, if any, and CryptoKey |
Returns:
Type | Description |
---|---|
undefined |
updateCryptoKeyPrimaryVersion(request) → {Promise.<google.cloud.kms.v1.CryptoKey>}
Calls UpdateCryptoKeyPrimaryVersion.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IUpdateCryptoKeyPrimaryVersionRequest |
UpdateCryptoKeyPrimaryVersionRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.kms.v1.CryptoKey> |
Promise |
updateCryptoKeyVersion(request, callback) → {undefined}
Calls UpdateCryptoKeyVersion.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IUpdateCryptoKeyVersionRequest |
UpdateCryptoKeyVersionRequest message or plain object |
callback |
google.cloud.kms.v1.KeyManagementService.UpdateCryptoKeyVersionCallback |
Node-style callback called with the error, if any, and CryptoKeyVersion |
Returns:
Type | Description |
---|---|
undefined |
updateCryptoKeyVersion(request) → {Promise.<google.cloud.kms.v1.CryptoKeyVersion>}
Calls UpdateCryptoKeyVersion.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.kms.v1.IUpdateCryptoKeyVersionRequest |
UpdateCryptoKeyVersionRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.kms.v1.CryptoKeyVersion> |
Promise |
(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {KeyManagementService}
Creates new KeyManagementService service using the specified rpc implementation.
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
rpcImpl |
$protobuf.RPCImpl |
RPC implementation |
||
requestDelimited |
boolean |
<optional> |
false |
Whether requests are length-delimited |
responseDelimited |
boolean |
<optional> |
false |
Whether responses are length-delimited |
Returns:
Type | Description |
---|---|
KeyManagementService |
RPC service. Useful where requests and/or responses are streamed. |
Type Definitions
AsymmetricDecryptCallback(error, responseopt)
Callback as used by asymmetricDecrypt.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.kms.v1.AsymmetricDecryptResponse |
<optional> |
AsymmetricDecryptResponse |
AsymmetricSignCallback(error, responseopt)
Callback as used by asymmetricSign.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.kms.v1.AsymmetricSignResponse |
<optional> |
AsymmetricSignResponse |
CreateCryptoKeyCallback(error, responseopt)
Callback as used by createCryptoKey.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.kms.v1.CryptoKey |
<optional> |
CryptoKey |
CreateCryptoKeyVersionCallback(error, responseopt)
Callback as used by createCryptoKeyVersion.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.kms.v1.CryptoKeyVersion |
<optional> |
CryptoKeyVersion |
CreateImportJobCallback(error, responseopt)
Callback as used by createImportJob.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.kms.v1.ImportJob |
<optional> |
ImportJob |
CreateKeyRingCallback(error, responseopt)
Callback as used by createKeyRing.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.kms.v1.KeyRing |
<optional> |
KeyRing |
DecryptCallback(error, responseopt)
Callback as used by decrypt.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.kms.v1.DecryptResponse |
<optional> |
DecryptResponse |
DestroyCryptoKeyVersionCallback(error, responseopt)
Callback as used by destroyCryptoKeyVersion.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.kms.v1.CryptoKeyVersion |
<optional> |
CryptoKeyVersion |
EncryptCallback(error, responseopt)
Callback as used by encrypt.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.kms.v1.EncryptResponse |
<optional> |
EncryptResponse |
GenerateRandomBytesCallback(error, responseopt)
Callback as used by generateRandomBytes.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.kms.v1.GenerateRandomBytesResponse |
<optional> |
GenerateRandomBytesResponse |
GetCryptoKeyCallback(error, responseopt)
Callback as used by getCryptoKey.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.kms.v1.CryptoKey |
<optional> |
CryptoKey |
GetCryptoKeyVersionCallback(error, responseopt)
Callback as used by getCryptoKeyVersion.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.kms.v1.CryptoKeyVersion |
<optional> |
CryptoKeyVersion |
GetImportJobCallback(error, responseopt)
Callback as used by getImportJob.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.kms.v1.ImportJob |
<optional> |
ImportJob |
GetKeyRingCallback(error, responseopt)
Callback as used by getKeyRing.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.kms.v1.KeyRing |
<optional> |
KeyRing |
GetPublicKeyCallback(error, responseopt)
Callback as used by getPublicKey.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.kms.v1.PublicKey |
<optional> |
PublicKey |
ImportCryptoKeyVersionCallback(error, responseopt)
Callback as used by importCryptoKeyVersion.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.kms.v1.CryptoKeyVersion |
<optional> |
CryptoKeyVersion |
ListCryptoKeyVersionsCallback(error, responseopt)
Callback as used by listCryptoKeyVersions.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.kms.v1.ListCryptoKeyVersionsResponse |
<optional> |
ListCryptoKeyVersionsResponse |
ListCryptoKeysCallback(error, responseopt)
Callback as used by listCryptoKeys.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.kms.v1.ListCryptoKeysResponse |
<optional> |
ListCryptoKeysResponse |
ListImportJobsCallback(error, responseopt)
Callback as used by listImportJobs.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.kms.v1.ListImportJobsResponse |
<optional> |
ListImportJobsResponse |
ListKeyRingsCallback(error, responseopt)
Callback as used by listKeyRings.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.kms.v1.ListKeyRingsResponse |
<optional> |
ListKeyRingsResponse |
MacSignCallback(error, responseopt)
Callback as used by macSign.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.kms.v1.MacSignResponse |
<optional> |
MacSignResponse |
MacVerifyCallback(error, responseopt)
Callback as used by macVerify.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.kms.v1.MacVerifyResponse |
<optional> |
MacVerifyResponse |
RawDecryptCallback(error, responseopt)
Callback as used by rawDecrypt.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.kms.v1.RawDecryptResponse |
<optional> |
RawDecryptResponse |
RawEncryptCallback(error, responseopt)
Callback as used by rawEncrypt.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.kms.v1.RawEncryptResponse |
<optional> |
RawEncryptResponse |
RestoreCryptoKeyVersionCallback(error, responseopt)
Callback as used by restoreCryptoKeyVersion.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.kms.v1.CryptoKeyVersion |
<optional> |
CryptoKeyVersion |
UpdateCryptoKeyCallback(error, responseopt)
Callback as used by updateCryptoKey.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.kms.v1.CryptoKey |
<optional> |
CryptoKey |
UpdateCryptoKeyPrimaryVersionCallback(error, responseopt)
Callback as used by updateCryptoKeyPrimaryVersion.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.kms.v1.CryptoKey |
<optional> |
CryptoKey |
UpdateCryptoKeyVersionCallback(error, responseopt)
Callback as used by updateCryptoKeyVersion.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.kms.v1.CryptoKeyVersion |
<optional> |
CryptoKeyVersion |