Class protos.google.cloud.kms.v1.KeyManagementService (5.3.0)

Represents a KeyManagementService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.kms.v1.KeyManagementService

Package

@google-cloud/kms

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new KeyManagementService service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

asymmetricDecrypt(request, callback)

public asymmetricDecrypt(request: google.cloud.kms.v1.IAsymmetricDecryptRequest, callback: google.cloud.kms.v1.KeyManagementService.AsymmetricDecryptCallback): void;

Calls AsymmetricDecrypt.

Parameters
Name Description
request IAsymmetricDecryptRequest

AsymmetricDecryptRequest message or plain object
callback AsymmetricDecryptCallback

Node-style callback called with the error, if any, and AsymmetricDecryptResponse
Returns
Type Description
void

asymmetricDecrypt(request)

public asymmetricDecrypt(request: google.cloud.kms.v1.IAsymmetricDecryptRequest): Promise<google.cloud.kms.v1.AsymmetricDecryptResponse>;

Calls AsymmetricDecrypt.

Parameter
Name Description
request IAsymmetricDecryptRequest

AsymmetricDecryptRequest message or plain object
Returns
Type Description
Promise<google.cloud.kms.v1.AsymmetricDecryptResponse>

Promise

asymmetricSign(request, callback)

public asymmetricSign(request: google.cloud.kms.v1.IAsymmetricSignRequest, callback: google.cloud.kms.v1.KeyManagementService.AsymmetricSignCallback): void;

Calls AsymmetricSign.

Parameters
Name Description
request IAsymmetricSignRequest

AsymmetricSignRequest message or plain object
callback AsymmetricSignCallback

Node-style callback called with the error, if any, and AsymmetricSignResponse
Returns
Type Description
void

asymmetricSign(request)

public asymmetricSign(request: google.cloud.kms.v1.IAsymmetricSignRequest): Promise<google.cloud.kms.v1.AsymmetricSignResponse>;

Calls AsymmetricSign.

Parameter
Name Description
request IAsymmetricSignRequest

AsymmetricSignRequest message or plain object
Returns
Type Description
Promise<google.cloud.kms.v1.AsymmetricSignResponse>

Promise

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): KeyManagementService;

Creates new KeyManagementService service using the specified rpc implementation.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited
Returns
Type Description
KeyManagementService

RPC service. Useful where requests and/or responses are streamed.

createCryptoKey(request, callback)

public createCryptoKey(request: google.cloud.kms.v1.ICreateCryptoKeyRequest, callback: google.cloud.kms.v1.KeyManagementService.CreateCryptoKeyCallback): void;

Calls CreateCryptoKey.

Parameters
Name Description
request ICreateCryptoKeyRequest

CreateCryptoKeyRequest message or plain object
callback CreateCryptoKeyCallback

Node-style callback called with the error, if any, and CryptoKey
Returns
Type Description
void

createCryptoKey(request)

public createCryptoKey(request: google.cloud.kms.v1.ICreateCryptoKeyRequest): Promise<google.cloud.kms.v1.CryptoKey>;

Calls CreateCryptoKey.

Parameter
Name Description
request ICreateCryptoKeyRequest

CreateCryptoKeyRequest message or plain object
Returns
Type Description
Promise<google.cloud.kms.v1.CryptoKey>

Promise

createCryptoKeyVersion(request, callback)

public createCryptoKeyVersion(request: google.cloud.kms.v1.ICreateCryptoKeyVersionRequest, callback: google.cloud.kms.v1.KeyManagementService.CreateCryptoKeyVersionCallback): void;

Calls CreateCryptoKeyVersion.

Parameters
Name Description
request ICreateCryptoKeyVersionRequest

CreateCryptoKeyVersionRequest message or plain object
callback CreateCryptoKeyVersionCallback

Node-style callback called with the error, if any, and CryptoKeyVersion
Returns
Type Description
void

createCryptoKeyVersion(request)

