Google Cloud Key Management Service
Manages cryptographic keys and operations using those keys. Implements a REST model with the following objects:
* * * *
If you are using manual gRPC libraries, see [Using gRPC with Cloud KMS]( https://cloud.google.com/kms/docs/grpc
). v1
Package
@google-cloud/kms
Constructors
(constructor)(opts)
constructor
(
opts
?:
ClientOptions
);
Construct an instance of KeyManagementServiceClient.
Parameter
Properties
apiEndpoint
static
get
apiEndpoint
()
:
string
;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
Property Value
auth
auth
:
gax
.
GoogleAuth
;
Property Value
descriptors
descriptors
:
Descriptors
;
Property Value
iamClient
Property Value
innerApiCalls
innerApiCalls
:
{
[
name
:
string
]
:
Function
;
};
Property Value
keyManagementServiceStub
keyManagementServiceStub
?:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
Property Value
pathTemplates
pathTemplates
:
{
[
name
:
string
]
:
gax
.
PathTemplate
;
};
Property Value
port
static
get
port
()
:
number
;
The port for this API service.
Property Value
scopes
static
get
scopes
()
:
string
[];
The scopes needed to make gRPC calls for every method defined in this service.
Property Value
servicePath
static
get
servicePath
()
:
string
;
The DNS address for this API service.
Property Value
warn
warn
:
(
code
:
string
,
message
:
string
,
warnType
?:
string
)
=
>
void
;
Property Value
Methods
asymmetricDecrypt(request, options)
asymmetricDecrypt
(
request
?:
protos
.
google
.
cloud
.
kms
.
v1
.
IAsymmetricDecryptRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
kms
.
v1
.
IAsymmetricDecryptResponse
,
protos
.
google
.
cloud
.
kms
.
v1
.
IAsymmetricDecryptRequest
|
undefined
,
{}
|
undefined
]>;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IAsymmetricDecryptRequest
|
| options |
CallOptions
|
Returns
asymmetricDecrypt(request, options, callback)
asymmetricDecrypt
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IAsymmetricDecryptRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
IAsymmetricDecryptResponse
,
protos
.
google
.
cloud
.
kms
.
v1
.
IAsymmetricDecryptRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IAsymmetricDecryptRequest
|
| options |
CallOptions
|
| callback |
Callback
<protos. google.cloud.kms.v1.IAsymmetricDecryptResponse
, protos. google.cloud.kms.v1.IAsymmetricDecryptRequest
| null | undefined, {} | null | undefined>
|
Returns
asymmetricDecrypt(request, callback)
asymmetricDecrypt
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IAsymmetricDecryptRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
IAsymmetricDecryptResponse
,
protos
.
google
.
cloud
.
kms
.
v1
.
IAsymmetricDecryptRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IAsymmetricDecryptRequest
|
| callback |
Callback
<protos. google.cloud.kms.v1.IAsymmetricDecryptResponse
, protos. google.cloud.kms.v1.IAsymmetricDecryptRequest
| null | undefined, {} | null | undefined>
|
Returns
asymmetricSign(request, options)
asymmetricSign
(
request
?:
protos
.
google
.
cloud
.
kms
.
v1
.
IAsymmetricSignRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
kms
.
v1
.
IAsymmetricSignResponse
,
protos
.
google
.
cloud
.
kms
.
v1
.
IAsymmetricSignRequest
|
undefined
,
{}
|
undefined
]>;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IAsymmetricSignRequest
|
| options |
CallOptions
|
Returns
asymmetricSign(request, options, callback)
asymmetricSign
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IAsymmetricSignRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
IAsymmetricSignResponse
,
protos
.
google
.
cloud
.
kms
.
v1
.
IAsymmetricSignRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IAsymmetricSignRequest
|
| options |
CallOptions
|
| callback |
Callback
<protos. google.cloud.kms.v1.IAsymmetricSignResponse
, protos. google.cloud.kms.v1.IAsymmetricSignRequest
| null | undefined, {} | null | undefined>
|
Returns
asymmetricSign(request, callback)
asymmetricSign
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IAsymmetricSignRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
IAsymmetricSignResponse
,
protos
.
google
.
cloud
.
kms
.
v1
.
IAsymmetricSignRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IAsymmetricSignRequest
|
| callback |
Callback
<protos. google.cloud.kms.v1.IAsymmetricSignResponse
, protos. google.cloud.kms.v1.IAsymmetricSignRequest
| null | undefined, {} | null | undefined>
|
Returns
close()
close
()
:
Promise<void>
;
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Returns | Type |
Description |
| Promise
<void> |
{Promise} A promise that resolves when the client is closed.
|
createCryptoKey(request, options)
createCryptoKey
(
request
?:
protos
.
google
.
cloud
.
kms
.
v1
.
ICreateCryptoKeyRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
kms
.
v1
.
ICryptoKey
,
protos
.
google
.
cloud
.
kms
.
v1
.
ICreateCryptoKeyRequest
|
undefined
,
{}
|
undefined
]>;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.ICreateCryptoKeyRequest
|
| options |
CallOptions
|
Returns
createCryptoKey(request, options, callback)
createCryptoKey
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
ICreateCryptoKeyRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
ICryptoKey
,
protos
.
google
.
cloud
.
kms
.
v1
.
ICreateCryptoKeyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.ICreateCryptoKeyRequest
|
| options |
CallOptions
|
| callback |
Callback
<protos. google.cloud.kms.v1.ICryptoKey
, protos. google.cloud.kms.v1.ICreateCryptoKeyRequest
| null | undefined, {} | null | undefined>
|
Returns
createCryptoKey(request, callback)
createCryptoKey
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
ICreateCryptoKeyRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
ICryptoKey
,
protos
.
google
.
cloud
.
kms
.
v1
.
ICreateCryptoKeyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.ICreateCryptoKeyRequest
|
| callback |
Callback
<protos. google.cloud.kms.v1.ICryptoKey
, protos. google.cloud.kms.v1.ICreateCryptoKeyRequest
| null | undefined, {} | null | undefined>
|
Returns
createCryptoKeyVersion(request, options)
createCryptoKeyVersion
(
request
?:
protos
.
google
.
cloud
.
kms
.
v1
.
ICreateCryptoKeyVersionRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
kms
.
v1
.
ICryptoKeyVersion
,
protos
.
google
.
cloud
.
kms
.
v1
.
ICreateCryptoKeyVersionRequest
|
undefined
,
{}
|
undefined
]>;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.ICreateCryptoKeyVersionRequest
|
| options |
CallOptions
|
Returns
createCryptoKeyVersion(request, options, callback)
createCryptoKeyVersion
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
ICreateCryptoKeyVersionRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
ICryptoKeyVersion
,
protos
.
google
.
cloud
.
kms
.
v1
.
ICreateCryptoKeyVersionRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.ICreateCryptoKeyVersionRequest
|
| options |
CallOptions
|
| callback |
Callback
<protos. google.cloud.kms.v1.ICryptoKeyVersion
, protos. google.cloud.kms.v1.ICreateCryptoKeyVersionRequest
| null | undefined, {} | null | undefined>
|
Returns
createCryptoKeyVersion(request, callback)
createCryptoKeyVersion
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
ICreateCryptoKeyVersionRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
ICryptoKeyVersion
,
protos
.
google
.
cloud
.
kms
.
v1
.
ICreateCryptoKeyVersionRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.ICreateCryptoKeyVersionRequest
|
| callback |
Callback
<protos. google.cloud.kms.v1.ICryptoKeyVersion
, protos. google.cloud.kms.v1.ICreateCryptoKeyVersionRequest
| null | undefined, {} | null | undefined>
|
Returns
createImportJob(request, options)
createImportJob
(
request
?:
protos
.
google
.
cloud
.
kms
.
v1
.
ICreateImportJobRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
kms
.
v1
.
IImportJob
,
protos
.
google
.
cloud
.
kms
.
v1
.
ICreateImportJobRequest
|
undefined
,
{}
|
undefined
]>;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.ICreateImportJobRequest
|
| options |
CallOptions
|
Returns
createImportJob(request, options, callback)
createImportJob
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
ICreateImportJobRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
IImportJob
,
protos
.
google
.
cloud
.
kms
.
v1
.
ICreateImportJobRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.ICreateImportJobRequest
|
| options |
CallOptions
|
| callback |
Callback
<protos. google.cloud.kms.v1.IImportJob
, protos. google.cloud.kms.v1.ICreateImportJobRequest
| null | undefined, {} | null | undefined>
|
Returns
createImportJob(request, callback)
createImportJob
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
ICreateImportJobRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
IImportJob
,
protos
.
google
.
cloud
.
kms
.
v1
.
ICreateImportJobRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.ICreateImportJobRequest
|
| callback |
Callback
<protos. google.cloud.kms.v1.IImportJob
, protos. google.cloud.kms.v1.ICreateImportJobRequest
| null | undefined, {} | null | undefined>
|
Returns
createKeyRing(request, options)
createKeyRing
(
request
?:
protos
.
google
.
cloud
.
kms
.
v1
.
ICreateKeyRingRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
kms
.
v1
.
IKeyRing
,
protos
.
google
.
cloud
.
kms
.
v1
.
ICreateKeyRingRequest
|
undefined
,
{}
|
undefined
]>;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.ICreateKeyRingRequest
|
| options |
CallOptions
|
Returns
createKeyRing(request, options, callback)
createKeyRing
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
ICreateKeyRingRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
IKeyRing
,
protos
.
google
.
cloud
.
kms
.
v1
.
ICreateKeyRingRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.ICreateKeyRingRequest
|
| options |
CallOptions
|
| callback |
Callback
<protos. google.cloud.kms.v1.IKeyRing
, protos. google.cloud.kms.v1.ICreateKeyRingRequest
| null | undefined, {} | null | undefined>
|
Returns
createKeyRing(request, callback)
createKeyRing
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
ICreateKeyRingRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
IKeyRing
,
protos
.
google
.
cloud
.
kms
.
v1
.
ICreateKeyRingRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.ICreateKeyRingRequest
|
| callback |
Callback
<protos. google.cloud.kms.v1.IKeyRing
, protos. google.cloud.kms.v1.ICreateKeyRingRequest
| null | undefined, {} | null | undefined>
|
Returns
cryptoKeyPath(project, location, keyRing, cryptoKey)
cryptoKeyPath
(
project
:
string
,
location
:
string
,
keyRing
:
string
,
cryptoKey
:
string
)
:
string
;
Return a fully-qualified cryptoKey resource name string.
Parameters
Returns | Type |
Description |
| string
|
{string} Resource name string.
|
cryptoKeyVersionPath(project, location, keyRing, cryptoKey, cryptoKeyVersion)
cryptoKeyVersionPath
(
project
:
string
,
location
:
string
,
keyRing
:
string
,
cryptoKey
:
string
,
cryptoKeyVersion
:
string
)
:
string
;
Return a fully-qualified cryptoKeyVersion resource name string.
Parameters
Returns | Type |
Description |
| string
|
{string} Resource name string.
|
decrypt(request, options)
decrypt
(
request
?:
protos
.
google
.
cloud
.
kms
.
v1
.
IDecryptRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
kms
.
v1
.
IDecryptResponse
,
protos
.
google
.
cloud
.
kms
.
v1
.
IDecryptRequest
|
undefined
,
{}
|
undefined
]>;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IDecryptRequest
|
| options |
CallOptions
|
Returns
decrypt(request, options, callback)
decrypt
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IDecryptRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
IDecryptResponse
,
protos
.
google
.
cloud
.
kms
.
v1
.
IDecryptRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IDecryptRequest
|
| options |
CallOptions
|
| callback |
Callback
<protos. google.cloud.kms.v1.IDecryptResponse
, protos. google.cloud.kms.v1.IDecryptRequest
| null | undefined, {} | null | undefined>
|
Returns
decrypt(request, callback)
decrypt
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IDecryptRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
IDecryptResponse
,
protos
.
google
.
cloud
.
kms
.
v1
.
IDecryptRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IDecryptRequest
|
| callback |
Callback
<protos. google.cloud.kms.v1.IDecryptResponse
, protos. google.cloud.kms.v1.IDecryptRequest
| null | undefined, {} | null | undefined>
|
Returns
destroyCryptoKeyVersion(request, options)
destroyCryptoKeyVersion
(
request
?:
protos
.
google
.
cloud
.
kms
.
v1
.
IDestroyCryptoKeyVersionRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
kms
.
v1
.
ICryptoKeyVersion
,
protos
.
google
.
cloud
.
kms
.
v1
.
IDestroyCryptoKeyVersionRequest
|
undefined
,
{}
|
undefined
]>;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IDestroyCryptoKeyVersionRequest
|
| options |
CallOptions
|
Returns
destroyCryptoKeyVersion(request, options, callback)
destroyCryptoKeyVersion
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IDestroyCryptoKeyVersionRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
ICryptoKeyVersion
,
protos
.
google
.
cloud
.
kms
.
v1
.
IDestroyCryptoKeyVersionRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IDestroyCryptoKeyVersionRequest
|
| options |
CallOptions
|
| callback |
Callback
<protos. google.cloud.kms.v1.ICryptoKeyVersion
, protos. google.cloud.kms.v1.IDestroyCryptoKeyVersionRequest
| null | undefined, {} | null | undefined>
|
Returns
destroyCryptoKeyVersion(request, callback)
destroyCryptoKeyVersion
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IDestroyCryptoKeyVersionRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
ICryptoKeyVersion
,
protos
.
google
.
cloud
.
kms
.
v1
.
IDestroyCryptoKeyVersionRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IDestroyCryptoKeyVersionRequest
|
| callback |
Callback
<protos. google.cloud.kms.v1.ICryptoKeyVersion
, protos. google.cloud.kms.v1.IDestroyCryptoKeyVersionRequest
| null | undefined, {} | null | undefined>
|
Returns
encrypt(request, options)
encrypt
(
request
?:
protos
.
google
.
cloud
.
kms
.
v1
.
IEncryptRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
kms
.
v1
.
IEncryptResponse
,
protos
.
google
.
cloud
.
kms
.
v1
.
IEncryptRequest
|
undefined
,
{}
|
undefined
]>;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IEncryptRequest
|
| options |
CallOptions
|
Returns
encrypt(request, options, callback)
encrypt
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IEncryptRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
IEncryptResponse
,
protos
.
google
.
cloud
.
kms
.
v1
.
IEncryptRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IEncryptRequest
|
| options |
CallOptions
|
| callback |
Callback
<protos. google.cloud.kms.v1.IEncryptResponse
, protos. google.cloud.kms.v1.IEncryptRequest
| null | undefined, {} | null | undefined>
|
Returns
encrypt(request, callback)
encrypt
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IEncryptRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
IEncryptResponse
,
protos
.
google
.
cloud
.
kms
.
v1
.
IEncryptRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IEncryptRequest
|
| callback |
Callback
<protos. google.cloud.kms.v1.IEncryptResponse
, protos. google.cloud.kms.v1.IEncryptRequest
| null | undefined, {} | null | undefined>
|
Returns
generateRandomBytes(request, options)
generateRandomBytes
(
request
?:
protos
.
google
.
cloud
.
kms
.
v1
.
IGenerateRandomBytesRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
kms
.
v1
.
IGenerateRandomBytesResponse
,
protos
.
google
.
cloud
.
kms
.
v1
.
IGenerateRandomBytesRequest
|
undefined
,
{}
|
undefined
]>;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IGenerateRandomBytesRequest
|
| options |
CallOptions
|
Returns
generateRandomBytes(request, options, callback)
generateRandomBytes
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IGenerateRandomBytesRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
IGenerateRandomBytesResponse
,
protos
.
google
.
cloud
.
kms
.
v1
.
IGenerateRandomBytesRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IGenerateRandomBytesRequest
|
| options |
CallOptions
|
| callback |
Callback
<protos. google.cloud.kms.v1.IGenerateRandomBytesResponse
, protos. google.cloud.kms.v1.IGenerateRandomBytesRequest
| null | undefined, {} | null | undefined>
|
Returns
generateRandomBytes(request, callback)
generateRandomBytes
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IGenerateRandomBytesRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
IGenerateRandomBytesResponse
,
protos
.
google
.
cloud
.
kms
.
v1
.
IGenerateRandomBytesRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IGenerateRandomBytesRequest
|
| callback |
Callback
<protos. google.cloud.kms.v1.IGenerateRandomBytesResponse
, protos. google.cloud.kms.v1.IGenerateRandomBytesRequest
| null | undefined, {} | null | undefined>
|
Returns
getCryptoKey(request, options)
getCryptoKey
(
request
?:
protos
.
google
.
cloud
.
kms
.
v1
.
IGetCryptoKeyRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
kms
.
v1
.
ICryptoKey
,
protos
.
google
.
cloud
.
kms
.
v1
.
IGetCryptoKeyRequest
|
undefined
,
{}
|
undefined
]>;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IGetCryptoKeyRequest
|
| options |
CallOptions
|
Returns
getCryptoKey(request, options, callback)
getCryptoKey
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IGetCryptoKeyRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
ICryptoKey
,
protos
.
google
.
cloud
.
kms
.
v1
.
IGetCryptoKeyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IGetCryptoKeyRequest
|
| options |
CallOptions
|
| callback |
Callback
<protos. google.cloud.kms.v1.ICryptoKey
, protos. google.cloud.kms.v1.IGetCryptoKeyRequest
| null | undefined, {} | null | undefined>
|
Returns
getCryptoKey(request, callback)
getCryptoKey
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IGetCryptoKeyRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
ICryptoKey
,
protos
.
google
.
cloud
.
kms
.
v1
.
IGetCryptoKeyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IGetCryptoKeyRequest
|
| callback |
Callback
<protos. google.cloud.kms.v1.ICryptoKey
, protos. google.cloud.kms.v1.IGetCryptoKeyRequest
| null | undefined, {} | null | undefined>
|
Returns
getCryptoKeyVersion(request, options)
getCryptoKeyVersion
(
request
?:
protos
.
google
.
cloud
.
kms
.
v1
.
IGetCryptoKeyVersionRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
kms
.
v1
.
ICryptoKeyVersion
,
protos
.
google
.
cloud
.
kms
.
v1
.
IGetCryptoKeyVersionRequest
|
undefined
,
{}
|
undefined
]>;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IGetCryptoKeyVersionRequest
|
| options |
CallOptions
|
Returns
getCryptoKeyVersion(request, options, callback)
getCryptoKeyVersion
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IGetCryptoKeyVersionRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
ICryptoKeyVersion
,
protos
.
google
.
cloud
.
kms
.
v1
.
IGetCryptoKeyVersionRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IGetCryptoKeyVersionRequest
|
| options |
CallOptions
|
| callback |
Callback
<protos. google.cloud.kms.v1.ICryptoKeyVersion
, protos. google.cloud.kms.v1.IGetCryptoKeyVersionRequest
| null | undefined, {} | null | undefined>
|
Returns
getCryptoKeyVersion(request, callback)
getCryptoKeyVersion
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IGetCryptoKeyVersionRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
ICryptoKeyVersion
,
protos
.
google
.
cloud
.
kms
.
v1
.
IGetCryptoKeyVersionRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IGetCryptoKeyVersionRequest
|
| callback |
Callback
<protos. google.cloud.kms.v1.ICryptoKeyVersion
, protos. google.cloud.kms.v1.IGetCryptoKeyVersionRequest
| null | undefined, {} | null | undefined>
|
Returns
getIamPolicy(request, options, callback)
getIamPolicy
(
request
:
IamProtos
.
google
.
iam
.
v1
.
GetIamPolicyRequest
,
options
?:
gax
.
CallOptions
|
Callback<IamProtos
.
google
.
iam
.
v1
.
Policy
,
IamProtos
.
google
.
iam
.
v1
.
GetIamPolicyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<IamProtos
.
google
.
iam
.
v1
.
Policy
,
IamProtos
.
google
.
iam
.
v1
.
GetIamPolicyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
Promise<IamProtos
.
google
.
iam
.
v1
.
Policy
> ;
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters | Name |
Description |
| request |
IamProtos. google.iam.v1.GetIamPolicyRequest
The request object that will be sent.
|
| options |
gax. CallOptions
| Callback
<IamProtos. google.iam.v1.Policy
, IamProtos. google.iam.v1.GetIamPolicyRequest
| null | undefined, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See [gax.CallOptions] https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html
for the details.
|
| callback |
Callback
<IamProtos. google.iam.v1.Policy
, IamProtos. google.iam.v1.GetIamPolicyRequest
| null | undefined, {} | null | undefined>
The function which will be called with the result of the API call.
The second parameter to the callback is an object representing [Policy].
|
Returns | Type |
Description |
| Promise
<IamProtos. google.iam.v1.Policy
> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Policy]. The promise has a method named "cancel" which cancels the ongoing API call.
|
getImportJob(request, options)
getImportJob
(
request
?:
protos
.
google
.
cloud
.
kms
.
v1
.
IGetImportJobRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
kms
.
v1
.
IImportJob
,
protos
.
google
.
cloud
.
kms
.
v1
.
IGetImportJobRequest
|
undefined
,
{}
|
undefined
]>;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IGetImportJobRequest
|
| options |
CallOptions
|
Returns
getImportJob(request, options, callback)
getImportJob
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IGetImportJobRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
IImportJob
,
protos
.
google
.
cloud
.
kms
.
v1
.
IGetImportJobRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IGetImportJobRequest
|
| options |
CallOptions
|
| callback |
Callback
<protos. google.cloud.kms.v1.IImportJob
, protos. google.cloud.kms.v1.IGetImportJobRequest
| null | undefined, {} | null | undefined>
|
Returns
getImportJob(request, callback)
getImportJob
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IGetImportJobRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
IImportJob
,
protos
.
google
.
cloud
.
kms
.
v1
.
IGetImportJobRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IGetImportJobRequest
|
| callback |
Callback
<protos. google.cloud.kms.v1.IImportJob
, protos. google.cloud.kms.v1.IGetImportJobRequest
| null | undefined, {} | null | undefined>
|
Returns
getKeyRing(request, options)
getKeyRing
(
request
?:
protos
.
google
.
cloud
.
kms
.
v1
.
IGetKeyRingRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
kms
.
v1
.
IKeyRing
,
protos
.
google
.
cloud
.
kms
.
v1
.
IGetKeyRingRequest
|
undefined
,
{}
|
undefined
]>;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IGetKeyRingRequest
|
| options |
CallOptions
|
Returns
getKeyRing(request, options, callback)
getKeyRing
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IGetKeyRingRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
IKeyRing
,
protos
.
google
.
cloud
.
kms
.
v1
.
IGetKeyRingRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IGetKeyRingRequest
|
| options |
CallOptions
|
| callback |
Callback
<protos. google.cloud.kms.v1.IKeyRing
, protos. google.cloud.kms.v1.IGetKeyRingRequest
| null | undefined, {} | null | undefined>
|
Returns
getKeyRing(request, callback)
getKeyRing
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IGetKeyRingRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
IKeyRing
,
protos
.
google
.
cloud
.
kms
.
v1
.
IGetKeyRingRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IGetKeyRingRequest
|
| callback |
Callback
<protos. google.cloud.kms.v1.IKeyRing
, protos. google.cloud.kms.v1.IGetKeyRingRequest
| null | undefined, {} | null | undefined>
|
Returns
getProjectId()
getProjectId
()
:
Promise<string>
;
Returns
getProjectId(callback)
getProjectId
(
callback
:
Callback<string
,
undefined
,
undefined
> )
:
void
;
Parameter | Name |
Description |
| callback |
Callback
<string, undefined, undefined>
|
Returns
getPublicKey(request, options)
getPublicKey
(
request
?:
protos
.
google
.
cloud
.
kms
.
v1
.
IGetPublicKeyRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
kms
.
v1
.
IPublicKey
,
protos
.
google
.
cloud
.
kms
.
v1
.
IGetPublicKeyRequest
|
undefined
,
{}
|
undefined
]>;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IGetPublicKeyRequest
|
| options |
CallOptions
|
Returns
getPublicKey(request, options, callback)
getPublicKey
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IGetPublicKeyRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
IPublicKey
,
protos
.
google
.
cloud
.
kms
.
v1
.
IGetPublicKeyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IGetPublicKeyRequest
|
| options |
CallOptions
|
| callback |
Callback
<protos. google.cloud.kms.v1.IPublicKey
, protos. google.cloud.kms.v1.IGetPublicKeyRequest
| null | undefined, {} | null | undefined>
|
Returns
getPublicKey(request, callback)
getPublicKey
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IGetPublicKeyRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
IPublicKey
,
protos
.
google
.
cloud
.
kms
.
v1
.
IGetPublicKeyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IGetPublicKeyRequest
|
| callback |
Callback
<protos. google.cloud.kms.v1.IPublicKey
, protos. google.cloud.kms.v1.IGetPublicKeyRequest
| null | undefined, {} | null | undefined>
|
Returns
importCryptoKeyVersion(request, options)
importCryptoKeyVersion
(
request
?:
protos
.
google
.
cloud
.
kms
.
v1
.
IImportCryptoKeyVersionRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
kms
.
v1
.
ICryptoKeyVersion
,
protos
.
google
.
cloud
.
kms
.
v1
.
IImportCryptoKeyVersionRequest
|
undefined
,
{}
|
undefined
]>;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IImportCryptoKeyVersionRequest
|
| options |
CallOptions
|
Returns
importCryptoKeyVersion(request, options, callback)
importCryptoKeyVersion
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IImportCryptoKeyVersionRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
ICryptoKeyVersion
,
protos
.
google
.
cloud
.
kms
.
v1
.
IImportCryptoKeyVersionRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IImportCryptoKeyVersionRequest
|
| options |
CallOptions
|
| callback |
Callback
<protos. google.cloud.kms.v1.ICryptoKeyVersion
, protos. google.cloud.kms.v1.IImportCryptoKeyVersionRequest
| null | undefined, {} | null | undefined>
|
Returns
importCryptoKeyVersion(request, callback)
importCryptoKeyVersion
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IImportCryptoKeyVersionRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
ICryptoKeyVersion
,
protos
.
google
.
cloud
.
kms
.
v1
.
IImportCryptoKeyVersionRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IImportCryptoKeyVersionRequest
|
| callback |
Callback
<protos. google.cloud.kms.v1.ICryptoKeyVersion
, protos. google.cloud.kms.v1.IImportCryptoKeyVersionRequest
| null | undefined, {} | null | undefined>
|
Returns
importJobPath(project, location, keyRing, importJob)
importJobPath
(
project
:
string
,
location
:
string
,
keyRing
:
string
,
importJob
:
string
)
:
string
;
Return a fully-qualified importJob resource name string.
Parameters
Returns | Type |
Description |
| string
|
{string} Resource name string.
|
initialize()
initialize
()
:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
Returns | Type |
Description |
| Promise
<{
[name: string]: Function
;
}> |
{Promise} A promise that resolves to an authenticated service stub.
|
keyRingPath(project, location, keyRing)
keyRingPath
(
project
:
string
,
location
:
string
,
keyRing
:
string
)
:
string
;
Return a fully-qualified keyRing resource name string.
Parameters
Returns | Type |
Description |
| string
|
{string} Resource name string.
|
listCryptoKeys(request, options)
listCryptoKeys
(
request
?:
protos
.
google
.
cloud
.
kms
.
v1
.
IListCryptoKeysRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
kms
.
v1
.
ICryptoKey
[],
protos
.
google
.
cloud
.
kms
.
v1
.
IListCryptoKeysRequest
|
null
,
protos
.
google
.
cloud
.
kms
.
v1
.
IListCryptoKeysResponse
]>;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IListCryptoKeysRequest
|
| options |
CallOptions
|
Returns
listCryptoKeys(request, options, callback)
listCryptoKeys
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IListCryptoKeysRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
kms
.
v1
.
IListCryptoKeysRequest
,
protos
.
google
.
cloud
.
kms
.
v1
.
IListCryptoKeysResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
kms
.
v1
.
ICryptoKey
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IListCryptoKeysRequest
|
| options |
CallOptions
|
| callback |
PaginationCallback
<protos. google.cloud.kms.v1.IListCryptoKeysRequest
, protos. google.cloud.kms.v1.IListCryptoKeysResponse
| null | undefined, protos. google.cloud.kms.v1.ICryptoKey
>
|
Returns
listCryptoKeys(request, callback)
listCryptoKeys
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IListCryptoKeysRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
kms
.
v1
.
IListCryptoKeysRequest
,
protos
.
google
.
cloud
.
kms
.
v1
.
IListCryptoKeysResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
kms
.
v1
.
ICryptoKey
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IListCryptoKeysRequest
|
| callback |
PaginationCallback
<protos. google.cloud.kms.v1.IListCryptoKeysRequest
, protos. google.cloud.kms.v1.IListCryptoKeysResponse
| null | undefined, protos. google.cloud.kms.v1.ICryptoKey
>
|
Returns
listCryptoKeysAsync(request, options)
listCryptoKeysAsync
(
request
?:
protos
.
google
.
cloud
.
kms
.
v1
.
IListCryptoKeysRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
kms
.
v1
.
ICryptoKey
> ;
Equivalent to listCryptoKeys
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IListCryptoKeysRequest
The request object that will be sent.
|
| options |
CallOptions
Call options. See CallOptions
for more details.
|
Returns | Type |
Description |
| AsyncIterable
<protos. google.cloud.kms.v1.ICryptoKey
> |
{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [CryptoKey]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listCryptoKeysStream(request, options)
listCryptoKeysStream
(
request
?:
protos
.
google
.
cloud
.
kms
.
v1
.
IListCryptoKeysRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IListCryptoKeysRequest
The request object that will be sent.
|
| options |
CallOptions
Call options. See CallOptions
for more details.
|
Returns | Type |
Description |
| Transform
|
{Stream} An object stream which emits an object representing [CryptoKey] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listCryptoKeysAsync()
method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listCryptoKeyVersions(request, options)
listCryptoKeyVersions
(
request
?:
protos
.
google
.
cloud
.
kms
.
v1
.
IListCryptoKeyVersionsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
kms
.
v1
.
ICryptoKeyVersion
[],
protos
.
google
.
cloud
.
kms
.
v1
.
IListCryptoKeyVersionsRequest
|
null
,
protos
.
google
.
cloud
.
kms
.
v1
.
IListCryptoKeyVersionsResponse
]>;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IListCryptoKeyVersionsRequest
|
| options |
CallOptions
|
Returns
listCryptoKeyVersions(request, options, callback)
listCryptoKeyVersions
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IListCryptoKeyVersionsRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
kms
.
v1
.
IListCryptoKeyVersionsRequest
,
protos
.
google
.
cloud
.
kms
.
v1
.
IListCryptoKeyVersionsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
kms
.
v1
.
ICryptoKeyVersion
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IListCryptoKeyVersionsRequest
|
| options |
CallOptions
|
| callback |
PaginationCallback
<protos. google.cloud.kms.v1.IListCryptoKeyVersionsRequest
, protos. google.cloud.kms.v1.IListCryptoKeyVersionsResponse
| null | undefined, protos. google.cloud.kms.v1.ICryptoKeyVersion
>
|
Returns
listCryptoKeyVersions(request, callback)
listCryptoKeyVersions
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IListCryptoKeyVersionsRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
kms
.
v1
.
IListCryptoKeyVersionsRequest
,
protos
.
google
.
cloud
.
kms
.
v1
.
IListCryptoKeyVersionsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
kms
.
v1
.
ICryptoKeyVersion
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IListCryptoKeyVersionsRequest
|
| callback |
PaginationCallback
<protos. google.cloud.kms.v1.IListCryptoKeyVersionsRequest
, protos. google.cloud.kms.v1.IListCryptoKeyVersionsResponse
| null | undefined, protos. google.cloud.kms.v1.ICryptoKeyVersion
>
|
Returns
listCryptoKeyVersionsAsync(request, options)
listCryptoKeyVersionsAsync
(
request
?:
protos
.
google
.
cloud
.
kms
.
v1
.
IListCryptoKeyVersionsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
kms
.
v1
.
ICryptoKeyVersion
> ;
Equivalent to listCryptoKeyVersions
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IListCryptoKeyVersionsRequest
The request object that will be sent.
|
| options |
CallOptions
Call options. See CallOptions
for more details.
|
Returns | Type |
Description |
| AsyncIterable
<protos. google.cloud.kms.v1.ICryptoKeyVersion
> |
{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [CryptoKeyVersion]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listCryptoKeyVersionsStream(request, options)
listCryptoKeyVersionsStream
(
request
?:
protos
.
google
.
cloud
.
kms
.
v1
.
IListCryptoKeyVersionsRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IListCryptoKeyVersionsRequest
The request object that will be sent.
|
| options |
CallOptions
Call options. See CallOptions
for more details.
|
Returns | Type |
Description |
| Transform
|
{Stream} An object stream which emits an object representing [CryptoKeyVersion] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listCryptoKeyVersionsAsync()
method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listImportJobs(request, options)
listImportJobs
(
request
?:
protos
.
google
.
cloud
.
kms
.
v1
.
IListImportJobsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
kms
.
v1
.
IImportJob
[],
protos
.
google
.
cloud
.
kms
.
v1
.
IListImportJobsRequest
|
null
,
protos
.
google
.
cloud
.
kms
.
v1
.
IListImportJobsResponse
]>;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IListImportJobsRequest
|
| options |
CallOptions
|
Returns
listImportJobs(request, options, callback)
listImportJobs
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IListImportJobsRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
kms
.
v1
.
IListImportJobsRequest
,
protos
.
google
.
cloud
.
kms
.
v1
.
IListImportJobsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
kms
.
v1
.
IImportJob
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IListImportJobsRequest
|
| options |
CallOptions
|
| callback |
PaginationCallback
<protos. google.cloud.kms.v1.IListImportJobsRequest
, protos. google.cloud.kms.v1.IListImportJobsResponse
| null | undefined, protos. google.cloud.kms.v1.IImportJob
>
|
Returns
listImportJobs(request, callback)
listImportJobs
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IListImportJobsRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
kms
.
v1
.
IListImportJobsRequest
,
protos
.
google
.
cloud
.
kms
.
v1
.
IListImportJobsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
kms
.
v1
.
IImportJob
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IListImportJobsRequest
|
| callback |
PaginationCallback
<protos. google.cloud.kms.v1.IListImportJobsRequest
, protos. google.cloud.kms.v1.IListImportJobsResponse
| null | undefined, protos. google.cloud.kms.v1.IImportJob
>
|
Returns
listImportJobsAsync(request, options)
listImportJobsAsync
(
request
?:
protos
.
google
.
cloud
.
kms
.
v1
.
IListImportJobsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
kms
.
v1
.
IImportJob
> ;
Equivalent to listImportJobs
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IListImportJobsRequest
The request object that will be sent.
|
| options |
CallOptions
Call options. See CallOptions
for more details.
|
Returns | Type |
Description |
| AsyncIterable
<protos. google.cloud.kms.v1.IImportJob
> |
{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [ImportJob]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listImportJobsStream(request, options)
listImportJobsStream
(
request
?:
protos
.
google
.
cloud
.
kms
.
v1
.
IListImportJobsRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IListImportJobsRequest
The request object that will be sent.
|
| options |
CallOptions
Call options. See CallOptions
for more details.
|
Returns | Type |
Description |
| Transform
|
{Stream} An object stream which emits an object representing [ImportJob] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listImportJobsAsync()
method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listKeyRings(request, options)
listKeyRings
(
request
?:
protos
.
google
.
cloud
.
kms
.
v1
.
IListKeyRingsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
kms
.
v1
.
IKeyRing
[],
protos
.
google
.
cloud
.
kms
.
v1
.
IListKeyRingsRequest
|
null
,
protos
.
google
.
cloud
.
kms
.
v1
.
IListKeyRingsResponse
]>;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IListKeyRingsRequest
|
| options |
CallOptions
|
Returns
listKeyRings(request, options, callback)
listKeyRings
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IListKeyRingsRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
kms
.
v1
.
IListKeyRingsRequest
,
protos
.
google
.
cloud
.
kms
.
v1
.
IListKeyRingsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
kms
.
v1
.
IKeyRing
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IListKeyRingsRequest
|
| options |
CallOptions
|
| callback |
PaginationCallback
<protos. google.cloud.kms.v1.IListKeyRingsRequest
, protos. google.cloud.kms.v1.IListKeyRingsResponse
| null | undefined, protos. google.cloud.kms.v1.IKeyRing
>
|
Returns
listKeyRings(request, callback)
listKeyRings
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IListKeyRingsRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
kms
.
v1
.
IListKeyRingsRequest
,
protos
.
google
.
cloud
.
kms
.
v1
.
IListKeyRingsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
kms
.
v1
.
IKeyRing
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IListKeyRingsRequest
|
| callback |
PaginationCallback
<protos. google.cloud.kms.v1.IListKeyRingsRequest
, protos. google.cloud.kms.v1.IListKeyRingsResponse
| null | undefined, protos. google.cloud.kms.v1.IKeyRing
>
|
Returns
listKeyRingsAsync(request, options)
listKeyRingsAsync
(
request
?:
protos
.
google
.
cloud
.
kms
.
v1
.
IListKeyRingsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
kms
.
v1
.
IKeyRing
> ;
Equivalent to listKeyRings
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IListKeyRingsRequest
The request object that will be sent.
|
| options |
CallOptions
Call options. See CallOptions
for more details.
|
Returns | Type |
Description |
| AsyncIterable
<protos. google.cloud.kms.v1.IKeyRing
> |
{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [KeyRing]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listKeyRingsStream(request, options)
listKeyRingsStream
(
request
?:
protos
.
google
.
cloud
.
kms
.
v1
.
IListKeyRingsRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IListKeyRingsRequest
The request object that will be sent.
|
| options |
CallOptions
Call options. See CallOptions
for more details.
|
Returns | Type |
Description |
| Transform
|
{Stream} An object stream which emits an object representing [KeyRing] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listKeyRingsAsync()
method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
locationPath(project, location)
locationPath
(
project
:
string
,
location
:
string
)
:
string
;
Return a fully-qualified location resource name string.
Parameters
Returns | Type |
Description |
| string
|
{string} Resource name string.
|
macSign(request, options)
macSign
(
request
?:
protos
.
google
.
cloud
.
kms
.
v1
.
IMacSignRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
kms
.
v1
.
IMacSignResponse
,
protos
.
google
.
cloud
.
kms
.
v1
.
IMacSignRequest
|
undefined
,
{}
|
undefined
]>;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IMacSignRequest
|
| options |
CallOptions
|
Returns
macSign(request, options, callback)
macSign
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IMacSignRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
IMacSignResponse
,
protos
.
google
.
cloud
.
kms
.
v1
.
IMacSignRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IMacSignRequest
|
| options |
CallOptions
|
| callback |
Callback
<protos. google.cloud.kms.v1.IMacSignResponse
, protos. google.cloud.kms.v1.IMacSignRequest
| null | undefined, {} | null | undefined>
|
Returns
macSign(request, callback)
macSign
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IMacSignRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
IMacSignResponse
,
protos
.
google
.
cloud
.
kms
.
v1
.
IMacSignRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IMacSignRequest
|
| callback |
Callback
<protos. google.cloud.kms.v1.IMacSignResponse
, protos. google.cloud.kms.v1.IMacSignRequest
| null | undefined, {} | null | undefined>
|
Returns
macVerify(request, options)
macVerify
(
request
?:
protos
.
google
.
cloud
.
kms
.
v1
.
IMacVerifyRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
kms
.
v1
.
IMacVerifyResponse
,
protos
.
google
.
cloud
.
kms
.
v1
.
IMacVerifyRequest
|
undefined
,
{}
|
undefined
]>;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IMacVerifyRequest
|
| options |
CallOptions
|
Returns
macVerify(request, options, callback)
macVerify
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IMacVerifyRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
IMacVerifyResponse
,
protos
.
google
.
cloud
.
kms
.
v1
.
IMacVerifyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IMacVerifyRequest
|
| options |
CallOptions
|
| callback |
Callback
<protos. google.cloud.kms.v1.IMacVerifyResponse
, protos. google.cloud.kms.v1.IMacVerifyRequest
| null | undefined, {} | null | undefined>
|
Returns
macVerify(request, callback)
macVerify
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IMacVerifyRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
IMacVerifyResponse
,
protos
.
google
.
cloud
.
kms
.
v1
.
IMacVerifyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IMacVerifyRequest
|
| callback |
Callback
<protos. google.cloud.kms.v1.IMacVerifyResponse
, protos. google.cloud.kms.v1.IMacVerifyRequest
| null | undefined, {} | null | undefined>
|
Returns
matchCryptoKeyFromCryptoKeyName(cryptoKeyName)
matchCryptoKeyFromCryptoKeyName
(
cryptoKeyName
:
string
)
:
string
|
number
;
Parse the crypto_key from CryptoKey resource.
Parameter | Name |
Description |
| cryptoKeyName |
string
A fully-qualified path representing CryptoKey resource.
|
Returns | Type |
Description |
| string | number
|
{string} A string representing the crypto_key.
|
matchCryptoKeyFromCryptoKeyVersionName(cryptoKeyVersionName)
matchCryptoKeyFromCryptoKeyVersionName
(
cryptoKeyVersionName
:
string
)
:
string
|
number
;
Parse the crypto_key from CryptoKeyVersion resource.
Parameter | Name |
Description |
| cryptoKeyVersionName |
string
A fully-qualified path representing CryptoKeyVersion resource.
|
Returns | Type |
Description |
| string | number
|
{string} A string representing the crypto_key.
|
matchCryptoKeyFromPublicKeyName(publicKeyName)
matchCryptoKeyFromPublicKeyName
(
publicKeyName
:
string
)
:
string
|
number
;
Parse the crypto_key from PublicKey resource.
Parameter | Name |
Description |
| publicKeyName |
string
A fully-qualified path representing PublicKey resource.
|
Returns | Type |
Description |
| string | number
|
{string} A string representing the crypto_key.
|
matchCryptoKeyVersionFromCryptoKeyVersionName(cryptoKeyVersionName)
matchCryptoKeyVersionFromCryptoKeyVersionName
(
cryptoKeyVersionName
:
string
)
:
string
|
number
;
Parse the crypto_key_version from CryptoKeyVersion resource.
Parameter | Name |
Description |
| cryptoKeyVersionName |
string
A fully-qualified path representing CryptoKeyVersion resource.
|
Returns | Type |
Description |
| string | number
|
{string} A string representing the crypto_key_version.
|
matchCryptoKeyVersionFromPublicKeyName(publicKeyName)
matchCryptoKeyVersionFromPublicKeyName
(
publicKeyName
:
string
)
:
string
|
number
;
Parse the crypto_key_version from PublicKey resource.
Parameter | Name |
Description |
| publicKeyName |
string
A fully-qualified path representing PublicKey resource.
|
Returns | Type |
Description |
| string | number
|
{string} A string representing the crypto_key_version.
|
matchImportJobFromImportJobName(importJobName)
matchImportJobFromImportJobName
(
importJobName
:
string
)
:
string
|
number
;
Parse the import_job from ImportJob resource.
Parameter | Name |
Description |
| importJobName |
string
A fully-qualified path representing ImportJob resource.
|
Returns | Type |
Description |
| string | number
|
{string} A string representing the import_job.
|
matchKeyRingFromCryptoKeyName(cryptoKeyName)
matchKeyRingFromCryptoKeyName
(
cryptoKeyName
:
string
)
:
string
|
number
;
Parse the key_ring from CryptoKey resource.
Parameter | Name |
Description |
| cryptoKeyName |
string
A fully-qualified path representing CryptoKey resource.
|
Returns | Type |
Description |
| string | number
|
{string} A string representing the key_ring.
|
matchKeyRingFromCryptoKeyVersionName(cryptoKeyVersionName)
matchKeyRingFromCryptoKeyVersionName
(
cryptoKeyVersionName
:
string
)
:
string
|
number
;
Parse the key_ring from CryptoKeyVersion resource.
Parameter | Name |
Description |
| cryptoKeyVersionName |
string
A fully-qualified path representing CryptoKeyVersion resource.
|
Returns | Type |
Description |
| string | number
|
{string} A string representing the key_ring.
|
matchKeyRingFromImportJobName(importJobName)
matchKeyRingFromImportJobName
(
importJobName
:
string
)
:
string
|
number
;
Parse the key_ring from ImportJob resource.
Parameter | Name |
Description |
| importJobName |
string
A fully-qualified path representing ImportJob resource.
|
Returns | Type |
Description |
| string | number
|
{string} A string representing the key_ring.
|
matchKeyRingFromKeyRingName(keyRingName)
matchKeyRingFromKeyRingName
(
keyRingName
:
string
)
:
string
|
number
;
Parse the key_ring from KeyRing resource.
Parameter | Name |
Description |
| keyRingName |
string
A fully-qualified path representing KeyRing resource.
|
Returns | Type |
Description |
| string | number
|
{string} A string representing the key_ring.
|
matchKeyRingFromPublicKeyName(publicKeyName)
matchKeyRingFromPublicKeyName
(
publicKeyName
:
string
)
:
string
|
number
;
Parse the key_ring from PublicKey resource.
Parameter | Name |
Description |
| publicKeyName |
string
A fully-qualified path representing PublicKey resource.
|
Returns | Type |
Description |
| string | number
|
{string} A string representing the key_ring.
|
matchLocationFromCryptoKeyName(cryptoKeyName)
matchLocationFromCryptoKeyName
(
cryptoKeyName
:
string
)
:
string
|
number
;
Parse the location from CryptoKey resource.
Parameter | Name |
Description |
| cryptoKeyName |
string
A fully-qualified path representing CryptoKey resource.
|
Returns | Type |
Description |
| string | number
|
{string} A string representing the location.
|
matchLocationFromCryptoKeyVersionName(cryptoKeyVersionName)
matchLocationFromCryptoKeyVersionName
(
cryptoKeyVersionName
:
string
)
:
string
|
number
;
Parse the location from CryptoKeyVersion resource.
Parameter | Name |
Description |
| cryptoKeyVersionName |
string
A fully-qualified path representing CryptoKeyVersion resource.
|
Returns | Type |
Description |
| string | number
|
{string} A string representing the location.
|
matchLocationFromImportJobName(importJobName)
matchLocationFromImportJobName
(
importJobName
:
string
)
:
string
|
number
;
Parse the location from ImportJob resource.
Parameter | Name |
Description |
| importJobName |
string
A fully-qualified path representing ImportJob resource.
|
Returns | Type |
Description |
| string | number
|
{string} A string representing the location.
|
matchLocationFromKeyRingName(keyRingName)
matchLocationFromKeyRingName
(
keyRingName
:
string
)
:
string
|
number
;
Parse the location from KeyRing resource.
Parameter | Name |
Description |
| keyRingName |
string
A fully-qualified path representing KeyRing resource.
|
Returns | Type |
Description |
| string | number
|
{string} A string representing the location.
|
matchLocationFromLocationName(locationName)
matchLocationFromLocationName
(
locationName
:
string
)
:
string
|
number
;
Parse the location from Location resource.
Parameter | Name |
Description |
| locationName |
string
A fully-qualified path representing Location resource.
|
Returns | Type |
Description |
| string | number
|
{string} A string representing the location.
|
matchLocationFromPublicKeyName(publicKeyName)
matchLocationFromPublicKeyName
(
publicKeyName
:
string
)
:
string
|
number
;
Parse the location from PublicKey resource.
Parameter | Name |
Description |
| publicKeyName |
string
A fully-qualified path representing PublicKey resource.
|
Returns | Type |
Description |
| string | number
|
{string} A string representing the location.
|
matchProjectFromCryptoKeyName(cryptoKeyName)
matchProjectFromCryptoKeyName
(
cryptoKeyName
:
string
)
:
string
|
number
;
Parse the project from CryptoKey resource.
Parameter | Name |
Description |
| cryptoKeyName |
string
A fully-qualified path representing CryptoKey resource.
|
Returns | Type |
Description |
| string | number
|
{string} A string representing the project.
|
matchProjectFromCryptoKeyVersionName(cryptoKeyVersionName)
matchProjectFromCryptoKeyVersionName
(
cryptoKeyVersionName
:
string
)
:
string
|
number
;
Parse the project from CryptoKeyVersion resource.
Parameter | Name |
Description |
| cryptoKeyVersionName |
string
A fully-qualified path representing CryptoKeyVersion resource.
|
Returns | Type |
Description |
| string | number
|
{string} A string representing the project.
|
matchProjectFromImportJobName(importJobName)
matchProjectFromImportJobName
(
importJobName
:
string
)
:
string
|
number
;
Parse the project from ImportJob resource.
Parameter | Name |
Description |
| importJobName |
string
A fully-qualified path representing ImportJob resource.
|
Returns | Type |
Description |
| string | number
|
{string} A string representing the project.
|
matchProjectFromKeyRingName(keyRingName)
matchProjectFromKeyRingName
(
keyRingName
:
string
)
:
string
|
number
;
Parse the project from KeyRing resource.
Parameter | Name |
Description |
| keyRingName |
string
A fully-qualified path representing KeyRing resource.
|
Returns | Type |
Description |
| string | number
|
{string} A string representing the project.
|
matchProjectFromLocationName(locationName)
matchProjectFromLocationName
(
locationName
:
string
)
:
string
|
number
;
Parse the project from Location resource.
Parameter | Name |
Description |
| locationName |
string
A fully-qualified path representing Location resource.
|
Returns | Type |
Description |
| string | number
|
{string} A string representing the project.
|
matchProjectFromPublicKeyName(publicKeyName)
matchProjectFromPublicKeyName
(
publicKeyName
:
string
)
:
string
|
number
;
Parse the project from PublicKey resource.
Parameter | Name |
Description |
| publicKeyName |
string
A fully-qualified path representing PublicKey resource.
|
Returns | Type |
Description |
| string | number
|
{string} A string representing the project.
|
publicKeyPath(project, location, keyRing, cryptoKey, cryptoKeyVersion)
publicKeyPath
(
project
:
string
,
location
:
string
,
keyRing
:
string
,
cryptoKey
:
string
,
cryptoKeyVersion
:
string
)
:
string
;
Return a fully-qualified publicKey resource name string.
Parameters
Returns | Type |
Description |
| string
|
{string} Resource name string.
|
restoreCryptoKeyVersion(request, options)
restoreCryptoKeyVersion
(
request
?:
protos
.
google
.
cloud
.
kms
.
v1
.
IRestoreCryptoKeyVersionRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
kms
.
v1
.
ICryptoKeyVersion
,
protos
.
google
.
cloud
.
kms
.
v1
.
IRestoreCryptoKeyVersionRequest
|
undefined
,
{}
|
undefined
]>;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IRestoreCryptoKeyVersionRequest
|
| options |
CallOptions
|
Returns
restoreCryptoKeyVersion(request, options, callback)
restoreCryptoKeyVersion
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IRestoreCryptoKeyVersionRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
ICryptoKeyVersion
,
protos
.
google
.
cloud
.
kms
.
v1
.
IRestoreCryptoKeyVersionRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IRestoreCryptoKeyVersionRequest
|
| options |
CallOptions
|
| callback |
Callback
<protos. google.cloud.kms.v1.ICryptoKeyVersion
, protos. google.cloud.kms.v1.IRestoreCryptoKeyVersionRequest
| null | undefined, {} | null | undefined>
|
Returns
restoreCryptoKeyVersion(request, callback)
restoreCryptoKeyVersion
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IRestoreCryptoKeyVersionRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
ICryptoKeyVersion
,
protos
.
google
.
cloud
.
kms
.
v1
.
IRestoreCryptoKeyVersionRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IRestoreCryptoKeyVersionRequest
|
| callback |
Callback
<protos. google.cloud.kms.v1.ICryptoKeyVersion
, protos. google.cloud.kms.v1.IRestoreCryptoKeyVersionRequest
| null | undefined, {} | null | undefined>
|
Returns
setIamPolicy(request, options, callback)
setIamPolicy
(
request
:
IamProtos
.
google
.
iam
.
v1
.
SetIamPolicyRequest
,
options
?:
gax
.
CallOptions
|
Callback<IamProtos
.
google
.
iam
.
v1
.
Policy
,
IamProtos
.
google
.
iam
.
v1
.
SetIamPolicyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<IamProtos
.
google
.
iam
.
v1
.
Policy
,
IamProtos
.
google
.
iam
.
v1
.
SetIamPolicyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
Promise<IamProtos
.
google
.
iam
.
v1
.
Policy
> ;
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameters | Name |
Description |
| request |
IamProtos. google.iam.v1.SetIamPolicyRequest
The request object that will be sent.
|
| options |
gax. CallOptions
| Callback
<IamProtos. google.iam.v1.Policy
, IamProtos. google.iam.v1.SetIamPolicyRequest
| null | undefined, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See [gax.CallOptions] https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html
for the details.
|
| callback |
Callback
<IamProtos. google.iam.v1.Policy
, IamProtos. google.iam.v1.SetIamPolicyRequest
| null | undefined, {} | null | undefined>
The function which will be called with the result of the API call.
The second parameter to the callback is an object representing [TestIamPermissionsResponse].
|
Returns | Type |
Description |
| Promise
<IamProtos. google.iam.v1.Policy
> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing [TestIamPermissionsResponse]. The promise has a method named "cancel" which cancels the ongoing API call.
|
testIamPermissions(request, options, callback)
testIamPermissions
(
request
:
IamProtos
.
google
.
iam
.
v1
.
TestIamPermissionsRequest
,
options
?:
gax
.
CallOptions
|
Callback<IamProtos
.
google
.
iam
.
v1
.
TestIamPermissionsResponse
,
IamProtos
.
google
.
iam
.
v1
.
TestIamPermissionsRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<IamProtos
.
google
.
iam
.
v1
.
TestIamPermissionsResponse
,
IamProtos
.
google
.
iam
.
v1
.
TestIamPermissionsRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
Promise<IamProtos
.
google
.
iam
.
v1
.
TestIamPermissionsResponse
> ;
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameters | Name |
Description |
| request |
IamProtos. google.iam.v1.TestIamPermissionsRequest
The request object that will be sent.
|
| options |
gax. CallOptions
| Callback
<IamProtos. google.iam.v1.TestIamPermissionsResponse
, IamProtos. google.iam.v1.TestIamPermissionsRequest
| null | undefined, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See [gax.CallOptions] https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html
for the details.
|
| callback |
Callback
<IamProtos. google.iam.v1.TestIamPermissionsResponse
, IamProtos. google.iam.v1.TestIamPermissionsRequest
| null | undefined, {} | null | undefined>
The function which will be called with the result of the API call.
The second parameter to the callback is an object representing [TestIamPermissionsResponse].
|
Returns | Type |
Description |
| Promise
<IamProtos. google.iam.v1.TestIamPermissionsResponse
> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing [TestIamPermissionsResponse]. The promise has a method named "cancel" which cancels the ongoing API call.
|
updateCryptoKey(request, options)
updateCryptoKey
(
request
?:
protos
.
google
.
cloud
.
kms
.
v1
.
IUpdateCryptoKeyRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
kms
.
v1
.
ICryptoKey
,
protos
.
google
.
cloud
.
kms
.
v1
.
IUpdateCryptoKeyRequest
|
undefined
,
{}
|
undefined
]>;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IUpdateCryptoKeyRequest
|
| options |
CallOptions
|
Returns
updateCryptoKey(request, options, callback)
updateCryptoKey
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IUpdateCryptoKeyRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
ICryptoKey
,
protos
.
google
.
cloud
.
kms
.
v1
.
IUpdateCryptoKeyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IUpdateCryptoKeyRequest
|
| options |
CallOptions
|
| callback |
Callback
<protos. google.cloud.kms.v1.ICryptoKey
, protos. google.cloud.kms.v1.IUpdateCryptoKeyRequest
| null | undefined, {} | null | undefined>
|
Returns
updateCryptoKey(request, callback)
updateCryptoKey
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IUpdateCryptoKeyRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
ICryptoKey
,
protos
.
google
.
cloud
.
kms
.
v1
.
IUpdateCryptoKeyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IUpdateCryptoKeyRequest
|
| callback |
Callback
<protos. google.cloud.kms.v1.ICryptoKey
, protos. google.cloud.kms.v1.IUpdateCryptoKeyRequest
| null | undefined, {} | null | undefined>
|
Returns
updateCryptoKeyPrimaryVersion(request, options)
updateCryptoKeyPrimaryVersion
(
request
?:
protos
.
google
.
cloud
.
kms
.
v1
.
IUpdateCryptoKeyPrimaryVersionRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
kms
.
v1
.
ICryptoKey
,
(
protos
.
google
.
cloud
.
kms
.
v1
.
IUpdateCryptoKeyPrimaryVersionRequest
|
undefined
),
{}
|
undefined
]>;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IUpdateCryptoKeyPrimaryVersionRequest
|
| options |
CallOptions
|
Returns
updateCryptoKeyPrimaryVersion(request, options, callback)
updateCryptoKeyPrimaryVersion
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IUpdateCryptoKeyPrimaryVersionRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
ICryptoKey
,
protos
.
google
.
cloud
.
kms
.
v1
.
IUpdateCryptoKeyPrimaryVersionRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IUpdateCryptoKeyPrimaryVersionRequest
|
| options |
CallOptions
|
| callback |
Callback
<protos. google.cloud.kms.v1.ICryptoKey
, protos. google.cloud.kms.v1.IUpdateCryptoKeyPrimaryVersionRequest
| null | undefined, {} | null | undefined>
|
Returns
updateCryptoKeyPrimaryVersion(request, callback)
updateCryptoKeyPrimaryVersion
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IUpdateCryptoKeyPrimaryVersionRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
ICryptoKey
,
protos
.
google
.
cloud
.
kms
.
v1
.
IUpdateCryptoKeyPrimaryVersionRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IUpdateCryptoKeyPrimaryVersionRequest
|
| callback |
Callback
<protos. google.cloud.kms.v1.ICryptoKey
, protos. google.cloud.kms.v1.IUpdateCryptoKeyPrimaryVersionRequest
| null | undefined, {} | null | undefined>
|
Returns
updateCryptoKeyVersion(request, options)
updateCryptoKeyVersion
(
request
?:
protos
.
google
.
cloud
.
kms
.
v1
.
IUpdateCryptoKeyVersionRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
kms
.
v1
.
ICryptoKeyVersion
,
protos
.
google
.
cloud
.
kms
.
v1
.
IUpdateCryptoKeyVersionRequest
|
undefined
,
{}
|
undefined
]>;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IUpdateCryptoKeyVersionRequest
|
| options |
CallOptions
|
Returns
updateCryptoKeyVersion(request, options, callback)
updateCryptoKeyVersion
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IUpdateCryptoKeyVersionRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
ICryptoKeyVersion
,
protos
.
google
.
cloud
.
kms
.
v1
.
IUpdateCryptoKeyVersionRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IUpdateCryptoKeyVersionRequest
|
| options |
CallOptions
|
| callback |
Callback
<protos. google.cloud.kms.v1.ICryptoKeyVersion
, protos. google.cloud.kms.v1.IUpdateCryptoKeyVersionRequest
| null | undefined, {} | null | undefined>
|
Returns
updateCryptoKeyVersion(request, callback)
updateCryptoKeyVersion
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IUpdateCryptoKeyVersionRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
ICryptoKeyVersion
,
protos
.
google
.
cloud
.
kms
.
v1
.
IUpdateCryptoKeyVersionRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.kms.v1.IUpdateCryptoKeyVersionRequest
|
| callback |
Callback
<protos. google.cloud.kms.v1.ICryptoKeyVersion
, protos. google.cloud.kms.v1.IUpdateCryptoKeyVersionRequest
| null | undefined, {} | null | undefined>
|
Returns
