Class protos.google.cloud.kms.v1.KeyManagementService

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
TypeNameDescription
$protobuf.RPCImplrpcImpl

RPC implementation

booleanrequestDelimited

Whether requests are length-delimited

booleanresponseDelimited

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
TypeNameDescription
IAsymmetricDecryptRequestrequest

AsymmetricDecryptRequest message or plain object

google.cloud.kms.v1.KeyManagementService.AsymmetricDecryptCallbackcallback

Node-style callback called with the error, if any, and AsymmetricDecryptResponse

Returns
TypeDescription
void

asymmetricDecrypt(request)

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

Calls AsymmetricDecrypt.

Parameter
TypeNameDescription
IAsymmetricDecryptRequestrequest

AsymmetricDecryptRequest message or plain object

Returns
TypeDescription
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
TypeNameDescription
google.cloud.kms.v1.IAsymmetricSignRequestrequest

AsymmetricSignRequest message or plain object

google.cloud.kms.v1.KeyManagementService.AsymmetricSignCallbackcallback

Node-style callback called with the error, if any, and AsymmetricSignResponse

Returns
TypeDescription
void

asymmetricSign(request)

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

Calls AsymmetricSign.

Parameter
TypeNameDescription
google.cloud.kms.v1.IAsymmetricSignRequestrequest

AsymmetricSignRequest message or plain object

Returns
TypeDescription
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
TypeNameDescription
$protobuf.RPCImplrpcImpl

RPC implementation

booleanrequestDelimited

Whether requests are length-delimited

booleanresponseDelimited

Whether responses are length-delimited

Returns
TypeDescription
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
TypeNameDescription
ICreateCryptoKeyRequestrequest

CreateCryptoKeyRequest message or plain object

google.cloud.kms.v1.KeyManagementService.CreateCryptoKeyCallbackcallback

Node-style callback called with the error, if any, and CryptoKey

Returns
TypeDescription
void

createCryptoKey(request)

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

Calls CreateCryptoKey.

Parameter
TypeNameDescription
ICreateCryptoKeyRequestrequest

CreateCryptoKeyRequest message or plain object

Returns
TypeDescription
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
TypeNameDescription
ICreateCryptoKeyVersionRequestrequest

CreateCryptoKeyVersionRequest message or plain object

google.cloud.kms.v1.KeyManagementService.CreateCryptoKeyVersionCallbackcallback

Node-style callback called with the error, if any, and CryptoKeyVersion

Returns
TypeDescription
void

createCryptoKeyVersion(request)

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

Calls CreateCryptoKeyVersion.

Parameter
TypeNameDescription
ICreateCryptoKeyVersionRequestrequest

CreateCryptoKeyVersionRequest message or plain object

Returns
TypeDescription
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
TypeNameDescription
google.cloud.kms.v1.ICreateImportJobRequestrequest

CreateImportJobRequest message or plain object

google.cloud.kms.v1.KeyManagementService.CreateImportJobCallbackcallback

Node-style callback called with the error, if any, and ImportJob

Returns
TypeDescription
void

createImportJob(request)

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

Calls CreateImportJob.

Parameter
TypeNameDescription
google.cloud.kms.v1.ICreateImportJobRequestrequest

CreateImportJobRequest message or plain object

Returns
TypeDescription
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
TypeNameDescription
ICreateKeyRingRequestrequest

CreateKeyRingRequest message or plain object

google.cloud.kms.v1.KeyManagementService.CreateKeyRingCallbackcallback

Node-style callback called with the error, if any, and KeyRing

Returns
TypeDescription
void

createKeyRing(request)

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

Calls CreateKeyRing.

Parameter
TypeNameDescription
ICreateKeyRingRequestrequest

CreateKeyRingRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.kms.v1.KeyRing>

Promise

decrypt(request, callback)

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

Calls Decrypt.

Parameters
TypeNameDescription
google.cloud.kms.v1.IDecryptRequestrequest

DecryptRequest message or plain object

google.cloud.kms.v1.KeyManagementService.DecryptCallbackcallback

Node-style callback called with the error, if any, and DecryptResponse

Returns
TypeDescription
void

decrypt(request)

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

Calls Decrypt.

Parameter
TypeNameDescription
google.cloud.kms.v1.IDecryptRequestrequest

DecryptRequest message or plain object

Returns
TypeDescription
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
TypeNameDescription
google.cloud.kms.v1.IDestroyCryptoKeyVersionRequestrequest

DestroyCryptoKeyVersionRequest message or plain object

google.cloud.kms.v1.KeyManagementService.DestroyCryptoKeyVersionCallbackcallback

Node-style callback called with the error, if any, and CryptoKeyVersion

Returns
TypeDescription
void

destroyCryptoKeyVersion(request)

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

Calls DestroyCryptoKeyVersion.

Parameter
TypeNameDescription
google.cloud.kms.v1.IDestroyCryptoKeyVersionRequestrequest

DestroyCryptoKeyVersionRequest message or plain object

Returns
TypeDescription
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
TypeNameDescription
google.cloud.kms.v1.IEncryptRequestrequest