public createCryptoKeyVersion(request: google.cloud.kms.v1.ICreateCryptoKeyVersionRequest): Promise<google.cloud.kms.v1.CryptoKeyVersion>;

Calls CreateCryptoKeyVersion.

Parameter
Name Description
request ICreateCryptoKeyVersionRequest

CreateCryptoKeyVersionRequest message or plain object
Returns
Type Description
Promise<google.cloud.kms.v1.CryptoKeyVersion>

Promise

createImportJob(request, callback)

public createImportJob(request: google.cloud.kms.v1.ICreateImportJobRequest, callback: google.cloud.kms.v1.KeyManagementService.CreateImportJobCallback): void;

Calls CreateImportJob.

Parameters
Name Description
request ICreateImportJobRequest

CreateImportJobRequest message or plain object
callback CreateImportJobCallback

Node-style callback called with the error, if any, and ImportJob
Returns
Type Description
void

createImportJob(request)

public createImportJob(request: google.cloud.kms.v1.ICreateImportJobRequest): Promise<google.cloud.kms.v1.ImportJob>;

Calls CreateImportJob.

Parameter
Name Description
request ICreateImportJobRequest

CreateImportJobRequest message or plain object
Returns
Type Description
Promise<google.cloud.kms.v1.ImportJob>

Promise

createKeyRing(request, callback)

public createKeyRing(request: google.cloud.kms.v1.ICreateKeyRingRequest, callback: google.cloud.kms.v1.KeyManagementService.CreateKeyRingCallback): void;

Calls CreateKeyRing.

Parameters
Name Description
request ICreateKeyRingRequest

CreateKeyRingRequest message or plain object
callback CreateKeyRingCallback

Node-style callback called with the error, if any, and KeyRing
Returns
Type Description
void

createKeyRing(request)

public createKeyRing(request: google.cloud.kms.v1.ICreateKeyRingRequest): Promise<google.cloud.kms.v1.KeyRing>;

Calls CreateKeyRing.

Parameter
Name Description
request ICreateKeyRingRequest

CreateKeyRingRequest message or plain object
Returns
Type Description
Promise<google.cloud.kms.v1.KeyRing>

Promise

decapsulate(request, callback)

public decapsulate(request: google.cloud.kms.v1.IDecapsulateRequest, callback: google.cloud.kms.v1.KeyManagementService.DecapsulateCallback): void;

Calls Decapsulate.

Parameters
Name Description
request IDecapsulateRequest

DecapsulateRequest message or plain object
callback DecapsulateCallback

Node-style callback called with the error, if any, and DecapsulateResponse
Returns
Type Description
void

decapsulate(request)

public decapsulate(request: google.cloud.kms.v1.IDecapsulateRequest): Promise<google.cloud.kms.v1.DecapsulateResponse>;

Calls Decapsulate.

Parameter
Name Description
request IDecapsulateRequest

DecapsulateRequest message or plain object
Returns
Type Description
Promise<google.cloud.kms.v1.DecapsulateResponse>

Promise

decrypt(request, callback)

public decrypt(request: google.cloud.kms.v1.IDecryptRequest, callback: google.cloud.kms.v1.KeyManagementService.DecryptCallback): void;

Calls Decrypt.

Parameters
Name Description
request IDecryptRequest

DecryptRequest message or plain object
callback DecryptCallback

Node-style callback called with the error, if any, and DecryptResponse
Returns
Type Description
void

decrypt(request)

public decrypt(request: google.cloud.kms.v1.IDecryptRequest): Promise<google.cloud.kms.v1.DecryptResponse>;

Calls Decrypt.

Parameter
Name Description
request IDecryptRequest

DecryptRequest message or plain object
Returns
Type Description
Promise<google.cloud.kms.v1.DecryptResponse>

Promise

destroyCryptoKeyVersion(request, callback)

public destroyCryptoKeyVersion(request: google.cloud.kms.v1.IDestroyCryptoKeyVersionRequest, callback: google.cloud.kms.v1.KeyManagementService.DestroyCryptoKeyVersionCallback): void;

