Class v1.AutokeyAdminClient (4.5.0)

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/kms

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?:ClientOptions,gaxInstance?:typeofgax|typeofgax.fallback);

Construct an instance of AutokeyAdminClient.

Parameters
Name	Description
`opts`	`ClientOptions`
`gaxInstance`	`typeofgax \| typeoffallback` : 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

getapiEndpoint():string;

The DNS address for this API service.

apiEndpoint

staticgetapiEndpoint():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

staticgetport():number;

The port for this API service.

scopes

staticgetscopes():string[];

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

staticgetservicePath():string;

The DNS address for this API service.

universeDomain

getuniverseDomain():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.

Parameter
Name	Description
`folder`	`string`

Returns
Type	Description
`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.

Returns
Type	Description
`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.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`keyRing`	`string`
`cryptoKey`	`string`

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
Name	Description
`project`	`string`
`location`	`string`
`keyRing`	`string`
`cryptoKey`	`string`
`cryptoKeyVersion`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

ekmConfigPath(project, location)

ekmConfigPath(project:string,location:string):string;

Return a fully-qualified ekmConfig resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`

Returns
Type	Description
`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.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`ekmConnection`	`string`

Returns
Type	Description
`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 theAutokeyConfig for a folder.

Parameters
Name	Description
`request`	`IGetAutokeyConfigRequest` The request object that will be sent.
`options`	`CallOptions` Call options. SeeCallOptions for more details.

Returns
Type	Description
`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 representingAutokeyConfig. Please see thedocumentation for more details and examples.

Example