EncryptRequest message or plain object

google.cloud.kms.v1.KeyManagementService.EncryptCallbackcallback

Node-style callback called with the error, if any, and EncryptResponse

Returns
TypeDescription
void

encrypt(request)

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

Calls Encrypt.

Parameter
TypeNameDescription
google.cloud.kms.v1.IEncryptRequestrequest

EncryptRequest message or plain object

Returns
TypeDescription
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
TypeNameDescription
IGenerateRandomBytesRequestrequest

GenerateRandomBytesRequest message or plain object

google.cloud.kms.v1.KeyManagementService.GenerateRandomBytesCallbackcallback

Node-style callback called with the error, if any, and GenerateRandomBytesResponse

Returns
TypeDescription
void

generateRandomBytes(request)

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

Calls GenerateRandomBytes.

Parameter
TypeNameDescription
IGenerateRandomBytesRequestrequest

GenerateRandomBytesRequest message or plain object

Returns
TypeDescription
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
TypeNameDescription
google.cloud.kms.v1.IGetCryptoKeyRequestrequest

GetCryptoKeyRequest message or plain object

google.cloud.kms.v1.KeyManagementService.GetCryptoKeyCallbackcallback

Node-style callback called with the error, if any, and CryptoKey

Returns
TypeDescription
void

getCryptoKey(request)

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

Calls GetCryptoKey.

Parameter
TypeNameDescription
google.cloud.kms.v1.IGetCryptoKeyRequestrequest

GetCryptoKeyRequest message or plain object

Returns
TypeDescription
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
TypeNameDescription
google.cloud.kms.v1.IGetCryptoKeyVersionRequestrequest

GetCryptoKeyVersionRequest message or plain object

google.cloud.kms.v1.KeyManagementService.GetCryptoKeyVersionCallbackcallback

Node-style callback called with the error, if any, and CryptoKeyVersion

Returns
TypeDescription
void

getCryptoKeyVersion(request)

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

Calls GetCryptoKeyVersion.

Parameter
TypeNameDescription
google.cloud.kms.v1.IGetCryptoKeyVersionRequestrequest

GetCryptoKeyVersionRequest message or plain object

Returns
TypeDescription
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
TypeNameDescription
IGetImportJobRequestrequest

GetImportJobRequest message or plain object

google.cloud.kms.v1.KeyManagementService.GetImportJobCallbackcallback

Node-style callback called with the error, if any, and ImportJob

Returns
TypeDescription
void

getImportJob(request)

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

Calls GetImportJob.

Parameter
TypeNameDescription
IGetImportJobRequestrequest

GetImportJobRequest message or plain object

Returns
TypeDescription
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
TypeNameDescription
IGetKeyRingRequestrequest

GetKeyRingRequest message or plain object

google.cloud.kms.v1.KeyManagementService.GetKeyRingCallbackcallback

Node-style callback called with the error, if any, and KeyRing

Returns
TypeDescription
void

getKeyRing(request)

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

Calls GetKeyRing.

Parameter
TypeNameDescription
IGetKeyRingRequestrequest

GetKeyRingRequest message or plain object

Returns
TypeDescription
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
TypeNameDescription
google.cloud.kms.v1.IGetPublicKeyRequestrequest

GetPublicKeyRequest message or plain object

google.cloud.kms.v1.KeyManagementService.GetPublicKeyCallbackcallback

Node-style callback called with the error, if any, and PublicKey

Returns
TypeDescription
void

getPublicKey(request)

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

Calls GetPublicKey.

Parameter
TypeNameDescription
google.cloud.kms.v1.IGetPublicKeyRequestrequest

GetPublicKeyRequest message or plain object

Returns
TypeDescription
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
TypeNameDescription
IImportCryptoKeyVersionRequestrequest

ImportCryptoKeyVersionRequest message or plain object

google.cloud.kms.v1.KeyManagementService.ImportCryptoKeyVersionCallbackcallback

Node-style callback called with the error, if any, and CryptoKeyVersion

Returns
TypeDescription
void

importCryptoKeyVersion(request)

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

Calls ImportCryptoKeyVersion.

Parameter
TypeNameDescription
IImportCryptoKeyVersionRequestrequest

ImportCryptoKeyVersionRequest message or plain object

Returns
TypeDescription
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
TypeNameDescription
IListCryptoKeysRequestrequest

ListCryptoKeysRequest message or plain object

google.cloud.kms.v1.KeyManagementService.ListCryptoKeysCallbackcallback

Node-style callback called with the error, if any, and ListCryptoKeysResponse

Returns
TypeDescription
void

listCryptoKeys(request)

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

Calls ListCryptoKeys.

Parameter
TypeNameDescription
IListCryptoKeysRequestrequest

ListCryptoKeysRequest message or plain object

Returns
TypeDescription
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
TypeNameDescription
google.cloud.kms.v1.IListCryptoKeyVersionsRequestrequest

ListCryptoKeyVersionsRequest message or plain object

google.cloud.kms.v1.KeyManagementService.ListCryptoKeyVersionsCallbackcallback