Calls DestroyCryptoKeyVersion.

Parameters
Name Description
request IDestroyCryptoKeyVersionRequest

DestroyCryptoKeyVersionRequest message or plain object
callback DestroyCryptoKeyVersionCallback

Node-style callback called with the error, if any, and CryptoKeyVersion
Returns
Type Description
void

destroyCryptoKeyVersion(request)

public destroyCryptoKeyVersion(request: google.cloud.kms.v1.IDestroyCryptoKeyVersionRequest): Promise<google.cloud.kms.v1.CryptoKeyVersion>;

Calls DestroyCryptoKeyVersion.

Parameter
Name Description
request IDestroyCryptoKeyVersionRequest

DestroyCryptoKeyVersionRequest message or plain object
Returns
Type Description
Promise<google.cloud.kms.v1.CryptoKeyVersion>

Promise

encrypt(request, callback)

public encrypt(request: google.cloud.kms.v1.IEncryptRequest, callback: google.cloud.kms.v1.KeyManagementService.EncryptCallback): void;

Calls Encrypt.

Parameters
Name Description
request IEncryptRequest

EncryptRequest message or plain object
callback EncryptCallback

Node-style callback called with the error, if any, and EncryptResponse
Returns
Type Description
void

encrypt(request)

public encrypt(request: google.cloud.kms.v1.IEncryptRequest): Promise<google.cloud.kms.v1.EncryptResponse>;

Calls Encrypt.

Parameter
Name Description
request IEncryptRequest

EncryptRequest message or plain object
Returns
Type Description
Promise<google.cloud.kms.v1.EncryptResponse>

Promise

generateRandomBytes(request, callback)

public generateRandomBytes(request: google.cloud.kms.v1.IGenerateRandomBytesRequest, callback: google.cloud.kms.v1.KeyManagementService.GenerateRandomBytesCallback): void;

Calls GenerateRandomBytes.

Parameters
Name Description
request IGenerateRandomBytesRequest

GenerateRandomBytesRequest message or plain object
callback GenerateRandomBytesCallback

Node-style callback called with the error, if any, and GenerateRandomBytesResponse
Returns
Type Description
void

generateRandomBytes(request)

public generateRandomBytes(request: google.cloud.kms.v1.IGenerateRandomBytesRequest): Promise<google.cloud.kms.v1.GenerateRandomBytesResponse>;

Calls GenerateRandomBytes.

Parameter
Name Description
request IGenerateRandomBytesRequest

GenerateRandomBytesRequest message or plain object
Returns
Type Description
Promise<google.cloud.kms.v1.GenerateRandomBytesResponse>

Promise

getCryptoKey(request, callback)

public getCryptoKey(request: google.cloud.kms.v1.IGetCryptoKeyRequest, callback: google.cloud.kms.v1.KeyManagementService.GetCryptoKeyCallback): void;

Calls GetCryptoKey.

Parameters
Name Description
request IGetCryptoKeyRequest

GetCryptoKeyRequest message or plain object
callback GetCryptoKeyCallback

Node-style callback called with the error, if any, and CryptoKey
Returns
Type Description
void

getCryptoKey(request)

public getCryptoKey(request: google.cloud.kms.v1.IGetCryptoKeyRequest): Promise<google.cloud.kms.v1.CryptoKey>;

Calls GetCryptoKey.

Parameter
Name Description
request IGetCryptoKeyRequest

GetCryptoKeyRequest message or plain object
Returns
Type Description
Promise<google.cloud.kms.v1.CryptoKey>

Promise

getCryptoKeyVersion(request, callback)

public getCryptoKeyVersion(request: google.cloud.kms.v1.IGetCryptoKeyVersionRequest, callback: google.cloud.kms.v1.KeyManagementService.GetCryptoKeyVersionCallback): void;

Calls GetCryptoKeyVersion.

Parameters
Name Description
request IGetCryptoKeyVersionRequest

