EkmServiceClient - Documentation

Constructor

new EkmServiceClient(optionsopt, gaxInstanceopt)

Construct an instance of EkmServiceClient.

Parameters:

Name Type Attributes Description

options

object

The configuration object. The options accepted by the constructor are described in detail in this document. The common options are:

Properties

Name Type Attributes Description

credentials

object

Credentials object.

Properties

Name	Type	Attributes	Description
`client_email`	string	<optional>
`private_key`	string	<optional>

email

string

Account email address. Required when using a .pem or .p12 keyFilename.

keyFilename

string

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.

port

number

The port on which to connect to the remote host.

projectId

string

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.

apiEndpoint

string

The domain name of the API remote host.

clientConfig

gax.ClientConfig

Client configuration override. Follows the structure of gapicConfig.

fallback

boolean

Use HTTP/1.1 REST mode. For more information, please check the documentation.

gaxInstance

gax

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 EkmServiceClient({fallback: true}, gax);

Members

apiEndpoint

The DNS address for this API service.

apiEndpoint

The DNS address for this API service - same as servicePath.

port

The port for this API service.

scopes

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

servicePath

The DNS address for this API service.

Methods

autokeyConfigPath(folder) → {string}

Return a fully-qualified autokeyConfig resource name string.

Parameters:

Name	Type	Description
`folder`	string

Returns:

Type	Description
string	Resource name string.

close() → {Promise}

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	A promise that resolves when the client is closed.

cryptoKeyPath(project, location, key_ring, crypto_key) → {string}

Return a fully-qualified cryptoKey resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`key_ring`	string
`crypto_key`	string

Returns:

Type	Description
string	Resource name string.

cryptoKeyVersionPath(project, location, key_ring, crypto_key, crypto_key_version) → {string}

Return a fully-qualified cryptoKeyVersion resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`key_ring`	string
`crypto_key`	string
`crypto_key_version`	string

Returns:

Type	Description
string	Resource name string.

ekmConfigPath(project, location) → {string}

Return a fully-qualified ekmConfig resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string

Returns:

Type	Description
string	Resource name string.

ekmConnectionPath(project, location, ekm_connection) → {string}

Return a fully-qualified ekmConnection resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`ekm_connection`	string

Returns:

Type	Description
string	Resource name string.

getIamPolicy(request, optionsopt, callbackopt) → {Promise}

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 Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Attributes Description

resource

string

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

options

Object

OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy. This field is only used by Cloud IAM.

This object should have the same structure as GetPolicyOptions.

options

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

function

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	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.

getLocation(request, optionsopt) → {Promise}

Gets information about a location.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`name`	string	Resource name for the location.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Promise	The promise which resolves to an array. The first element of the array is an object representing Location. Please see the documentation for more details and examples.

Example

```
const [response] = await client.getLocation(request);
```

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:

Type	Description
Promise	A promise that resolves to string containing the project ID.

importJobPath(project, location, key_ring, import_job) → {string}

Return a fully-qualified importJob resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`key_ring`	string
`import_job`	string

Returns:

Type	Description
string	Resource name string.

initialize() → {Promise}

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	A promise that resolves to an authenticated service stub.

keyHandlePath(project, location, key_handle) → {string}

Return a fully-qualified keyHandle resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`key_handle`	string

Returns:

Type	Description
string	Resource name string.

keyRingPath(project, location, key_ring) → {string}

Return a fully-qualified keyRing resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`key_ring`	string

Returns:

Type	Description
string	Resource name string.

listEkmConnectionsAsync(request, optionsopt) → {Object}

Equivalent to listEkmConnections, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Attributes	Description
`parent`	string		Required. The resource name of the location associated with the EkmConnections to list, in the format `projects/* /locations/*`.
`pageSize`	number	<optional>	Optional. Optional limit on the number of EkmConnections to include in the response. Further EkmConnections can subsequently be obtained by including the ListEkmConnectionsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.
`pageToken`	string	<optional>	Optional. Optional pagination token, returned earlier via ListEkmConnectionsResponse.next_page_token.
`filter`	string	<optional>	Optional. Only include resources that match the filter in the response. For more information, see Sorting and filtering list results.
`orderBy`	string	<optional>	Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order. For more information, see Sorting and filtering list results.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing EkmConnection. 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.

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. The resource name of the location associated with the
   *  EkmConnections google.cloud.kms.v1.EkmConnection  to list, in the format
   *  `projects/* /locations/*`.
   */
  // const parent = 'abc123'
  /**
   *  Optional. Optional limit on the number of
   *  EkmConnections google.cloud.kms.v1.EkmConnection  to include in the
   *  response. Further EkmConnections google.cloud.kms.v1.EkmConnection  can
   *  subsequently be obtained by including the
   *  ListEkmConnectionsResponse.next_page_token google.cloud.kms.v1.ListEkmConnectionsResponse.next_page_token 
   *  in a subsequent request. If unspecified, the server will pick an
   *  appropriate default.
   */
  // const pageSize = 1234
  /**
   *  Optional. Optional pagination token, returned earlier via
   *  ListEkmConnectionsResponse.next_page_token google.cloud.kms.v1.ListEkmConnectionsResponse.next_page_token.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Only include resources that match the filter in the response. For
   *  more information, see
   *  Sorting and filtering list
   *  results (https://cloud.google.com/kms/docs/sorting-and-filtering).
   */
  // const filter = 'abc123'
  /**
   *  Optional. Specify how the results should be sorted. If not specified, the
   *  results will be sorted in the default order.  For more information, see
   *  Sorting and filtering list
   *  results (https://cloud.google.com/kms/docs/sorting-and-filtering).
   */
  // const orderBy = 'abc123'

  // Imports the Kms library
  const {EkmServiceClient} = require('@google-cloud/kms').v1;

  // Instantiates a client
  const kmsClient = new EkmServiceClient();

  async function callListEkmConnections() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = kmsClient.listEkmConnectionsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListEkmConnections();

listEkmConnectionsStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Attributes	Description
`parent`	string		Required. The resource name of the location associated with the EkmConnections to list, in the format `projects/* /locations/*`.
`pageSize`	number	<optional>	Optional. Optional limit on the number of EkmConnections to include in the response. Further EkmConnections can subsequently be obtained by including the ListEkmConnectionsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.
`pageToken`	string	<optional>	Optional. Optional pagination token, returned earlier via ListEkmConnectionsResponse.next_page_token.
`filter`	string	<optional>	Optional. Only include resources that match the filter in the response. For more information, see Sorting and filtering list results.
`orderBy`	string	<optional>	Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order. For more information, see Sorting and filtering list results.

options

object

Call options. See CallOptions for more details.

Returns:

Type Description

Type	Description
Stream	An object stream which emits an object representing EkmConnection 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 `listEkmConnectionsAsync()` method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

Stream

An object stream which emits an object representing EkmConnection 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 listEkmConnectionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listLocationsAsync(request, optionsopt) → {Object}

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 Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`name`	string	The resource that owns the locations collection, if applicable.
`filter`	string	The standard list filter.
`pageSize`	number	The standard list page size.
`pageToken`	string	The standard list page token.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Location. 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.

Example

```
const iterable = client.listLocationsAsync(request);
for await (const response of iterable) {
  // process response
}
```

locationPath(project, location) → {string}

Return a fully-qualified location resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string

Returns:

Type	Description
string	Resource name string.

matchCryptoKeyFromCryptoKeyName(cryptoKeyName) → {string}

Parse the crypto_key from CryptoKey resource.

Parameters:

Name	Type	Description
`cryptoKeyName`	string	A fully-qualified path representing CryptoKey resource.

Returns:

Type	Description
string	A string representing the crypto_key.

matchCryptoKeyFromCryptoKeyVersionName(cryptoKeyVersionName) → {string}

Parse the crypto_key from CryptoKeyVersion resource.

Parameters:

Name	Type	Description
`cryptoKeyVersionName`	string	A fully-qualified path representing CryptoKeyVersion resource.

Returns:

Type	Description
string	A string representing the crypto_key.

matchCryptoKeyFromPublicKeyName(publicKeyName) → {string}

Parse the crypto_key from PublicKey resource.

Parameters:

Name	Type	Description
`publicKeyName`	string	A fully-qualified path representing PublicKey resource.

Returns:

Type	Description
string	A string representing the crypto_key.

matchCryptoKeyVersionFromCryptoKeyVersionName(cryptoKeyVersionName) → {string}

Parse the crypto_key_version from CryptoKeyVersion resource.

Parameters:

Name	Type	Description
`cryptoKeyVersionName`	string	A fully-qualified path representing CryptoKeyVersion resource.

Returns:

Type	Description
string	A string representing the crypto_key_version.

matchCryptoKeyVersionFromPublicKeyName(publicKeyName) → {string}

Parse the crypto_key_version from PublicKey resource.

Parameters:

Name	Type	Description
`publicKeyName`	string	A fully-qualified path representing PublicKey resource.

Returns:

Type	Description
string	A string representing the crypto_key_version.

matchEkmConnectionFromEkmConnectionName(ekmConnectionName) → {string}

Parse the ekm_connection from EkmConnection resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the ekm_connection.

matchFolderFromAutokeyConfigName(autokeyConfigName) → {string}

Parse the folder from AutokeyConfig resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the folder.

matchImportJobFromImportJobName(importJobName) → {string}

Parse the import_job from ImportJob resource.

Parameters:

Name	Type	Description
`importJobName`	string	A fully-qualified path representing ImportJob resource.

Returns:

Type	Description
string	A string representing the import_job.

matchKeyHandleFromKeyHandleName(keyHandleName) → {string}

Parse the key_handle from KeyHandle resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the key_handle.

matchKeyRingFromCryptoKeyName(cryptoKeyName) → {string}

Parse the key_ring from CryptoKey resource.

Parameters:

Name	Type	Description
`cryptoKeyName`	string	A fully-qualified path representing CryptoKey resource.

Returns:

Type	Description
string	A string representing the key_ring.

