Provides interfaces for managing Cloud KMS Autokey folder-level configurations. A configuration is inherited by all descendent projects. A configuration at one folder overrides any other configurations in its ancestry. Setting a configuration on a folder is a prerequisite for Cloud KMS Autokey, so that users working in a descendant project can request provisioned , ready for Customer Managed Encryption Key (CMEK) use, on-demand. v1
Package
@google-cloud/kmsConstructors
(constructor)(opts, gaxInstance)
constructor
(
opts
?:
ClientOptions
,
gaxInstance
?:
typeof
gax
|
typeof
gax
.
fallback
);
Construct an instance of AutokeyAdminClient.
opts
ClientOptions
gaxInstance
typeof gax
| typeof fallback
: loaded instance of google-gax
. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new AutokeyAdminClient({fallback: true}, gax); ```
Properties
apiEndpoint
get
apiEndpoint
()
:
string
;
The DNS address for this API service.
apiEndpoint
static
get
apiEndpoint
()
:
string
;
The DNS address for this API service - same as servicePath.
auth
auth
:
gax
.
GoogleAuth
;
autokeyAdminStub
autokeyAdminStub
?:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
descriptors
descriptors
:
Descriptors
;
iamClient
iamClient
:
IamClient
;
innerApiCalls
innerApiCalls
:
{
[
name
:
string
]
:
Function
;
};
locationsClient
locationsClient
:
LocationsClient
;
pathTemplates
pathTemplates
:
{
[
name
:
string
]
:
gax
.
PathTemplate
;
};
port
static
get
port
()
:
number
;
The port for this API service.
scopes
static
get
scopes
()
:
string
[];
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
static
get
servicePath
()
:
string
;
The DNS address for this API service.
universeDomain
get
universeDomain
()
:
string
;
warn
warn
:
(
code
:
string
,
message
:
string
,
warnType
?:
string
)
=
>
void
;
Methods
autokeyConfigPath(folder)
autokeyConfigPath
(
folder
:
string
)
:
string
;
Return a fully-qualified autokeyConfig resource name string.
folder
string
string
{string} Resource name string.
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.
Promise
<void>
{Promise} A promise that resolves when the client is closed.
cryptoKeyPath(project, location, keyRing, cryptoKey)
cryptoKeyPath
(
project
:
string
,
location
:
string
,
keyRing
:
string
,
cryptoKey
:
string
)
:
string
;
Return a fully-qualified cryptoKey resource name string.
project
string
location
string
keyRing
string
cryptoKey
string
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.
project
string
location
string
keyRing
string
cryptoKey
string
cryptoKeyVersion
string
string
{string} Resource name string.
ekmConfigPath(project, location)
ekmConfigPath
(
project
:
string
,
location
:
string
)
:
string
;
Return a fully-qualified ekmConfig resource name string.
project
string
location
string
string
{string} Resource name string.
ekmConnectionPath(project, location, ekmConnection)
ekmConnectionPath
(
project
:
string
,
location
:
string
,
ekmConnection
:
string
)
:
string
;
Return a fully-qualified ekmConnection resource name string.
project
string
location
string
ekmConnection
string
string
{string} Resource name string.
getAutokeyConfig(request, options)
getAutokeyConfig
(
request
?:
protos
.
google
.
cloud
.
kms
.
v1
.
IGetAutokeyConfigRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
kms
.
v1
.
IAutokeyConfig
,
protos
.
google
.
cloud
.
kms
.
v1
.
IGetAutokeyConfigRequest
|
undefined
,
{}
|
undefined
]>;
Returns the AutokeyConfig for a folder.
request
options
Promise
<[ protos.google.cloud.kms.v1.IAutokeyConfig
, protos.google.cloud.kms.v1.IGetAutokeyConfigRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing AutokeyConfig . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of the AutokeyConfig google.cloud.kms.v1.AutokeyConfig
* resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`.
*/
// const name = 'abc123'
// Imports the Kms library
const
{
AutokeyAdminClient
}
=
require
(
' @google-cloud/kms
'
).
v1
;
// Instantiates a client
const
kmsClient
=
new
AutokeyAdminClient
();
async
function
callGetAutokeyConfig
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
kmsClient
.
getAutokeyConfig
(
request
);
console
.
log
(
response
);
}
callGetAutokeyConfig
();
getAutokeyConfig(request, options, callback)
getAutokeyConfig
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IGetAutokeyConfigRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
IAutokeyConfig
,
protos
.
google
.
cloud
.
kms
.
v1
.
IGetAutokeyConfigRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.cloud.kms.v1.IAutokeyConfig
, protos.google.cloud.kms.v1.IGetAutokeyConfigRequest
| null | undefined, {} | null | undefined>
void
getAutokeyConfig(request, callback)
getAutokeyConfig
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IGetAutokeyConfigRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
IAutokeyConfig
,
protos
.
google
.
cloud
.
kms
.
v1
.
IGetAutokeyConfigRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.cloud.kms.v1.IAutokeyConfig
, protos.google.cloud.kms.v1.IGetAutokeyConfigRequest
| null | undefined, {} | null | undefined>
void
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.
request
IamProtos.google.iam.v1.GetIamPolicyRequest
The request object that will be sent.
options
CallOptions
| Callback
< google.iam.v1.Policy
, 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 for the details.
callback
Callback
< google.iam.v1.Policy
, 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 .
Promise
<[ google.iam.v1.Policy
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.
getLocation(request, options, callback)
getLocation
(
request
:
LocationProtos
.
google
.
cloud
.
location
.
IGetLocationRequest
,
options
?:
gax
.
CallOptions
|
Callback<LocationProtos
.
google
.
cloud
.
location
.
ILocation
,
LocationProtos
.
google
.
cloud
.
location
.
IGetLocationRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<LocationProtos
.
google
.
cloud
.
location
.
ILocation
,
LocationProtos
.
google
.
cloud
.
location
.
IGetLocationRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
Promise<LocationProtos
.
google
.
cloud
.
location
.
ILocation
> ;
Gets information about a location.
request
LocationProtos.google.cloud.location.IGetLocationRequest
The request object that will be sent.
options
CallOptions
| Callback
< google.cloud.location.ILocation
, google.cloud.location.IGetLocationRequest
| null | undefined, {} | null | undefined>
Call options. See CallOptions for more details.
callback
Callback
< google.cloud.location.ILocation
, google.cloud.location.IGetLocationRequest
| null | undefined, {} | null | undefined>
Promise
< google.cloud.location.ILocation
>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
const
[
response
]
=
await
client
.
getLocation
(
request
);
getProjectId()
getProjectId
()
:
Promise<string>
;
Promise
<string>
getProjectId(callback)
getProjectId
(
callback
:
Callback<string
,
undefined
,
undefined
> )
:
void
;
callback
Callback
<string, undefined, undefined>
void
importJobPath(project, location, keyRing, importJob)
importJobPath
(
project
:
string
,
location
:
string
,
keyRing
:
string
,
importJob
:
string
)
:
string
;
Return a fully-qualified importJob resource name string.
project
string
location
string
keyRing
string
importJob
string
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.
Promise
<{
[name: string]: Function
;
}>
{Promise} A promise that resolves to an authenticated service stub.
keyHandlePath(project, location, keyHandle)
keyHandlePath
(
project
:
string
,
location
:
string
,
keyHandle
:
string
)
:
string
;
Return a fully-qualified keyHandle resource name string.
project
string
location
string
keyHandle
string
string
{string} Resource name string.
keyRingPath(project, location, keyRing)
keyRingPath
(
project
:
string
,
location
:
string
,
keyRing
:
string
)
:
string
;
Return a fully-qualified keyRing resource name string.
project
string
location
string
keyRing
string
string
{string} Resource name string.
listLocationsAsync(request, options)
listLocationsAsync
(
request
:
LocationProtos
.
google
.
cloud
.
location
.
IListLocationsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<LocationProtos
.
google
.
cloud
.
location
.
ILocation
> ;
Lists information about the supported locations for this service. Returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
LocationProtos.google.cloud.location.IListLocationsRequest
The request object that will be sent.
options
AsyncIterable
< google.cloud.location.ILocation
>
{Object} An iterable Object that allows async iteration . When you iterate the returned iterable, each element will be an object representing . 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 for more details and examples.
const
iterable
=
client
.
listLocationsAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
// process response
}
matchCryptoKeyFromCryptoKeyName(cryptoKeyName)
matchCryptoKeyFromCryptoKeyName
(
cryptoKeyName
:
string
)
:
string
|
number
;
Parse the crypto_key from CryptoKey resource.
cryptoKeyName
string
A fully-qualified path representing CryptoKey resource.
string | number
{string} A string representing the crypto_key.
matchCryptoKeyFromCryptoKeyVersionName(cryptoKeyVersionName)
matchCryptoKeyFromCryptoKeyVersionName
(
cryptoKeyVersionName
:
string
)
:
string
|
number
;
Parse the crypto_key from CryptoKeyVersion resource.
cryptoKeyVersionName
string
A fully-qualified path representing CryptoKeyVersion resource.
string | number
{string} A string representing the crypto_key.
matchCryptoKeyFromPublicKeyName(publicKeyName)
matchCryptoKeyFromPublicKeyName
(
publicKeyName
:
string
)
:
string
|
number
;
Parse the crypto_key from PublicKey resource.
publicKeyName
string
A fully-qualified path representing PublicKey resource.
string | number
{string} A string representing the crypto_key.
matchCryptoKeyVersionFromCryptoKeyVersionName(cryptoKeyVersionName)
matchCryptoKeyVersionFromCryptoKeyVersionName
(
cryptoKeyVersionName
:
string
)
:
string
|
number
;
Parse the crypto_key_version from CryptoKeyVersion resource.
cryptoKeyVersionName
string
A fully-qualified path representing CryptoKeyVersion resource.
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.
publicKeyName
string
A fully-qualified path representing PublicKey resource.
string | number
{string} A string representing the crypto_key_version.
matchEkmConnectionFromEkmConnectionName(ekmConnectionName)
matchEkmConnectionFromEkmConnectionName
(
ekmConnectionName
:
string
)
:
string
|
number
;
Parse the ekm_connection from EkmConnection resource.
ekmConnectionName
string
A fully-qualified path representing EkmConnection resource.
string | number
{string} A string representing the ekm_connection.
matchFolderFromAutokeyConfigName(autokeyConfigName)
matchFolderFromAutokeyConfigName
(
autokeyConfigName
:
string
)
:
string
|
number
;
Parse the folder from AutokeyConfig resource.
autokeyConfigName
string
A fully-qualified path representing AutokeyConfig resource.
string | number
{string} A string representing the folder.
matchImportJobFromImportJobName(importJobName)
matchImportJobFromImportJobName
(
importJobName
:
string
)
:
string
|
number
;
Parse the import_job from ImportJob resource.
importJobName
string
A fully-qualified path representing ImportJob resource.
string | number
{string} A string representing the import_job.
matchKeyHandleFromKeyHandleName(keyHandleName)
matchKeyHandleFromKeyHandleName
(
keyHandleName
:
string
)
:
string
|
number
;
Parse the key_handle from KeyHandle resource.
keyHandleName
string
A fully-qualified path representing KeyHandle resource.
string | number
{string} A string representing the key_handle.
matchKeyRingFromCryptoKeyName(cryptoKeyName)
matchKeyRingFromCryptoKeyName
(
cryptoKeyName
:
string
)
:
string
|
number
;
Parse the key_ring from CryptoKey resource.
cryptoKeyName
string
A fully-qualified path representing CryptoKey resource.
string | number
{string} A string representing the key_ring.
matchKeyRingFromCryptoKeyVersionName(cryptoKeyVersionName)
matchKeyRingFromCryptoKeyVersionName
(
cryptoKeyVersionName
:
string
)
:
string
|
number
;
Parse the key_ring from CryptoKeyVersion resource.
cryptoKeyVersionName
string
A fully-qualified path representing CryptoKeyVersion resource.
string | number
{string} A string representing the key_ring.
matchKeyRingFromImportJobName(importJobName)
matchKeyRingFromImportJobName
(
importJobName
:
string
)
:
string
|
number
;
Parse the key_ring from ImportJob resource.
importJobName
string
A fully-qualified path representing ImportJob resource.
string | number
{string} A string representing the key_ring.
matchKeyRingFromKeyRingName(keyRingName)
matchKeyRingFromKeyRingName
(
keyRingName
:
string
)
:
string
|
number
;
Parse the key_ring from KeyRing resource.
keyRingName
string
A fully-qualified path representing KeyRing resource.
string | number
{string} A string representing the key_ring.
matchKeyRingFromPublicKeyName(publicKeyName)
matchKeyRingFromPublicKeyName
(
publicKeyName
:
string
)
:
string
|
number
;
Parse the key_ring from PublicKey resource.
publicKeyName
string
A fully-qualified path representing PublicKey resource.
string | number
{string} A string representing the key_ring.
matchLocationFromCryptoKeyName(cryptoKeyName)
matchLocationFromCryptoKeyName
(
cryptoKeyName
:
string
)
:
string
|
number
;
Parse the location from CryptoKey resource.
cryptoKeyName
string
A fully-qualified path representing CryptoKey resource.
string | number
{string} A string representing the location.
matchLocationFromCryptoKeyVersionName(cryptoKeyVersionName)
matchLocationFromCryptoKeyVersionName
(
cryptoKeyVersionName
:
string
)
:
string
|
number
;
Parse the location from CryptoKeyVersion resource.
cryptoKeyVersionName
string
A fully-qualified path representing CryptoKeyVersion resource.
string | number
{string} A string representing the location.
matchLocationFromEkmConfigName(ekmConfigName)
matchLocationFromEkmConfigName
(
ekmConfigName
:
string
)
:
string
|
number
;
Parse the location from EkmConfig resource.
ekmConfigName
string
A fully-qualified path representing EkmConfig resource.
string | number
{string} A string representing the location.
matchLocationFromEkmConnectionName(ekmConnectionName)
matchLocationFromEkmConnectionName
(
ekmConnectionName
:
string
)
:
string
|
number
;
Parse the location from EkmConnection resource.
ekmConnectionName
string
A fully-qualified path representing EkmConnection resource.
string | number
{string} A string representing the location.
matchLocationFromImportJobName(importJobName)
matchLocationFromImportJobName
(
importJobName
:
string
)
:
string
|
number
;
Parse the location from ImportJob resource.
importJobName
string
A fully-qualified path representing ImportJob resource.
string | number
{string} A string representing the location.
matchLocationFromKeyHandleName(keyHandleName)
matchLocationFromKeyHandleName
(
keyHandleName
:
string
)
:
string
|
number
;
Parse the location from KeyHandle resource.
keyHandleName
string
A fully-qualified path representing KeyHandle resource.
string | number
{string} A string representing the location.
matchLocationFromKeyRingName(keyRingName)
matchLocationFromKeyRingName
(
keyRingName
:
string
)
:
string
|
number
;
Parse the location from KeyRing resource.
keyRingName
string
A fully-qualified path representing KeyRing resource.
string | number
{string} A string representing the location.
matchLocationFromPublicKeyName(publicKeyName)
matchLocationFromPublicKeyName
(
publicKeyName
:
string
)
:
string
|
number
;
Parse the location from PublicKey resource.
publicKeyName
string
A fully-qualified path representing PublicKey resource.
string | number
{string} A string representing the location.
matchProjectFromCryptoKeyName(cryptoKeyName)
matchProjectFromCryptoKeyName
(
cryptoKeyName
:
string
)
:
string
|
number
;
Parse the project from CryptoKey resource.
cryptoKeyName
string
A fully-qualified path representing CryptoKey resource.
string | number
{string} A string representing the project.
matchProjectFromCryptoKeyVersionName(cryptoKeyVersionName)
matchProjectFromCryptoKeyVersionName
(
cryptoKeyVersionName
:
string
)
:
string
|
number
;
Parse the project from CryptoKeyVersion resource.
cryptoKeyVersionName
string
A fully-qualified path representing CryptoKeyVersion resource.
string | number
{string} A string representing the project.
matchProjectFromEkmConfigName(ekmConfigName)
matchProjectFromEkmConfigName
(
ekmConfigName
:
string
)
:
string
|
number
;
Parse the project from EkmConfig resource.
ekmConfigName
string
A fully-qualified path representing EkmConfig resource.
string | number
{string} A string representing the project.
matchProjectFromEkmConnectionName(ekmConnectionName)
matchProjectFromEkmConnectionName
(
ekmConnectionName
:
string
)
:
string
|
number
;
Parse the project from EkmConnection resource.
ekmConnectionName
string
A fully-qualified path representing EkmConnection resource.
string | number
{string} A string representing the project.
matchProjectFromImportJobName(importJobName)
matchProjectFromImportJobName
(
importJobName
:
string
)
:
string
|
number
;
Parse the project from ImportJob resource.
importJobName
string
A fully-qualified path representing ImportJob resource.
string | number
{string} A string representing the project.
matchProjectFromKeyHandleName(keyHandleName)
matchProjectFromKeyHandleName
(
keyHandleName
:
string
)
:
string
|
number
;
Parse the project from KeyHandle resource.
keyHandleName
string
A fully-qualified path representing KeyHandle resource.
string | number
{string} A string representing the project.
matchProjectFromKeyRingName(keyRingName)
matchProjectFromKeyRingName
(
keyRingName
:
string
)
:
string
|
number
;
Parse the project from KeyRing resource.
keyRingName
string
A fully-qualified path representing KeyRing resource.
string | number
{string} A string representing the project.
matchProjectFromProjectName(projectName)
matchProjectFromProjectName
(
projectName
:
string
)
:
string
|
number
;
Parse the project from Project resource.
projectName
string
A fully-qualified path representing Project resource.
string | number
{string} A string representing the project.
matchProjectFromPublicKeyName(publicKeyName)
matchProjectFromPublicKeyName
(
publicKeyName
:
string
)
:
string
|
number
;
Parse the project from PublicKey resource.
publicKeyName
string
A fully-qualified path representing PublicKey resource.
string | number
{string} A string representing the project.
projectPath(project)
projectPath
(
project
:
string
)
:
string
;
Return a fully-qualified project resource name string.
project
string
string
{string} Resource name string.
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.
project
string
location
string
keyRing
string
cryptoKey
string
cryptoKeyVersion
string
string
{string} Resource name string.
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.
request
IamProtos.google.iam.v1.SetIamPolicyRequest
The request object that will be sent.
options
CallOptions
| Callback
< google.iam.v1.Policy
, 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 for the details.
callback
Callback
< google.iam.v1.Policy
, 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 .
Promise
<[ google.iam.v1.Policy
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.
showEffectiveAutokeyConfig(request, options)
showEffectiveAutokeyConfig
(
request
?:
protos
.
google
.
cloud
.
kms
.
v1
.
IShowEffectiveAutokeyConfigRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
kms
.
v1
.
IShowEffectiveAutokeyConfigResponse
,
protos
.
google
.
cloud
.
kms
.
v1
.
IShowEffectiveAutokeyConfigRequest
|
undefined
,
{}
|
undefined
]>;
Returns the effective Cloud KMS Autokey configuration for a given project.
request
options
Promise
<[ protos.google.cloud.kms.v1.IShowEffectiveAutokeyConfigResponse
, protos.google.cloud.kms.v1.IShowEffectiveAutokeyConfigRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing ShowEffectiveAutokeyConfigResponse . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of the resource project to the show effective Cloud KMS
* Autokey configuration for. This may be helpful for interrogating the effect
* of nested folder configurations on a given resource project.
*/
// const parent = 'abc123'
// Imports the Kms library
const
{
AutokeyAdminClient
}
=
require
(
' @google-cloud/kms
'
).
v1
;
// Instantiates a client
const
kmsClient
=
new
AutokeyAdminClient
();
async
function
callShowEffectiveAutokeyConfig
()
{
// Construct request
const
request
=
{
parent
,
};
// Run request
const
response
=
await
kmsClient
.
showEffectiveAutokeyConfig
(
request
);
console
.
log
(
response
);
}
callShowEffectiveAutokeyConfig
();
showEffectiveAutokeyConfig(request, options, callback)
showEffectiveAutokeyConfig
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IShowEffectiveAutokeyConfigRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
IShowEffectiveAutokeyConfigResponse
,
protos
.
google
.
cloud
.
kms
.
v1
.
IShowEffectiveAutokeyConfigRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
options
CallOptions
callback
Callback
< protos.google.cloud.kms.v1.IShowEffectiveAutokeyConfigResponse
, protos.google.cloud.kms.v1.IShowEffectiveAutokeyConfigRequest
| null | undefined, {} | null | undefined>
void
showEffectiveAutokeyConfig(request, callback)
showEffectiveAutokeyConfig
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IShowEffectiveAutokeyConfigRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
IShowEffectiveAutokeyConfigResponse
,
protos
.
google
.
cloud
.
kms
.
v1
.
IShowEffectiveAutokeyConfigRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
callback
Callback
< protos.google.cloud.kms.v1.IShowEffectiveAutokeyConfigResponse
, protos.google.cloud.kms.v1.IShowEffectiveAutokeyConfigRequest
| null | undefined, {} | null | undefined>
void
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.
request
IamProtos.google.iam.v1.TestIamPermissionsRequest
The request object that will be sent.
options
CallOptions
| Callback
< google.iam.v1.TestIamPermissionsResponse
, 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 for the details.
callback
Callback
< google.iam.v1.TestIamPermissionsResponse
, 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 .
Promise
<[ google.iam.v1.TestIamPermissionsResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.
updateAutokeyConfig(request, options)
updateAutokeyConfig
(
request
?:
protos
.
google
.
cloud
.
kms
.
v1
.
IUpdateAutokeyConfigRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
kms
.
v1
.
IAutokeyConfig
,
protos
.
google
.
cloud
.
kms
.
v1
.
IUpdateAutokeyConfigRequest
|
undefined
,
{}
|
undefined
]>;
Updates the AutokeyConfig
for a folder. The caller must have both cloudkms.autokeyConfigs.update
permission on the parent folder and cloudkms.cryptoKeys.setIamPolicy
permission on the provided key project. A KeyHandle
creation in the folder's descendant projects will use this configuration to determine where to create the resulting .
request
options
Promise
<[ protos.google.cloud.kms.v1.IAutokeyConfig
, protos.google.cloud.kms.v1.IUpdateAutokeyConfigRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing AutokeyConfig . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. AutokeyConfig google.cloud.kms.v1.AutokeyConfig with values to
* update.
*/
// const autokeyConfig = {}
/**
* Required. Masks which fields of the
* AutokeyConfig google.cloud.kms.v1.AutokeyConfig to update, e.g.
* `keyProject`.
*/
// const updateMask = {}
// Imports the Kms library
const
{
AutokeyAdminClient
}
=
require
(
' @google-cloud/kms
'
).
v1
;
// Instantiates a client
const
kmsClient
=
new
AutokeyAdminClient
();
async
function
callUpdateAutokeyConfig
()
{
// Construct request
const
request
=
{
autokeyConfig
,
updateMask
,
};
// Run request
const
response
=
await
kmsClient
.
updateAutokeyConfig
(
request
);
console
.
log
(
response
);
}
callUpdateAutokeyConfig
();
updateAutokeyConfig(request, options, callback)
updateAutokeyConfig
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IUpdateAutokeyConfigRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
IAutokeyConfig
,
protos
.
google
.
cloud
.
kms
.
v1
.
IUpdateAutokeyConfigRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.cloud.kms.v1.IAutokeyConfig
, protos.google.cloud.kms.v1.IUpdateAutokeyConfigRequest
| null | undefined, {} | null | undefined>
void
updateAutokeyConfig(request, callback)
updateAutokeyConfig
(
request
:
protos
.
google
.
cloud
.
kms
.
v1
.
IUpdateAutokeyConfigRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
kms
.
v1
.
IAutokeyConfig
,
protos
.
google
.
cloud
.
kms
.
v1
.
IUpdateAutokeyConfigRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.cloud.kms.v1.IAutokeyConfig
, protos.google.cloud.kms.v1.IUpdateAutokeyConfigRequest
| null | undefined, {} | null | undefined>
void