GetCryptoKeyVersionRequest message or plain object
callback GetCryptoKeyVersionCallback

Node-style callback called with the error, if any, and CryptoKeyVersion
Returns
Type Description
void

getCryptoKeyVersion(request)

public getCryptoKeyVersion(request: google.cloud.kms.v1.IGetCryptoKeyVersionRequest): Promise<google.cloud.kms.v1.CryptoKeyVersion>;

Calls GetCryptoKeyVersion.

Parameter
Name Description
request IGetCryptoKeyVersionRequest

GetCryptoKeyVersionRequest message or plain object
Returns
Type Description
Promise<google.cloud.kms.v1.CryptoKeyVersion>

Promise

getImportJob(request, callback)

public getImportJob(request: google.cloud.kms.v1.IGetImportJobRequest, callback: google.cloud.kms.v1.KeyManagementService.GetImportJobCallback): void;

Calls GetImportJob.

Parameters
Name Description
request IGetImportJobRequest

GetImportJobRequest message or plain object
callback GetImportJobCallback

Node-style callback called with the error, if any, and ImportJob
Returns
Type Description
void

getImportJob(request)

public getImportJob(request: google.cloud.kms.v1.IGetImportJobRequest): Promise<google.cloud.kms.v1.ImportJob>;

Calls GetImportJob.

Parameter
Name Description
request IGetImportJobRequest

GetImportJobRequest message or plain object
Returns
Type Description
Promise<google.cloud.kms.v1.ImportJob>

Promise

getKeyRing(request, callback)

public getKeyRing(request: google.cloud.kms.v1.IGetKeyRingRequest, callback: google.cloud.kms.v1.KeyManagementService.GetKeyRingCallback): void;

Calls GetKeyRing.

Parameters
Name Description
request IGetKeyRingRequest

GetKeyRingRequest message or plain object
callback GetKeyRingCallback

Node-style callback called with the error, if any, and KeyRing
Returns
Type Description
void

getKeyRing(request)

public getKeyRing(request: google.cloud.kms.v1.IGetKeyRingRequest): Promise<google.cloud.kms.v1.KeyRing>;

Calls GetKeyRing.

Parameter
Name Description
request IGetKeyRingRequest

GetKeyRingRequest message or plain object
Returns
Type Description
Promise<google.cloud.kms.v1.KeyRing>

Promise

getPublicKey(request, callback)

public getPublicKey(request: google.cloud.kms.v1.IGetPublicKeyRequest, callback: google.cloud.kms.v1.KeyManagementService.GetPublicKeyCallback): void;

Calls GetPublicKey.

Parameters
Name Description
request IGetPublicKeyRequest

GetPublicKeyRequest message or plain object
callback GetPublicKeyCallback

Node-style callback called with the error, if any, and PublicKey
Returns
Type Description
void

getPublicKey(request)

public getPublicKey(request: google.cloud.kms.v1.IGetPublicKeyRequest): Promise<google.cloud.kms.v1.PublicKey>;

Calls GetPublicKey.

Parameter
Name Description
request IGetPublicKeyRequest

GetPublicKeyRequest message or plain object
Returns
Type Description
Promise<google.cloud.kms.v1.PublicKey>

Promise

importCryptoKeyVersion(request, callback)

public importCryptoKeyVersion(request: google.cloud.kms.v1.IImportCryptoKeyVersionRequest, callback: google.cloud.kms.v1.KeyManagementService.ImportCryptoKeyVersionCallback): void;

Calls ImportCryptoKeyVersion.

Parameters
Name Description
request IImportCryptoKeyVersionRequest

ImportCryptoKeyVersionRequest message or plain object
callback ImportCryptoKeyVersionCallback

Node-style callback called with the error, if any, and CryptoKeyVersion
Returns
Type Description
void

importCryptoKeyVersion(request)

public importCryptoKeyVersion(request: google.cloud.kms.v1.IImportCryptoKeyVersionRequest): Promise<google.cloud.kms.v1.CryptoKeyVersion>;