/**   * 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 libraryconst{AutokeyAdminClient}=require('@google-cloud/kms').v1;// Instantiates a clientconstkmsClient=newAutokeyAdminClient();asyncfunctioncallGetAutokeyConfig(){// Construct requestconstrequest={name,};// Run requestconstresponse=awaitkmsClient.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;

Parameters
Name	Description
`request`	`IGetAutokeyConfigRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.kms.v1.IAutokeyConfig,protos.google.cloud.kms.v1.IGetAutokeyConfigRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`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;

Parameters
Name	Description
`request`	`IGetAutokeyConfigRequest`
`callback`	`Callback<protos.google.cloud.kms.v1.IAutokeyConfig,protos.google.cloud.kms.v1.IGetAutokeyConfigRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`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.

Parameters
Name	Description
`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. Seegax.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 .

Returns
Type	Description
`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.

Parameters
Name	Description
`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. SeeCallOptions for more details.
`callback`	`Callback<google.cloud.location.ILocation,google.cloud.location.IGetLocationRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`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 thedocumentation for more details and examples.

Example

const[response]=awaitclient.getLocation(request);

getProjectId()

getProjectId():Promise<string>;

Returns
Type	Description
`Promise<string>`

getProjectId(callback)

getProjectId(callback:Callback<string,undefined,undefined>):void;

Parameter
Name	Description
`callback`	`Callback<string, undefined, undefined>`

Returns
Type	Description
`void`

importJobPath(project, location, keyRing, importJob)

importJobPath(project:string,location:string,keyRing:string,importJob:string):string;

Return a fully-qualified importJob resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`keyRing`	`string`
`importJob`	`string`

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.

keyHandlePath(project, location, keyHandle)

keyHandlePath(project:string,location:string,keyHandle:string):string;

Return a fully-qualified keyHandle resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`keyHandle`	`string`

Returns
Type	Description
`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.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`keyRing`	`string`

Returns
Type	Description
`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.

Parameters
Name	Description
`request`	`LocationProtos.google.cloud.location.IListLocationsRequest` The request object that will be sent.
`options`	`CallOptions` Call options. SeeCallOptions for more details.

Returns
Type	Description
`AsyncIterable<google.cloud.location.ILocation>`	{Object} An iterable Object that allowsasync 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 thedocumentation for more details and examples.

Example

constiterable=client.listLocationsAsync(request);forawait(constresponseofiterable){// process response}

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.

matchEkmConnectionFromEkmConnectionName(ekmConnectionName)

matchEkmConnectionFromEkmConnectionName(ekmConnectionName:string):string|number;

Parse the ekm_connection from EkmConnection resource.

Parameter
Name	Description
`ekmConnectionName`	`string` A fully-qualified path representing EkmConnection resource.

Returns
Type	Description
`string \| number`	{string} A string representing the ekm_connection.

matchFolderFromAutokeyConfigName(autokeyConfigName)

matchFolderFromAutokeyConfigName(autokeyConfigName:string):string|number;

Parse the folder from AutokeyConfig resource.

Parameter
Name	Description
`autokeyConfigName`	`string` A fully-qualified path representing AutokeyConfig resource.

Returns
Type	Description
`string \| number`	{string} A string representing the folder.

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.

matchKeyHandleFromKeyHandleName(keyHandleName)

matchKeyHandleFromKeyHandleName(keyHandleName:string):string|number;

Parse the key_handle from KeyHandle resource.

Parameter
Name	Description
`keyHandleName`	`string` A fully-qualified path representing KeyHandle resource.

Returns
Type	Description
`string \| number`	{string} A string representing the key_handle.

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.

matchLocationFromEkmConfigName(ekmConfigName)

matchLocationFromEkmConfigName(ekmConfigName:string):string|number;

Parse the location from EkmConfig resource.

Parameter
Name	Description
`ekmConfigName`	`string` A fully-qualified path representing EkmConfig resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromEkmConnectionName(ekmConnectionName)

matchLocationFromEkmConnectionName(ekmConnectionName:string):string|number;

Parse the location from EkmConnection resource.

Parameter
Name	Description
`ekmConnectionName`	`string` A fully-qualified path representing EkmConnection 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.

matchLocationFromKeyHandleName(keyHandleName)

matchLocationFromKeyHandleName(keyHandleName:string):string|number;

Parse the location from KeyHandle resource.

Parameter
Name	Description
`keyHandleName`	`string` A fully-qualified path representing KeyHandle 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.

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.

matchProjectFromEkmConfigName(ekmConfigName)

matchProjectFromEkmConfigName(ekmConfigName:string):string|number;

Parse the project from EkmConfig resource.

Parameter
Name	Description
`ekmConfigName`	`string` A fully-qualified path representing EkmConfig resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromEkmConnectionName(ekmConnectionName)

matchProjectFromEkmConnectionName(ekmConnectionName:string):string|number;

Parse the project from EkmConnection resource.

Parameter
Name	Description
`ekmConnectionName`	`string` A fully-qualified path representing EkmConnection 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.

matchProjectFromKeyHandleName(keyHandleName)

matchProjectFromKeyHandleName(keyHandleName:string):string|number;

Parse the project from KeyHandle resource.

Parameter
Name	Description
`keyHandleName`	`string` A fully-qualified path representing KeyHandle 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.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName:string):string|number;

Parse the project from Project resource.

Parameter
Name	Description
`projectName`	`string` A fully-qualified path representing Project 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.

projectPath(project)

projectPath(project:string):string;

Return a fully-qualified project resource name string.

Parameter
Name	Description
`project`	`string`

Returns
Type	Description
`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.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`keyRing`	`string`
`cryptoKey`	`string`
`cryptoKeyVersion`	`string`

Returns
Type	Description
`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.

Parameters
Name	Description
`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. Seegax.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 .

Returns
Type	Description
`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.

Parameters
Name	Description
`request`	`IShowEffectiveAutokeyConfigRequest` The request object that will be sent.
`options`	`CallOptions` Call options. SeeCallOptions for more details.

Returns
Type	Description
`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 representingShowEffectiveAutokeyConfigResponse. Please see thedocumentation for more details and examples.

Example

/**   * 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 libraryconst{AutokeyAdminClient}=require('@google-cloud/kms').v1;// Instantiates a clientconstkmsClient=newAutokeyAdminClient();asyncfunctioncallShowEffectiveAutokeyConfig(){// Construct requestconstrequest={parent,};// Run requestconstresponse=awaitkmsClient.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;

Parameters
Name	Description
`request`	`IShowEffectiveAutokeyConfigRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.kms.v1.IShowEffectiveAutokeyConfigResponse,protos.google.cloud.kms.v1.IShowEffectiveAutokeyConfigRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`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;

Parameters
Name	Description
`request`	`IShowEffectiveAutokeyConfigRequest`
`callback`	`Callback<protos.google.cloud.kms.v1.IShowEffectiveAutokeyConfigResponse,protos.google.cloud.kms.v1.IShowEffectiveAutokeyConfigRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`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.

Parameters
Name	Description
`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. Seegax.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 .

Returns
Type	Description
`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 theAutokeyConfig for a folder. The caller must have bothcloudkms.autokeyConfigs.update permission on the parent folder andcloudkms.cryptoKeys.setIamPolicy permission on the provided key project. AKeyHandle creation in the folder's descendant projects will use this configuration to determine where to create the resulting .

Parameters
Name	Description
`request`	`IUpdateAutokeyConfigRequest` The request object that will be sent.
`options`	`CallOptions` Call options. SeeCallOptions for more details.

Returns
Type	Description
`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 representingAutokeyConfig. Please see thedocumentation for more details and examples.

Example

/**   * 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 libraryconst{AutokeyAdminClient}=require('@google-cloud/kms').v1;// Instantiates a clientconstkmsClient=newAutokeyAdminClient();asyncfunctioncallUpdateAutokeyConfig(){// Construct requestconstrequest={autokeyConfig,updateMask,};// Run requestconstresponse=awaitkmsClient.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;

Parameters
Name	Description
`request`	`IUpdateAutokeyConfigRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.kms.v1.IAutokeyConfig,protos.google.cloud.kms.v1.IUpdateAutokeyConfigRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`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;

Parameters
Name	Description
`request`	`IUpdateAutokeyConfigRequest`
`callback`	`Callback<protos.google.cloud.kms.v1.IAutokeyConfig,protos.google.cloud.kms.v1.IUpdateAutokeyConfigRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-10-30 UTC.

Movatterモバイル変換

Class v1.AutokeyAdminClient (4.5.0) Stay organized with collections Save and categorize content based on your preferences.

Package

Constructors

(constructor)(opts, gaxInstance)

Properties

apiEndpoint

apiEndpoint

auth

autokeyAdminStub

descriptors

iamClient

innerApiCalls

locationsClient

pathTemplates

port

scopes

servicePath

universeDomain

warn

Methods

autokeyConfigPath(folder)

close()

cryptoKeyPath(project, location, keyRing, cryptoKey)

cryptoKeyVersionPath(project, location, keyRing, cryptoKey, cryptoKeyVersion)

ekmConfigPath(project, location)

ekmConnectionPath(project, location, ekmConnection)

getAutokeyConfig(request, options)

getAutokeyConfig(request, options, callback)

getAutokeyConfig(request, callback)

getIamPolicy(request, options, callback)

getLocation(request, options, callback)

getProjectId()

getProjectId(callback)

importJobPath(project, location, keyRing, importJob)

initialize()

keyHandlePath(project, location, keyHandle)

keyRingPath(project, location, keyRing)

listLocationsAsync(request, options)

matchCryptoKeyFromCryptoKeyName(cryptoKeyName)

matchCryptoKeyFromCryptoKeyVersionName(cryptoKeyVersionName)

matchCryptoKeyFromPublicKeyName(publicKeyName)

matchCryptoKeyVersionFromCryptoKeyVersionName(cryptoKeyVersionName)

matchCryptoKeyVersionFromPublicKeyName(publicKeyName)

matchEkmConnectionFromEkmConnectionName(ekmConnectionName)

matchFolderFromAutokeyConfigName(autokeyConfigName)

matchImportJobFromImportJobName(importJobName)

matchKeyHandleFromKeyHandleName(keyHandleName)

matchKeyRingFromCryptoKeyName(cryptoKeyName)

matchKeyRingFromCryptoKeyVersionName(cryptoKeyVersionName)

matchKeyRingFromImportJobName(importJobName)

matchKeyRingFromKeyRingName(keyRingName)

matchKeyRingFromPublicKeyName(publicKeyName)

matchLocationFromCryptoKeyName(cryptoKeyName)

matchLocationFromCryptoKeyVersionName(cryptoKeyVersionName)

matchLocationFromEkmConfigName(ekmConfigName)

matchLocationFromEkmConnectionName(ekmConnectionName)

matchLocationFromImportJobName(importJobName)

matchLocationFromKeyHandleName(keyHandleName)

matchLocationFromKeyRingName(keyRingName)

matchLocationFromPublicKeyName(publicKeyName)

matchProjectFromCryptoKeyName(cryptoKeyName)

matchProjectFromCryptoKeyVersionName(cryptoKeyVersionName)

matchProjectFromEkmConfigName(ekmConfigName)

matchProjectFromEkmConnectionName(ekmConnectionName)

matchProjectFromImportJobName(importJobName)

matchProjectFromKeyHandleName(keyHandleName)

matchProjectFromKeyRingName(keyRingName)

matchProjectFromProjectName(projectName)

matchProjectFromPublicKeyName(publicKeyName)

projectPath(project)

publicKeyPath(project, location, keyRing, cryptoKey, cryptoKeyVersion)

setIamPolicy(request, options, callback)

showEffectiveAutokeyConfig(request, options)

showEffectiveAutokeyConfig(request, options, callback)

showEffectiveAutokeyConfig(request, callback)

testIamPermissions(request, options, callback)

updateAutokeyConfig(request, options)

updateAutokeyConfig(request, options, callback)

updateAutokeyConfig(request, callback)

Class v1.AutokeyAdminClient (4.5.0)