Node-style callback called with the error, if any, and ListCryptoKeyVersionsResponse

Returns
TypeDescription
void

listCryptoKeyVersions(request)

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

Calls ListCryptoKeyVersions.

Parameter
TypeNameDescription
google.cloud.kms.v1.IListCryptoKeyVersionsRequestrequest

ListCryptoKeyVersionsRequest message or plain object

Returns
TypeDescription
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
TypeNameDescription
IListImportJobsRequestrequest

ListImportJobsRequest message or plain object

google.cloud.kms.v1.KeyManagementService.ListImportJobsCallbackcallback

Node-style callback called with the error, if any, and ListImportJobsResponse

Returns
TypeDescription
void

listImportJobs(request)

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

Calls ListImportJobs.

Parameter
TypeNameDescription
IListImportJobsRequestrequest

ListImportJobsRequest message or plain object

Returns
TypeDescription
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
TypeNameDescription
google.cloud.kms.v1.IListKeyRingsRequestrequest

ListKeyRingsRequest message or plain object

google.cloud.kms.v1.KeyManagementService.ListKeyRingsCallbackcallback

Node-style callback called with the error, if any, and ListKeyRingsResponse

Returns
TypeDescription
void

listKeyRings(request)

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

Calls ListKeyRings.

Parameter
TypeNameDescription
google.cloud.kms.v1.IListKeyRingsRequestrequest

ListKeyRingsRequest message or plain object

Returns
TypeDescription
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
TypeNameDescription
IMacSignRequestrequest

MacSignRequest message or plain object

google.cloud.kms.v1.KeyManagementService.MacSignCallbackcallback

Node-style callback called with the error, if any, and MacSignResponse

Returns
TypeDescription
void

macSign(request)

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

Calls MacSign.

Parameter
TypeNameDescription
IMacSignRequestrequest

MacSignRequest message or plain object

Returns
TypeDescription
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
TypeNameDescription
google.cloud.kms.v1.IMacVerifyRequestrequest

MacVerifyRequest message or plain object

google.cloud.kms.v1.KeyManagementService.MacVerifyCallbackcallback

Node-style callback called with the error, if any, and MacVerifyResponse

Returns
TypeDescription
void

macVerify(request)

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

Calls MacVerify.

Parameter
TypeNameDescription
google.cloud.kms.v1.IMacVerifyRequestrequest

MacVerifyRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.kms.v1.MacVerifyResponse>

Promise

restoreCryptoKeyVersion(request, callback)

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

Calls RestoreCryptoKeyVersion.

Parameters
TypeNameDescription
IRestoreCryptoKeyVersionRequestrequest

RestoreCryptoKeyVersionRequest message or plain object

google.cloud.kms.v1.KeyManagementService.RestoreCryptoKeyVersionCallbackcallback

Node-style callback called with the error, if any, and CryptoKeyVersion

Returns
TypeDescription
void

restoreCryptoKeyVersion(request)

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

Calls RestoreCryptoKeyVersion.

Parameter
TypeNameDescription
IRestoreCryptoKeyVersionRequestrequest

RestoreCryptoKeyVersionRequest message or plain object

Returns
TypeDescription
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
TypeNameDescription
IUpdateCryptoKeyRequestrequest

UpdateCryptoKeyRequest message or plain object

google.cloud.kms.v1.KeyManagementService.UpdateCryptoKeyCallbackcallback

Node-style callback called with the error, if any, and CryptoKey

Returns
TypeDescription
void

updateCryptoKey(request)

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

Calls UpdateCryptoKey.

Parameter
TypeNameDescription
IUpdateCryptoKeyRequestrequest

UpdateCryptoKeyRequest message or plain object

Returns
TypeDescription
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
TypeNameDescription
google.cloud.kms.v1.IUpdateCryptoKeyPrimaryVersionRequestrequest

UpdateCryptoKeyPrimaryVersionRequest message or plain object

google.cloud.kms.v1.KeyManagementService.UpdateCryptoKeyPrimaryVersionCallbackcallback

Node-style callback called with the error, if any, and CryptoKey

Returns
TypeDescription
void

updateCryptoKeyPrimaryVersion(request)

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

Calls UpdateCryptoKeyPrimaryVersion.

Parameter
TypeNameDescription
google.cloud.kms.v1.IUpdateCryptoKeyPrimaryVersionRequestrequest

UpdateCryptoKeyPrimaryVersionRequest message or plain object

Returns
TypeDescription
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
TypeNameDescription
google.cloud.kms.v1.IUpdateCryptoKeyVersionRequestrequest

UpdateCryptoKeyVersionRequest message or plain object

google.cloud.kms.v1.KeyManagementService.UpdateCryptoKeyVersionCallbackcallback

Node-style callback called with the error, if any, and CryptoKeyVersion

Returns
TypeDescription
void

updateCryptoKeyVersion(request)

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

Calls UpdateCryptoKeyVersion.

Parameter
TypeNameDescription
google.cloud.kms.v1.IUpdateCryptoKeyVersionRequestrequest

UpdateCryptoKeyVersionRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.kms.v1.CryptoKeyVersion>

Promise