Calls ImportCryptoKeyVersion.

Parameter
Name Description
request IImportCryptoKeyVersionRequest

ImportCryptoKeyVersionRequest message or plain object
Returns
Type Description
Promise<google.cloud.kms.v1.CryptoKeyVersion>

Promise

listCryptoKeys(request, callback)

public listCryptoKeys(request: google.cloud.kms.v1.IListCryptoKeysRequest, callback: google.cloud.kms.v1.KeyManagementService.ListCryptoKeysCallback): void;

Calls ListCryptoKeys.

Parameters
Name Description
request IListCryptoKeysRequest

ListCryptoKeysRequest message or plain object
callback ListCryptoKeysCallback

Node-style callback called with the error, if any, and ListCryptoKeysResponse
Returns
Type Description
void

listCryptoKeys(request)

public listCryptoKeys(request: google.cloud.kms.v1.IListCryptoKeysRequest): Promise<google.cloud.kms.v1.ListCryptoKeysResponse>;

Calls ListCryptoKeys.

Parameter
Name Description
request IListCryptoKeysRequest

ListCryptoKeysRequest message or plain object
Returns
Type Description
Promise<google.cloud.kms.v1.ListCryptoKeysResponse>

Promise

listCryptoKeyVersions(request, callback)

public listCryptoKeyVersions(request: google.cloud.kms.v1.IListCryptoKeyVersionsRequest, callback: google.cloud.kms.v1.KeyManagementService.ListCryptoKeyVersionsCallback): void;

Calls ListCryptoKeyVersions.

Parameters
Name Description
request IListCryptoKeyVersionsRequest

ListCryptoKeyVersionsRequest message or plain object
callback ListCryptoKeyVersionsCallback

Node-style callback called with the error, if any, and ListCryptoKeyVersionsResponse
Returns
Type Description
void

listCryptoKeyVersions(request)

public listCryptoKeyVersions(request: google.cloud.kms.v1.IListCryptoKeyVersionsRequest): Promise<google.cloud.kms.v1.ListCryptoKeyVersionsResponse>;

Calls ListCryptoKeyVersions.

Parameter
Name Description
request IListCryptoKeyVersionsRequest

ListCryptoKeyVersionsRequest message or plain object
Returns
Type Description
Promise<google.cloud.kms.v1.ListCryptoKeyVersionsResponse>

Promise

listImportJobs(request, callback)

public listImportJobs(request: google.cloud.kms.v1.IListImportJobsRequest, callback: google.cloud.kms.v1.KeyManagementService.ListImportJobsCallback): void;

Calls ListImportJobs.

Parameters
Name Description
request IListImportJobsRequest

ListImportJobsRequest message or plain object
callback ListImportJobsCallback

Node-style callback called with the error, if any, and ListImportJobsResponse
Returns
Type Description
void

listImportJobs(request)

public listImportJobs(request: google.cloud.kms.v1.IListImportJobsRequest): Promise<google.cloud.kms.v1.ListImportJobsResponse>;

Calls ListImportJobs.

Parameter
Name Description
request IListImportJobsRequest

ListImportJobsRequest message or plain object
Returns
Type Description
Promise<google.cloud.kms.v1.ListImportJobsResponse>

Promise

listKeyRings(request, callback)

public listKeyRings(request: google.cloud.kms.v1.IListKeyRingsRequest, callback: google.cloud.kms.v1.KeyManagementService.ListKeyRingsCallback): void;

Calls ListKeyRings.

Parameters
Name Description
request IListKeyRingsRequest

ListKeyRingsRequest message or plain object
callback ListKeyRingsCallback

Node-style callback called with the error, if any, and ListKeyRingsResponse
Returns
Type Description
void

listKeyRings(request)

public listKeyRings(request: google.cloud.kms.v1.IListKeyRingsRequest): Promise<google.cloud.kms.v1.ListKeyRingsResponse>;

Calls ListKeyRings.

Parameter
Name Description
request IListKeyRingsRequest