matchKeyRingFromCryptoKeyVersionName(cryptoKeyVersionName) → {string}

Parse the key_ring from CryptoKeyVersion resource.

Parameters:

Name	Type	Description
`cryptoKeyVersionName`	string	A fully-qualified path representing CryptoKeyVersion resource.

Returns:

Type	Description
string	A string representing the key_ring.

matchKeyRingFromImportJobName(importJobName) → {string}

Parse the key_ring from ImportJob resource.

Parameters:

Name	Type	Description
`importJobName`	string	A fully-qualified path representing ImportJob resource.

Returns:

Type	Description
string	A string representing the key_ring.

matchKeyRingFromKeyRingName(keyRingName) → {string}

Parse the key_ring from KeyRing resource.

Parameters:

Name	Type	Description
`keyRingName`	string	A fully-qualified path representing KeyRing resource.

Returns:

Type	Description
string	A string representing the key_ring.

matchKeyRingFromPublicKeyName(publicKeyName) → {string}

Parse the key_ring from PublicKey resource.

Parameters:

Name	Type	Description
`publicKeyName`	string	A fully-qualified path representing PublicKey resource.

Returns:

Type	Description
string	A string representing the key_ring.

matchLocationFromCryptoKeyName(cryptoKeyName) → {string}

Parse the location from CryptoKey resource.

Parameters:

Name	Type	Description
`cryptoKeyName`	string	A fully-qualified path representing CryptoKey resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromCryptoKeyVersionName(cryptoKeyVersionName) → {string}

Parse the location from CryptoKeyVersion resource.

Parameters:

Name	Type	Description
`cryptoKeyVersionName`	string	A fully-qualified path representing CryptoKeyVersion resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromEkmConfigName(ekmConfigName) → {string}

Parse the location from EkmConfig resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the location.

matchLocationFromEkmConnectionName(ekmConnectionName) → {string}

Parse the location from EkmConnection resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the location.

matchLocationFromImportJobName(importJobName) → {string}

Parse the location from ImportJob resource.

Parameters:

Name	Type	Description
`importJobName`	string	A fully-qualified path representing ImportJob resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromKeyHandleName(keyHandleName) → {string}

Parse the location from KeyHandle resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the location.

matchLocationFromKeyRingName(keyRingName) → {string}

Parse the location from KeyRing resource.

Parameters:

Name	Type	Description
`keyRingName`	string	A fully-qualified path representing KeyRing resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromLocationName(locationName) → {string}

Parse the location from Location resource.

Parameters:

Name	Type	Description
`locationName`	string	A fully-qualified path representing Location resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromPublicKeyName(publicKeyName) → {string}

Parse the location from PublicKey resource.

Parameters:

Name	Type	Description
`publicKeyName`	string	A fully-qualified path representing PublicKey resource.

Returns:

Type	Description
string	A string representing the location.

matchProjectFromCryptoKeyName(cryptoKeyName) → {string}

Parse the project from CryptoKey resource.

Parameters:

Name	Type	Description
`cryptoKeyName`	string	A fully-qualified path representing CryptoKey resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromCryptoKeyVersionName(cryptoKeyVersionName) → {string}

Parse the project from CryptoKeyVersion resource.

Parameters:

Name	Type	Description
`cryptoKeyVersionName`	string	A fully-qualified path representing CryptoKeyVersion resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromEkmConfigName(ekmConfigName) → {string}

Parse the project from EkmConfig resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the project.

matchProjectFromEkmConnectionName(ekmConnectionName) → {string}

Parse the project from EkmConnection resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the project.

matchProjectFromImportJobName(importJobName) → {string}

Parse the project from ImportJob resource.

Parameters:

Name	Type	Description
`importJobName`	string	A fully-qualified path representing ImportJob resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromKeyHandleName(keyHandleName) → {string}

Parse the project from KeyHandle resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the project.

matchProjectFromKeyRingName(keyRingName) → {string}

Parse the project from KeyRing resource.

Parameters:

Name	Type	Description
`keyRingName`	string	A fully-qualified path representing KeyRing resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromLocationName(locationName) → {string}

Parse the project from Location resource.

Parameters:

Name	Type	Description
`locationName`	string	A fully-qualified path representing Location resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromPublicKeyName(publicKeyName) → {string}

Parse the project from PublicKey resource.

Parameters:

Name	Type	Description
`publicKeyName`	string	A fully-qualified path representing PublicKey resource.

Returns:

Type	Description
string	A string representing the project.

publicKeyPath(project, location, key_ring, crypto_key, crypto_key_version) → {string}

Return a fully-qualified publicKey resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`key_ring`	string
`crypto_key`	string
`crypto_key_version`	string

Returns:

Type	Description
string	Resource name string.

setIamPolicy(request, optionsopt, callbackopt) → {Promise}

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 Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`resource`	string	REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
`permissions`	Array.<string>	The set of permissions to check for the `resource`. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.

options

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

function

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	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, optionsopt, callbackopt) → {Promise}

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 Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`resource`	string	REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
`permissions`	Array.<string>	The set of permissions to check for the `resource`. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.

options

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

function

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	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.