ListKeyRingsRequest message or plain object
Returns
Type Description
Promise<google.cloud.kms.v1.ListKeyRingsResponse>

Promise

macSign(request, callback)

public macSign(request: google.cloud.kms.v1.IMacSignRequest, callback: google.cloud.kms.v1.KeyManagementService.MacSignCallback): void;

Calls MacSign.

Parameters
Name Description
request IMacSignRequest

MacSignRequest message or plain object
callback MacSignCallback

Node-style callback called with the error, if any, and MacSignResponse
Returns
Type Description
void

macSign(request)

public macSign(request: google.cloud.kms.v1.IMacSignRequest): Promise<google.cloud.kms.v1.MacSignResponse>;

Calls MacSign.

Parameter
Name Description
request IMacSignRequest

MacSignRequest message or plain object
Returns
Type Description
Promise<google.cloud.kms.v1.MacSignResponse>

Promise

macVerify(request, callback)

public macVerify(request: google.cloud.kms.v1.IMacVerifyRequest, callback: google.cloud.kms.v1.KeyManagementService.MacVerifyCallback): void;

Calls MacVerify.

Parameters
Name Description
request IMacVerifyRequest

MacVerifyRequest message or plain object
callback MacVerifyCallback

Node-style callback called with the error, if any, and MacVerifyResponse
Returns
Type Description
void

macVerify(request)

public macVerify(request: google.cloud.kms.v1.IMacVerifyRequest): Promise<google.cloud.kms.v1.MacVerifyResponse>;

Calls MacVerify.

Parameter
Name Description
request IMacVerifyRequest

MacVerifyRequest message or plain object
Returns
Type Description
Promise<google.cloud.kms.v1.MacVerifyResponse>

Promise

rawDecrypt(request, callback)

public rawDecrypt(request: google.cloud.kms.v1.IRawDecryptRequest, callback: google.cloud.kms.v1.KeyManagementService.RawDecryptCallback): void;

Calls RawDecrypt.

Parameters
Name Description
request IRawDecryptRequest

RawDecryptRequest message or plain object
callback RawDecryptCallback

Node-style callback called with the error, if any, and RawDecryptResponse
Returns
Type Description
void

rawDecrypt(request)

public rawDecrypt(request: google.cloud.kms.v1.IRawDecryptRequest): Promise<google.cloud.kms.v1.RawDecryptResponse>;

Calls RawDecrypt.

Parameter
Name Description
request IRawDecryptRequest

RawDecryptRequest message or plain object
Returns
Type Description
Promise<google.cloud.kms.v1.RawDecryptResponse>

Promise

rawEncrypt(request, callback)

public rawEncrypt(request: google.cloud.kms.v1.IRawEncryptRequest, callback: google.cloud.kms.v1.KeyManagementService.RawEncryptCallback): void;

Calls RawEncrypt.

Parameters
Name Description
request IRawEncryptRequest

RawEncryptRequest message or plain object
callback RawEncryptCallback

Node-style callback called with the error, if any, and RawEncryptResponse
Returns
Type Description
void

rawEncrypt(request)

public rawEncrypt(request: google.cloud.kms.v1.IRawEncryptRequest): Promise<google.cloud.kms.v1.RawEncryptResponse>;

Calls RawEncrypt.

Parameter
Name Description
request IRawEncryptRequest

RawEncryptRequest message or plain object
Returns
Type Description
Promise<google.cloud.kms.v1.RawEncryptResponse>

Promise

restoreCryptoKeyVersion(request, callback)

public restoreCryptoKeyVersion(request: google.cloud.kms.v1.IRestoreCryptoKeyVersionRequest, callback: google.cloud.kms.v1.KeyManagementService.RestoreCryptoKeyVersionCallback): void;

Calls RestoreCryptoKeyVersion.

Parameters
Name Description
request IRestoreCryptoKeyVersionRequest

RestoreCryptoKeyVersionRequest message or plain object
callback RestoreCryptoKeyVersionCallback

Node-style callback called with the error, if any, and CryptoKeyVersion
Returns
Type Description
void

restoreCryptoKeyVersion(request)

public restoreCryptoKeyVersion(request: google.cloud.kms.v1.IRestoreCryptoKeyVersionRequest): Promise<google.cloud.kms.v1.CryptoKeyVersion>;

Calls RestoreCryptoKeyVersion.

Parameter
Name Description
request IRestoreCryptoKeyVersionRequest

RestoreCryptoKeyVersionRequest message or plain object
Returns
Type Description
Promise<google.cloud.kms.v1.CryptoKeyVersion>

Promise

updateCryptoKey(request, callback)

public updateCryptoKey(request: google.cloud.kms.v1.IUpdateCryptoKeyRequest, callback: google.cloud.kms.v1.KeyManagementService.UpdateCryptoKeyCallback): void;

Calls UpdateCryptoKey.

Parameters
Name Description
request IUpdateCryptoKeyRequest

UpdateCryptoKeyRequest message or plain object
callback UpdateCryptoKeyCallback

Node-style callback called with the error, if any, and CryptoKey
Returns
Type Description
void

updateCryptoKey(request)

public updateCryptoKey(request: google.cloud.kms.v1.IUpdateCryptoKeyRequest): Promise<google.cloud.kms.v1.CryptoKey>;

Calls UpdateCryptoKey.

Parameter
Name Description
request IUpdateCryptoKeyRequest

UpdateCryptoKeyRequest message or plain object
Returns
Type Description
Promise<google.cloud.kms.v1.CryptoKey>

Promise

updateCryptoKeyPrimaryVersion(request, callback)

public updateCryptoKeyPrimaryVersion(request: google.cloud.kms.v1.IUpdateCryptoKeyPrimaryVersionRequest, callback: google.cloud.kms.v1.KeyManagementService.UpdateCryptoKeyPrimaryVersionCallback): void;

Calls UpdateCryptoKeyPrimaryVersion.

Parameters
Name Description
request IUpdateCryptoKeyPrimaryVersionRequest

UpdateCryptoKeyPrimaryVersionRequest message or plain object
callback UpdateCryptoKeyPrimaryVersionCallback

Node-style callback called with the error, if any, and CryptoKey
Returns
Type Description
void

updateCryptoKeyPrimaryVersion(request)

public updateCryptoKeyPrimaryVersion(request: google.cloud.kms.v1.IUpdateCryptoKeyPrimaryVersionRequest): Promise<google.cloud.kms.v1.CryptoKey>;

Calls UpdateCryptoKeyPrimaryVersion.

Parameter
Name Description
request IUpdateCryptoKeyPrimaryVersionRequest

UpdateCryptoKeyPrimaryVersionRequest message or plain object
Returns
Type Description
Promise<google.cloud.kms.v1.CryptoKey>

Promise

updateCryptoKeyVersion(request, callback)

public updateCryptoKeyVersion(request: google.cloud.kms.v1.IUpdateCryptoKeyVersionRequest, callback: google.cloud.kms.v1.KeyManagementService.UpdateCryptoKeyVersionCallback): void;

Calls UpdateCryptoKeyVersion.

Parameters
Name Description
request IUpdateCryptoKeyVersionRequest

UpdateCryptoKeyVersionRequest message or plain object
callback UpdateCryptoKeyVersionCallback

Node-style callback called with the error, if any, and CryptoKeyVersion
Returns
Type Description
void

updateCryptoKeyVersion(request)

public updateCryptoKeyVersion(request: google.cloud.kms.v1.IUpdateCryptoKeyVersionRequest): Promise<google.cloud.kms.v1.CryptoKeyVersion>;

Calls UpdateCryptoKeyVersion.

Parameter
Name Description
request IUpdateCryptoKeyVersionRequest

UpdateCryptoKeyVersionRequest message or plain object
Returns
Type Description
Promise<google.cloud.kms.v1.CryptoKeyVersion>

Promise