Class v1.CmekServiceClient (5.4.0)

Dataplex Universal Catalog Customer Managed Encryption Keys (CMEK) Service v1

Package

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of CmekServiceClient.

Parameters
Name	Description
`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 CmekServiceClient({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;

cmekServiceStub

cmekServiceStub?: Promise<{
        [name: string]: Function;
    }>;

descriptors

descriptors: Descriptors;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

locationsClient

locationsClient: LocationsClient;

operationsClient

operationsClient: gax.OperationsClient;

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

aspectTypePath(project, location, aspectType)

aspectTypePath(project: string, location: string, aspectType: string): string;

Return a fully-qualified aspectType resource name string.

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

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

assetPath(project, location, lake, zone, asset)

assetPath(project: string, location: string, lake: string, zone: string, asset: string): string;

Return a fully-qualified asset resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`lake`	`string`
`zone`	`string`
`asset`	`string`

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

cancelOperation(request, optionsOrCallback, callback)

cancelOperation(request: protos.google.longrunning.CancelOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an value with a of 1, corresponding to Code.CANCELLED.

Parameters
Name	Description
`request`	`CancelOperationRequest` The request object that will be sent.
`optionsOrCallback`	`CallOptions \| Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} \| undefined \| null>`
`callback`	`Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} \| undefined \| null>` The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type	Description
`Promise<protos.google.protobuf.Empty>`

Example


const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});

checkCreateEncryptionConfigProgress(name)

checkCreateEncryptionConfigProgress(name: string): Promise<LROperation<protos.google.cloud.dataplex.v1.EncryptionConfig, protos.google.cloud.dataplex.v1.OperationMetadata>>;

Check the status of the long running operation returned by createEncryptionConfig().

Parameter
Name	Description
`name`	`string` The operation name that will be passed.

Returns
Type	Description
`Promise<LROperation<protos.google.cloud.dataplex.v1.EncryptionConfig, protos.google.cloud.dataplex.v1.OperationMetadata>>`	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. 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 location at which the EncryptionConfig is to be created.
   */
  // const parent = 'abc123'
  /**
   *  Required. The ID of the
   *  EncryptionConfig google.cloud.dataplex.v1.EncryptionConfig  to create.
   *  Currently, only a value of "default" is supported.
   */
  // const encryptionConfigId = 'abc123'
  /**
   *  Required. The EncryptionConfig to create.
   */
  // const encryptionConfig = {}

  // Imports the Dataplex library
  const {CmekServiceClient} = require('@google-cloud/dataplex').v1;

  // Instantiates a client
  const dataplexClient = new CmekServiceClient();

  async function callCreateEncryptionConfig() {
    // Construct request
    const request = {
      parent,
      encryptionConfigId,
      encryptionConfig,
    };

    // Run request
    const [operation] = await dataplexClient.createEncryptionConfig(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateEncryptionConfig();

checkDeleteEncryptionConfigProgress(name)

checkDeleteEncryptionConfigProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.dataplex.v1.OperationMetadata>>;

Check the status of the long running operation returned by deleteEncryptionConfig().

Parameter
Name	Description
`name`	`string` The operation name that will be passed.

Returns
Type	Description
`Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.dataplex.v1.OperationMetadata>>`	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. 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 name of the EncryptionConfig to delete.
   */
  // const name = 'abc123'
  /**
   *  Optional. Etag of the EncryptionConfig. This is a strong etag.
   */
  // const etag = 'abc123'

  // Imports the Dataplex library
  const {CmekServiceClient} = require('@google-cloud/dataplex').v1;

  // Instantiates a client
  const dataplexClient = new CmekServiceClient();

  async function callDeleteEncryptionConfig() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await dataplexClient.deleteEncryptionConfig(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteEncryptionConfig();

checkUpdateEncryptionConfigProgress(name)

checkUpdateEncryptionConfigProgress(name: string): Promise<LROperation<protos.google.cloud.dataplex.v1.EncryptionConfig, protos.google.cloud.dataplex.v1.OperationMetadata>>;

Check the status of the long running operation returned by updateEncryptionConfig().

Parameter
Name	Description
`name`	`string` The operation name that will be passed.

Returns
Type	Description
`Promise<LROperation<protos.google.cloud.dataplex.v1.EncryptionConfig, protos.google.cloud.dataplex.v1.OperationMetadata>>`	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. 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 EncryptionConfig to update.
   */
  // const encryptionConfig = {}
  /**
   *  Optional. Mask of fields to update.
   *  The service treats an omitted field mask as an implied field mask
   *  equivalent to all fields that are populated (have a non-empty value).
   */
  // const updateMask = {}

  // Imports the Dataplex library
  const {CmekServiceClient} = require('@google-cloud/dataplex').v1;

  // Instantiates a client
  const dataplexClient = new CmekServiceClient();

  async function callUpdateEncryptionConfig() {
    // Construct request
    const request = {
      encryptionConfig,
    };

    // Run request
    const [operation] = await dataplexClient.updateEncryptionConfig(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdateEncryptionConfig();

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.

contentPath(project, location, lake, content)

contentPath(project: string, location: string, lake: string, content: string): string;

Return a fully-qualified content resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`lake`	`string`
`content`	`string`

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

createEncryptionConfig(request, options)

createEncryptionConfig(request?: protos.google.cloud.dataplex.v1.ICreateEncryptionConfigRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.dataplex.v1.IEncryptionConfig, protos.google.cloud.dataplex.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Create an EncryptionConfig.

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

Returns
Type	Description
`Promise<[ LROperation<protos.google.cloud.dataplex.v1.IEncryptionConfig, protos.google.cloud.dataplex.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its `promise()` method returns a promise you can `await` for. 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 location at which the EncryptionConfig is to be created.
   */
  // const parent = 'abc123'
  /**
   *  Required. The ID of the
   *  EncryptionConfig google.cloud.dataplex.v1.EncryptionConfig  to create.
   *  Currently, only a value of "default" is supported.
   */
  // const encryptionConfigId = 'abc123'
  /**
   *  Required. The EncryptionConfig to create.
   */
  // const encryptionConfig = {}

  // Imports the Dataplex library
  const {CmekServiceClient} = require('@google-cloud/dataplex').v1;

  // Instantiates a client
  const dataplexClient = new CmekServiceClient();

  async function callCreateEncryptionConfig() {
    // Construct request
    const request = {
      parent,
      encryptionConfigId,
      encryptionConfig,
    };

    // Run request
    const [operation] = await dataplexClient.createEncryptionConfig(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateEncryptionConfig();

createEncryptionConfig(request, options, callback)

createEncryptionConfig(request: protos.google.cloud.dataplex.v1.ICreateEncryptionConfigRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.dataplex.v1.IEncryptionConfig, protos.google.cloud.dataplex.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`ICreateEncryptionConfigRequest`
`options`	`CallOptions`
`callback`	`Callback<LROperation<protos.google.cloud.dataplex.v1.IEncryptionConfig, protos.google.cloud.dataplex.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

createEncryptionConfig(request, callback)

createEncryptionConfig(request: protos.google.cloud.dataplex.v1.ICreateEncryptionConfigRequest, callback: Callback<LROperation<protos.google.cloud.dataplex.v1.IEncryptionConfig, protos.google.cloud.dataplex.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`ICreateEncryptionConfigRequest`
`callback`	`Callback<LROperation<protos.google.cloud.dataplex.v1.IEncryptionConfig, protos.google.cloud.dataplex.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

dataAssetPath(project, location, dataProduct, dataAsset)

dataAssetPath(project: string, location: string, dataProduct: string, dataAsset: string): string;

Return a fully-qualified dataAsset resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataProduct`	`string`
`dataAsset`	`string`

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

dataAttributeBindingPath(project, location, dataAttributeBindingId)

dataAttributeBindingPath(project: string, location: string, dataAttributeBindingId: string): string;

Return a fully-qualified dataAttributeBinding resource name string.

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

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

dataAttributePath(project, location, dataTaxonomy, dataAttributeId)

dataAttributePath(project: string, location: string, dataTaxonomy: string, dataAttributeId: string): string;

Return a fully-qualified dataAttribute resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataTaxonomy`	`string`
`dataAttributeId`	`string`

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

dataProductPath(project, location, dataProduct)

dataProductPath(project: string, location: string, dataProduct: string): string;

Return a fully-qualified dataProduct resource name string.

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

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

dataScanJobPath(project, location, dataScan, job)

dataScanJobPath(project: string, location: string, dataScan: string, job: string): string;

Return a fully-qualified dataScanJob resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataScan`	`string`
`job`	`string`

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

dataScanPath(project, location, dataScan)

dataScanPath(project: string, location: string, dataScan: string): string;

Return a fully-qualified dataScan resource name string.

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

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

dataTaxonomyPath(project, location, dataTaxonomyId)

dataTaxonomyPath(project: string, location: string, dataTaxonomyId: string): string;

Return a fully-qualified dataTaxonomy resource name string.

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

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

deleteEncryptionConfig(request, options)

deleteEncryptionConfig(request?: protos.google.cloud.dataplex.v1.IDeleteEncryptionConfigRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.dataplex.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Delete an EncryptionConfig.

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

Returns
Type	Description
`Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.dataplex.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its `promise()` method returns a promise you can `await` for. 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 name of the EncryptionConfig to delete.
   */
  // const name = 'abc123'
  /**
   *  Optional. Etag of the EncryptionConfig. This is a strong etag.
   */
  // const etag = 'abc123'

  // Imports the Dataplex library
  const {CmekServiceClient} = require('@google-cloud/dataplex').v1;

  // Instantiates a client
  const dataplexClient = new CmekServiceClient();

  async function callDeleteEncryptionConfig() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await dataplexClient.deleteEncryptionConfig(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteEncryptionConfig();

deleteEncryptionConfig(request, options, callback)

deleteEncryptionConfig(request: protos.google.cloud.dataplex.v1.IDeleteEncryptionConfigRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.dataplex.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IDeleteEncryptionConfigRequest`
`options`	`CallOptions`
`callback`	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.dataplex.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

deleteEncryptionConfig(request, callback)

deleteEncryptionConfig(request: protos.google.cloud.dataplex.v1.IDeleteEncryptionConfigRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.dataplex.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IDeleteEncryptionConfigRequest`
`callback`	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.dataplex.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

deleteOperation(request, optionsOrCallback, callback)

deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name	Description
`request`	`DeleteOperationRequest` The request object that will be sent.
`optionsOrCallback`	`CallOptions \| Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} \| null \| undefined>`
`callback`	`Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} \| null \| undefined>` The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type	Description
`Promise<protos.google.protobuf.Empty>`

Example


const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});

encryptionConfigPath(organization, location, encryptionConfig)

encryptionConfigPath(organization: string, location: string, encryptionConfig: string): string;

Return a fully-qualified encryptionConfig resource name string.

Parameters
Name	Description
`organization`	`string`
`location`	`string`
`encryptionConfig`	`string`

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

entityPath(project, location, lake, zone, entity)

entityPath(project: string, location: string, lake: string, zone: string, entity: string): string;

Return a fully-qualified entity resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`lake`	`string`
`zone`	`string`
`entity`	`string`

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

entryGroupPath(project, location, entryGroup)

entryGroupPath(project: string, location: string, entryGroup: string): string;

Return a fully-qualified entryGroup resource name string.

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

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

entryLinkPath(project, location, entryGroup, entryLink)

entryLinkPath(project: string, location: string, entryGroup: string, entryLink: string): string;

Return a fully-qualified entryLink resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`entryGroup`	`string`
`entryLink`	`string`

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

entryPath(project, location, entryGroup, entry)

entryPath(project: string, location: string, entryGroup: string, entry: string): string;

Return a fully-qualified entry resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`entryGroup`	`string`
`entry`	`string`

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

entryTypePath(project, location, entryType)

entryTypePath(project: string, location: string, entryType: string): string;

Return a fully-qualified entryType resource name string.

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

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

environmentPath(project, location, lake, environment)

environmentPath(project: string, location: string, lake: string, environment: string): string;

Return a fully-qualified environment resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`lake`	`string`
`environment`	`string`

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

getEncryptionConfig(request, options)

getEncryptionConfig(request?: protos.google.cloud.dataplex.v1.IGetEncryptionConfigRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dataplex.v1.IEncryptionConfig,
        protos.google.cloud.dataplex.v1.IGetEncryptionConfigRequest | undefined,
        {} | undefined
    ]>;

Get an EncryptionConfig.

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

Returns
Type	Description
`Promise<[ protos.google.cloud.dataplex.v1.IEncryptionConfig, protos.google.cloud.dataplex.v1.IGetEncryptionConfigRequest \| undefined, {} \| undefined ]>`	{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.

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 name of the EncryptionConfig to fetch.
   */
  // const name = 'abc123'

  // Imports the Dataplex library
  const {CmekServiceClient} = require('@google-cloud/dataplex').v1;

  // Instantiates a client
  const dataplexClient = new CmekServiceClient();

  async function callGetEncryptionConfig() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await dataplexClient.getEncryptionConfig(request);
    console.log(response);
  }

  callGetEncryptionConfig();

getEncryptionConfig(request, options, callback)

getEncryptionConfig(request: protos.google.cloud.dataplex.v1.IGetEncryptionConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.dataplex.v1.IEncryptionConfig, protos.google.cloud.dataplex.v1.IGetEncryptionConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetEncryptionConfigRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.dataplex.v1.IEncryptionConfig, protos.google.cloud.dataplex.v1.IGetEncryptionConfigRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getEncryptionConfig(request, callback)

getEncryptionConfig(request: protos.google.cloud.dataplex.v1.IGetEncryptionConfigRequest, callback: Callback<protos.google.cloud.dataplex.v1.IEncryptionConfig, protos.google.cloud.dataplex.v1.IGetEncryptionConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetEncryptionConfigRequest`
`callback`	`Callback<protos.google.cloud.dataplex.v1.IEncryptionConfig, protos.google.cloud.dataplex.v1.IGetEncryptionConfigRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

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. See CallOptions 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 the documentation for more details and examples.

Example


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

getOperation(request, optionsOrCallback, callback)

getOperation(request: protos.google.longrunning.GetOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
Name	Description
`request`	`GetOperationRequest` The request object that will be sent.
`optionsOrCallback`	`CallOptions \| Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} \| null \| undefined>`
`callback`	`Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} \| 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} - 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.

Returns
Type	Description
`Promise<[protos.google.longrunning.Operation]>`

Example


const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)

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`

glossaryCategoryPath(project, location, glossary, glossaryCategory)

glossaryCategoryPath(project: string, location: string, glossary: string, glossaryCategory: string): string;

Return a fully-qualified glossaryCategory resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`glossary`	`string`
`glossaryCategory`	`string`

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

glossaryPath(project, location, glossary)

glossaryPath(project: string, location: string, glossary: string): string;

Return a fully-qualified glossary resource name string.

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

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

glossaryTermPath(project, location, glossary, glossaryTerm)

glossaryTermPath(project: string, location: string, glossary: string, glossaryTerm: string): string;

Return a fully-qualified glossaryTerm resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`glossary`	`string`
`glossaryTerm`	`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.

jobPath(project, location, lake, task, job)

jobPath(project: string, location: string, lake: string, task: string, job: string): string;

Return a fully-qualified job resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`lake`	`string`
`task`	`string`
`job`	`string`

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

lakePath(project, location, lake)

lakePath(project: string, location: string, lake: string): string;

Return a fully-qualified lake resource name string.

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

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

listEncryptionConfigs(request, options)

listEncryptionConfigs(request?: protos.google.cloud.dataplex.v1.IListEncryptionConfigsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dataplex.v1.IEncryptionConfig[],
        protos.google.cloud.dataplex.v1.IListEncryptionConfigsRequest | null,
        protos.google.cloud.dataplex.v1.IListEncryptionConfigsResponse
    ]>;

List EncryptionConfigs.

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

Returns

Type Description

Promise<[
        protos.google.cloud.dataplex.v1.IEncryptionConfig[],
        protos.google.cloud.dataplex.v1.IListEncryptionConfigsRequest | null,
        protos.google.cloud.dataplex.v1.IListEncryptionConfigsResponse
    ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listEncryptionConfigsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listEncryptionConfigs(request, options, callback)

listEncryptionConfigs(request: protos.google.cloud.dataplex.v1.IListEncryptionConfigsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dataplex.v1.IListEncryptionConfigsRequest, protos.google.cloud.dataplex.v1.IListEncryptionConfigsResponse | null | undefined, protos.google.cloud.dataplex.v1.IEncryptionConfig>): void;

Parameters
Name	Description
`request`	`IListEncryptionConfigsRequest`
`options`	`CallOptions`
`callback`	`PaginationCallback<protos.google.cloud.dataplex.v1.IListEncryptionConfigsRequest, protos.google.cloud.dataplex.v1.IListEncryptionConfigsResponse \| null \| undefined, protos.google.cloud.dataplex.v1.IEncryptionConfig>`

Returns
Type	Description
`void`

listEncryptionConfigs(request, callback)

listEncryptionConfigs(request: protos.google.cloud.dataplex.v1.IListEncryptionConfigsRequest, callback: PaginationCallback<protos.google.cloud.dataplex.v1.IListEncryptionConfigsRequest, protos.google.cloud.dataplex.v1.IListEncryptionConfigsResponse | null | undefined, protos.google.cloud.dataplex.v1.IEncryptionConfig>): void;

Parameters
Name	Description
`request`	`IListEncryptionConfigsRequest`
`callback`	`PaginationCallback<protos.google.cloud.dataplex.v1.IListEncryptionConfigsRequest, protos.google.cloud.dataplex.v1.IListEncryptionConfigsResponse \| null \| undefined, protos.google.cloud.dataplex.v1.IEncryptionConfig>`

Returns
Type	Description
`void`

listEncryptionConfigsAsync(request, options)

listEncryptionConfigsAsync(request?: protos.google.cloud.dataplex.v1.IListEncryptionConfigsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dataplex.v1.IEncryptionConfig>;

Equivalent to listEncryptionConfigs, but returns an iterable object.

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

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

Returns
Type	Description
`AsyncIterable<protos.google.cloud.dataplex.v1.IEncryptionConfig>`	{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.

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 location for which the EncryptionConfig is to be listed.
   */
  // const parent = 'abc123'
  /**
   *  Optional. Maximum number of EncryptionConfigs to return. The service may
   *  return fewer than this value. If unspecified, at most 10 EncryptionConfigs
   *  will be returned. The maximum value is 1000; values above 1000 will be
   *  coerced to 1000.
   */
  // const pageSize = 1234
  /**
   *  Optional. Page token received from a previous `ListEncryptionConfigs` call.
   *  Provide this to retrieve the subsequent page. When paginating, the
   *  parameters - filter and order_by provided to `ListEncryptionConfigs` must
   *  match the call that provided the page token.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Filter the EncryptionConfigs to be returned.
   *  Using bare literals: (These values will be matched anywhere it may appear
   *  in the object's field values)
   *  * filter=some_value
   *  Using fields: (These values will be matched only in the specified field)
   *  * filter=some_field=some_value
   *  Supported fields:
   *  * name, key, create_time, update_time, encryption_state
   *  Example:
   *  * filter=name=organizations/123/locations/us-central1/encryptionConfigs/test-config
   *  conjunctions: (AND, OR, NOT)
   *  * filter=name=organizations/123/locations/us-central1/encryptionConfigs/test-config
   *  AND mode=CMEK
   *  logical operators: (>, <,>=, <=, !="," =,="" :),="" *="" *="" filter="create_time">2024-05-01T00:00:00.000Z
   */
  // const filter = 'abc123'
  /**
   *  Optional. Order by fields for the result.
   */
  // const orderBy = 'abc123'

  // Imports the Dataplex library
  const {CmekServiceClient} = require('@google-cloud/dataplex').v1;

  // Instantiates a client
  const dataplexClient = new CmekServiceClient();

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

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

  callListEncryptionConfigs();

listEncryptionConfigsStream(request, options)

listEncryptionConfigsStream(request?: protos.google.cloud.dataplex.v1.IListEncryptionConfigsRequest, options?: CallOptions): Transform;

Equivalent to listEncryptionConfigs, but returns a NodeJS Stream object.

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

Returns

Type Description

Transform

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

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. See CallOptions for more details.

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

Example


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

listOperationsAsync(request, options)

listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.IOperation>;

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. Returns an iterable object.

For-await-of syntax is used with the iterable to recursively get response element on-demand.

Parameters
Name	Description
`request`	`ListOperationsRequest` The request object that will be sent.
`options`	`CallOptions` Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

Returns
Type	Description
`AsyncIterable<protos.google.longrunning.IOperation>`	{Object} An iterable Object that conforms to iteration protocols.

Example


const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)

locationPath(project, location)

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

Return a fully-qualified location resource name string.

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

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

matchActionFromProjectLocationLakeActionName(projectLocationLakeActionName)

matchActionFromProjectLocationLakeActionName(projectLocationLakeActionName: string): string | number;

Parse the action from ProjectLocationLakeAction resource.

Parameter
Name	Description
`projectLocationLakeActionName`	`string` A fully-qualified path representing project_location_lake_action resource.

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

matchActionFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName)

matchActionFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName: string): string | number;

Parse the action from ProjectLocationLakeZoneAction resource.

Parameter
Name	Description
`projectLocationLakeZoneActionName`	`string` A fully-qualified path representing project_location_lake_zone_action resource.

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

matchActionFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName)

matchActionFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName: string): string | number;

Parse the action from ProjectLocationLakeZoneAssetAction resource.

Parameter
Name	Description
`projectLocationLakeZoneAssetActionName`	`string` A fully-qualified path representing project_location_lake_zone_asset_action resource.

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

matchAspectTypeFromAspectTypeName(aspectTypeName)

matchAspectTypeFromAspectTypeName(aspectTypeName: string): string | number;

Parse the aspect_type from AspectType resource.

Parameter
Name	Description
`aspectTypeName`	`string` A fully-qualified path representing AspectType resource.

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

matchAssetFromAssetName(assetName)

matchAssetFromAssetName(assetName: string): string | number;

Parse the asset from Asset resource.

Parameter
Name	Description
`assetName`	`string` A fully-qualified path representing Asset resource.

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

matchAssetFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName)

matchAssetFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName: string): string | number;

Parse the asset from ProjectLocationLakeZoneAssetAction resource.

Parameter
Name	Description
`projectLocationLakeZoneAssetActionName`	`string` A fully-qualified path representing project_location_lake_zone_asset_action resource.

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

matchContentFromContentName(contentName)

matchContentFromContentName(contentName: string): string | number;

Parse the content from Content resource.

Parameter
Name	Description
`contentName`	`string` A fully-qualified path representing Content resource.

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

matchDataAssetFromDataAssetName(dataAssetName)

matchDataAssetFromDataAssetName(dataAssetName: string): string | number;

Parse the data_asset from DataAsset resource.

Parameter
Name	Description
`dataAssetName`	`string` A fully-qualified path representing DataAsset resource.

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

matchDataAttributeBindingIdFromDataAttributeBindingName(dataAttributeBindingName)

matchDataAttributeBindingIdFromDataAttributeBindingName(dataAttributeBindingName: string): string | number;

Parse the data_attribute_binding_id from DataAttributeBinding resource.

Parameter
Name	Description
`dataAttributeBindingName`	`string` A fully-qualified path representing DataAttributeBinding resource.

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

matchDataAttributeIdFromDataAttributeName(dataAttributeName)

matchDataAttributeIdFromDataAttributeName(dataAttributeName: string): string | number;

Parse the data_attribute_id from DataAttribute resource.

Parameter
Name	Description
`dataAttributeName`	`string` A fully-qualified path representing DataAttribute resource.

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

matchDataProductFromDataAssetName(dataAssetName)

matchDataProductFromDataAssetName(dataAssetName: string): string | number;

Parse the data_product from DataAsset resource.

Parameter
Name	Description
`dataAssetName`	`string` A fully-qualified path representing DataAsset resource.

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

matchDataProductFromDataProductName(dataProductName)

matchDataProductFromDataProductName(dataProductName: string): string | number;

Parse the data_product from DataProduct resource.

Parameter
Name	Description
`dataProductName`	`string` A fully-qualified path representing DataProduct resource.

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

matchDataScanFromDataScanJobName(dataScanJobName)

matchDataScanFromDataScanJobName(dataScanJobName: string): string | number;

Parse the dataScan from DataScanJob resource.

Parameter
Name	Description
`dataScanJobName`	`string` A fully-qualified path representing DataScanJob resource.

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

matchDataScanFromDataScanName(dataScanName)

matchDataScanFromDataScanName(dataScanName: string): string | number;

Parse the dataScan from DataScan resource.

Parameter
Name	Description
`dataScanName`	`string` A fully-qualified path representing DataScan resource.

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

matchDataTaxonomyFromDataAttributeName(dataAttributeName)

matchDataTaxonomyFromDataAttributeName(dataAttributeName: string): string | number;

Parse the dataTaxonomy from DataAttribute resource.

Parameter
Name	Description
`dataAttributeName`	`string` A fully-qualified path representing DataAttribute resource.

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

matchDataTaxonomyIdFromDataTaxonomyName(dataTaxonomyName)

matchDataTaxonomyIdFromDataTaxonomyName(dataTaxonomyName: string): string | number;

Parse the data_taxonomy_id from DataTaxonomy resource.

Parameter
Name	Description
`dataTaxonomyName`	`string` A fully-qualified path representing DataTaxonomy resource.

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

matchEncryptionConfigFromEncryptionConfigName(encryptionConfigName)

matchEncryptionConfigFromEncryptionConfigName(encryptionConfigName: string): string | number;

Parse the encryption_config from EncryptionConfig resource.

Parameter
Name	Description
`encryptionConfigName`	`string` A fully-qualified path representing EncryptionConfig resource.

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

matchEntityFromEntityName(entityName)

matchEntityFromEntityName(entityName: string): string | number;

Parse the entity from Entity resource.

Parameter
Name	Description
`entityName`	`string` A fully-qualified path representing Entity resource.

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

matchEntityFromPartitionName(partitionName)

matchEntityFromPartitionName(partitionName: string): string | number;

Parse the entity from Partition resource.

Parameter
Name	Description
`partitionName`	`string` A fully-qualified path representing Partition resource.

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

matchEntryFromEntryName(entryName)

matchEntryFromEntryName(entryName: string): string | number;

Parse the entry from Entry resource.

Parameter
Name	Description
`entryName`	`string` A fully-qualified path representing Entry resource.

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

matchEntryGroupFromEntryGroupName(entryGroupName)

matchEntryGroupFromEntryGroupName(entryGroupName: string): string | number;

Parse the entry_group from EntryGroup resource.

Parameter
Name	Description
`entryGroupName`	`string` A fully-qualified path representing EntryGroup resource.

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

matchEntryGroupFromEntryLinkName(entryLinkName)

matchEntryGroupFromEntryLinkName(entryLinkName: string): string | number;

Parse the entry_group from EntryLink resource.

Parameter
Name	Description
`entryLinkName`	`string` A fully-qualified path representing EntryLink resource.

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

matchEntryGroupFromEntryName(entryName)

matchEntryGroupFromEntryName(entryName: string): string | number;

Parse the entry_group from Entry resource.

Parameter
Name	Description
`entryName`	`string` A fully-qualified path representing Entry resource.

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

matchEntryLinkFromEntryLinkName(entryLinkName)

matchEntryLinkFromEntryLinkName(entryLinkName: string): string | number;

Parse the entry_link from EntryLink resource.

Parameter
Name	Description
`entryLinkName`	`string` A fully-qualified path representing EntryLink resource.

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

matchEntryTypeFromEntryTypeName(entryTypeName)

matchEntryTypeFromEntryTypeName(entryTypeName: string): string | number;

Parse the entry_type from EntryType resource.

Parameter
Name	Description
`entryTypeName`	`string` A fully-qualified path representing EntryType resource.

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

matchEnvironmentFromEnvironmentName(environmentName)

matchEnvironmentFromEnvironmentName(environmentName: string): string | number;

Parse the environment from Environment resource.

Parameter
Name	Description
`environmentName`	`string` A fully-qualified path representing Environment resource.

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

matchEnvironmentFromSessionName(sessionName)

matchEnvironmentFromSessionName(sessionName: string): string | number;

Parse the environment from Session resource.

Parameter
Name	Description
`sessionName`	`string` A fully-qualified path representing Session resource.

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

matchGlossaryCategoryFromGlossaryCategoryName(glossaryCategoryName)

matchGlossaryCategoryFromGlossaryCategoryName(glossaryCategoryName: string): string | number;

Parse the glossary_category from GlossaryCategory resource.

Parameter
Name	Description
`glossaryCategoryName`	`string` A fully-qualified path representing GlossaryCategory resource.

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

matchGlossaryFromGlossaryCategoryName(glossaryCategoryName)

matchGlossaryFromGlossaryCategoryName(glossaryCategoryName: string): string | number;

Parse the glossary from GlossaryCategory resource.

Parameter
Name	Description
`glossaryCategoryName`	`string` A fully-qualified path representing GlossaryCategory resource.

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

matchGlossaryFromGlossaryName(glossaryName)

matchGlossaryFromGlossaryName(glossaryName: string): string | number;

Parse the glossary from Glossary resource.

Parameter
Name	Description
`glossaryName`	`string` A fully-qualified path representing Glossary resource.

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

matchGlossaryFromGlossaryTermName(glossaryTermName)

matchGlossaryFromGlossaryTermName(glossaryTermName: string): string | number;

Parse the glossary from GlossaryTerm resource.

Parameter
Name	Description
`glossaryTermName`	`string` A fully-qualified path representing GlossaryTerm resource.

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

matchGlossaryTermFromGlossaryTermName(glossaryTermName)

matchGlossaryTermFromGlossaryTermName(glossaryTermName: string): string | number;

Parse the glossary_term from GlossaryTerm resource.

Parameter
Name	Description
`glossaryTermName`	`string` A fully-qualified path representing GlossaryTerm resource.

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

matchJobFromDataScanJobName(dataScanJobName)

matchJobFromDataScanJobName(dataScanJobName: string): string | number;

Parse the job from DataScanJob resource.

Parameter
Name	Description
`dataScanJobName`	`string` A fully-qualified path representing DataScanJob resource.

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

matchJobFromJobName(jobName)

matchJobFromJobName(jobName: string): string | number;

Parse the job from Job resource.

Parameter
Name	Description
`jobName`	`string` A fully-qualified path representing Job resource.

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

matchLakeFromAssetName(assetName)

matchLakeFromAssetName(assetName: string): string | number;

Parse the lake from Asset resource.

Parameter
Name	Description
`assetName`	`string` A fully-qualified path representing Asset resource.

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

matchLakeFromContentName(contentName)

matchLakeFromContentName(contentName: string): string | number;

Parse the lake from Content resource.

Parameter
Name	Description
`contentName`	`string` A fully-qualified path representing Content resource.

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

matchLakeFromEntityName(entityName)

matchLakeFromEntityName(entityName: string): string | number;

Parse the lake from Entity resource.

Parameter
Name	Description
`entityName`	`string` A fully-qualified path representing Entity resource.

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

matchLakeFromEnvironmentName(environmentName)

matchLakeFromEnvironmentName(environmentName: string): string | number;

Parse the lake from Environment resource.

Parameter
Name	Description
`environmentName`	`string` A fully-qualified path representing Environment resource.

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

matchLakeFromJobName(jobName)

matchLakeFromJobName(jobName: string): string | number;

Parse the lake from Job resource.

Parameter
Name	Description
`jobName`	`string` A fully-qualified path representing Job resource.

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

matchLakeFromLakeName(lakeName)

matchLakeFromLakeName(lakeName: string): string | number;

Parse the lake from Lake resource.

Parameter
Name	Description
`lakeName`	`string` A fully-qualified path representing Lake resource.

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

matchLakeFromPartitionName(partitionName)

matchLakeFromPartitionName(partitionName: string): string | number;

Parse the lake from Partition resource.

Parameter
Name	Description
`partitionName`	`string` A fully-qualified path representing Partition resource.

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

matchLakeFromProjectLocationLakeActionName(projectLocationLakeActionName)

matchLakeFromProjectLocationLakeActionName(projectLocationLakeActionName: string): string | number;

Parse the lake from ProjectLocationLakeAction resource.

Parameter
Name	Description
`projectLocationLakeActionName`	`string` A fully-qualified path representing project_location_lake_action resource.

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

matchLakeFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName)

matchLakeFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName: string): string | number;

Parse the lake from ProjectLocationLakeZoneAction resource.

Parameter
Name	Description
`projectLocationLakeZoneActionName`	`string` A fully-qualified path representing project_location_lake_zone_action resource.

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

matchLakeFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName)

matchLakeFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName: string): string | number;

Parse the lake from ProjectLocationLakeZoneAssetAction resource.

Parameter
Name	Description
`projectLocationLakeZoneAssetActionName`	`string` A fully-qualified path representing project_location_lake_zone_asset_action resource.

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

matchLakeFromSessionName(sessionName)

matchLakeFromSessionName(sessionName: string): string | number;

Parse the lake from Session resource.

Parameter
Name	Description
`sessionName`	`string` A fully-qualified path representing Session resource.

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

matchLakeFromTaskName(taskName)

matchLakeFromTaskName(taskName: string): string | number;

Parse the lake from Task resource.

Parameter
Name	Description
`taskName`	`string` A fully-qualified path representing Task resource.

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

matchLakeFromZoneName(zoneName)

matchLakeFromZoneName(zoneName: string): string | number;

Parse the lake from Zone resource.

Parameter
Name	Description
`zoneName`	`string` A fully-qualified path representing Zone resource.

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

matchLocationFromAspectTypeName(aspectTypeName)

matchLocationFromAspectTypeName(aspectTypeName: string): string | number;

Parse the location from AspectType resource.

Parameter
Name	Description
`aspectTypeName`	`string` A fully-qualified path representing AspectType resource.

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

matchLocationFromAssetName(assetName)

matchLocationFromAssetName(assetName: string): string | number;

Parse the location from Asset resource.

Parameter
Name	Description
`assetName`	`string` A fully-qualified path representing Asset resource.

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

matchLocationFromContentName(contentName)

matchLocationFromContentName(contentName: string): string | number;

Parse the location from Content resource.

Parameter
Name	Description
`contentName`	`string` A fully-qualified path representing Content resource.

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

matchLocationFromDataAssetName(dataAssetName)

matchLocationFromDataAssetName(dataAssetName: string): string | number;

Parse the location from DataAsset resource.

Parameter
Name	Description
`dataAssetName`	`string` A fully-qualified path representing DataAsset resource.

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

matchLocationFromDataAttributeBindingName(dataAttributeBindingName)

matchLocationFromDataAttributeBindingName(dataAttributeBindingName: string): string | number;

Parse the location from DataAttributeBinding resource.

Parameter
Name	Description
`dataAttributeBindingName`	`string` A fully-qualified path representing DataAttributeBinding resource.

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

matchLocationFromDataAttributeName(dataAttributeName)

matchLocationFromDataAttributeName(dataAttributeName: string): string | number;

Parse the location from DataAttribute resource.

Parameter
Name	Description
`dataAttributeName`	`string` A fully-qualified path representing DataAttribute resource.

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

matchLocationFromDataProductName(dataProductName)

matchLocationFromDataProductName(dataProductName: string): string | number;

Parse the location from DataProduct resource.

Parameter
Name	Description
`dataProductName`	`string` A fully-qualified path representing DataProduct resource.

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

matchLocationFromDataScanJobName(dataScanJobName)

matchLocationFromDataScanJobName(dataScanJobName: string): string | number;

Parse the location from DataScanJob resource.

Parameter
Name	Description
`dataScanJobName`	`string` A fully-qualified path representing DataScanJob resource.

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

matchLocationFromDataScanName(dataScanName)

matchLocationFromDataScanName(dataScanName: string): string | number;

Parse the location from DataScan resource.

Parameter
Name	Description
`dataScanName`	`string` A fully-qualified path representing DataScan resource.

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

matchLocationFromDataTaxonomyName(dataTaxonomyName)

matchLocationFromDataTaxonomyName(dataTaxonomyName: string): string | number;

Parse the location from DataTaxonomy resource.

Parameter
Name	Description
`dataTaxonomyName`	`string` A fully-qualified path representing DataTaxonomy resource.

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

matchLocationFromEncryptionConfigName(encryptionConfigName)

matchLocationFromEncryptionConfigName(encryptionConfigName: string): string | number;

Parse the location from EncryptionConfig resource.

Parameter
Name	Description
`encryptionConfigName`	`string` A fully-qualified path representing EncryptionConfig resource.

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

matchLocationFromEntityName(entityName)

matchLocationFromEntityName(entityName: string): string | number;

Parse the location from Entity resource.

Parameter
Name	Description
`entityName`	`string` A fully-qualified path representing Entity resource.

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

matchLocationFromEntryGroupName(entryGroupName)

matchLocationFromEntryGroupName(entryGroupName: string): string | number;

Parse the location from EntryGroup resource.

Parameter
Name	Description
`entryGroupName`	`string` A fully-qualified path representing EntryGroup resource.

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

matchLocationFromEntryLinkName(entryLinkName)

matchLocationFromEntryLinkName(entryLinkName: string): string | number;

Parse the location from EntryLink resource.

Parameter
Name	Description
`entryLinkName`	`string` A fully-qualified path representing EntryLink resource.

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

matchLocationFromEntryName(entryName)

matchLocationFromEntryName(entryName: string): string | number;

Parse the location from Entry resource.

Parameter
Name	Description
`entryName`	`string` A fully-qualified path representing Entry resource.

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

matchLocationFromEntryTypeName(entryTypeName)

matchLocationFromEntryTypeName(entryTypeName: string): string | number;

Parse the location from EntryType resource.

Parameter
Name	Description
`entryTypeName`	`string` A fully-qualified path representing EntryType resource.

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

matchLocationFromEnvironmentName(environmentName)

matchLocationFromEnvironmentName(environmentName: string): string | number;

Parse the location from Environment resource.

Parameter
Name	Description
`environmentName`	`string` A fully-qualified path representing Environment resource.

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

matchLocationFromGlossaryCategoryName(glossaryCategoryName)

matchLocationFromGlossaryCategoryName(glossaryCategoryName: string): string | number;

Parse the location from GlossaryCategory resource.

Parameter
Name	Description
`glossaryCategoryName`	`string` A fully-qualified path representing GlossaryCategory resource.

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

matchLocationFromGlossaryName(glossaryName)

matchLocationFromGlossaryName(glossaryName: string): string | number;

Parse the location from Glossary resource.

Parameter
Name	Description
`glossaryName`	`string` A fully-qualified path representing Glossary resource.

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

matchLocationFromGlossaryTermName(glossaryTermName)

matchLocationFromGlossaryTermName(glossaryTermName: string): string | number;

Parse the location from GlossaryTerm resource.

Parameter
Name	Description
`glossaryTermName`	`string` A fully-qualified path representing GlossaryTerm resource.

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

matchLocationFromJobName(jobName)

matchLocationFromJobName(jobName: string): string | number;

Parse the location from Job resource.

Parameter
Name	Description
`jobName`	`string` A fully-qualified path representing Job resource.

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

matchLocationFromLakeName(lakeName)

matchLocationFromLakeName(lakeName: string): string | number;

Parse the location from Lake resource.

Parameter
Name	Description
`lakeName`	`string` A fully-qualified path representing Lake resource.

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

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

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

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

matchLocationFromMetadataFeedName(metadataFeedName)

matchLocationFromMetadataFeedName(metadataFeedName: string): string | number;

Parse the location from MetadataFeed resource.

Parameter
Name	Description
`metadataFeedName`	`string` A fully-qualified path representing MetadataFeed resource.

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

matchLocationFromMetadataJobName(metadataJobName)

matchLocationFromMetadataJobName(metadataJobName: string): string | number;

Parse the location from MetadataJob resource.

Parameter
Name	Description
`metadataJobName`	`string` A fully-qualified path representing MetadataJob resource.

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

matchLocationFromOrganizationLocationName(organizationLocationName)

matchLocationFromOrganizationLocationName(organizationLocationName: string): string | number;

Parse the location from OrganizationLocation resource.

Parameter
Name	Description
`organizationLocationName`	`string` A fully-qualified path representing OrganizationLocation resource.

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

matchLocationFromPartitionName(partitionName)

matchLocationFromPartitionName(partitionName: string): string | number;

Parse the location from Partition resource.

Parameter
Name	Description
`partitionName`	`string` A fully-qualified path representing Partition resource.

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

matchLocationFromProjectLocationLakeActionName(projectLocationLakeActionName)

matchLocationFromProjectLocationLakeActionName(projectLocationLakeActionName: string): string | number;

Parse the location from ProjectLocationLakeAction resource.

Parameter
Name	Description
`projectLocationLakeActionName`	`string` A fully-qualified path representing project_location_lake_action resource.

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

matchLocationFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName)

matchLocationFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName: string): string | number;

Parse the location from ProjectLocationLakeZoneAction resource.

Parameter
Name	Description
`projectLocationLakeZoneActionName`	`string` A fully-qualified path representing project_location_lake_zone_action resource.

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

matchLocationFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName)

matchLocationFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName: string): string | number;

Parse the location from ProjectLocationLakeZoneAssetAction resource.

Parameter
Name	Description
`projectLocationLakeZoneAssetActionName`	`string` A fully-qualified path representing project_location_lake_zone_asset_action resource.

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

matchLocationFromSessionName(sessionName)

matchLocationFromSessionName(sessionName: string): string | number;

Parse the location from Session resource.

Parameter
Name	Description
`sessionName`	`string` A fully-qualified path representing Session resource.

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

matchLocationFromTaskName(taskName)

matchLocationFromTaskName(taskName: string): string | number;

Parse the location from Task resource.

Parameter
Name	Description
`taskName`	`string` A fully-qualified path representing Task resource.

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

matchLocationFromZoneName(zoneName)

matchLocationFromZoneName(zoneName: string): string | number;

Parse the location from Zone resource.

Parameter
Name	Description
`zoneName`	`string` A fully-qualified path representing Zone resource.

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

matchMetadataFeedFromMetadataFeedName(metadataFeedName)

matchMetadataFeedFromMetadataFeedName(metadataFeedName: string): string | number;

Parse the metadata_feed from MetadataFeed resource.

Parameter
Name	Description
`metadataFeedName`	`string` A fully-qualified path representing MetadataFeed resource.

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

matchMetadataJobFromMetadataJobName(metadataJobName)

matchMetadataJobFromMetadataJobName(metadataJobName: string): string | number;

Parse the metadataJob from MetadataJob resource.

Parameter
Name	Description
`metadataJobName`	`string` A fully-qualified path representing MetadataJob resource.

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

matchOrganizationFromEncryptionConfigName(encryptionConfigName)

matchOrganizationFromEncryptionConfigName(encryptionConfigName: string): string | number;

Parse the organization from EncryptionConfig resource.

Parameter
Name	Description
`encryptionConfigName`	`string` A fully-qualified path representing EncryptionConfig resource.

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

matchOrganizationFromOrganizationLocationName(organizationLocationName)

matchOrganizationFromOrganizationLocationName(organizationLocationName: string): string | number;

Parse the organization from OrganizationLocation resource.

Parameter
Name	Description
`organizationLocationName`	`string` A fully-qualified path representing OrganizationLocation resource.

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

matchOrganizationFromOrganizationName(organizationName)

matchOrganizationFromOrganizationName(organizationName: string): string | number;

Parse the organization from Organization resource.

Parameter
Name	Description
`organizationName`	`string` A fully-qualified path representing Organization resource.

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

matchPartitionFromPartitionName(partitionName)

matchPartitionFromPartitionName(partitionName: string): string | number;

Parse the partition from Partition resource.

Parameter
Name	Description
`partitionName`	`string` A fully-qualified path representing Partition resource.

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

matchProjectFromAspectTypeName(aspectTypeName)

matchProjectFromAspectTypeName(aspectTypeName: string): string | number;

Parse the project from AspectType resource.

Parameter
Name	Description
`aspectTypeName`	`string` A fully-qualified path representing AspectType resource.

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

matchProjectFromAssetName(assetName)

matchProjectFromAssetName(assetName: string): string | number;

Parse the project from Asset resource.

Parameter
Name	Description
`assetName`	`string` A fully-qualified path representing Asset resource.

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

matchProjectFromContentName(contentName)

matchProjectFromContentName(contentName: string): string | number;

Parse the project from Content resource.

Parameter
Name	Description
`contentName`	`string` A fully-qualified path representing Content resource.

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

matchProjectFromDataAssetName(dataAssetName)

matchProjectFromDataAssetName(dataAssetName: string): string | number;

Parse the project from DataAsset resource.

Parameter
Name	Description
`dataAssetName`	`string` A fully-qualified path representing DataAsset resource.

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

matchProjectFromDataAttributeBindingName(dataAttributeBindingName)

matchProjectFromDataAttributeBindingName(dataAttributeBindingName: string): string | number;

Parse the project from DataAttributeBinding resource.

Parameter
Name	Description
`dataAttributeBindingName`	`string` A fully-qualified path representing DataAttributeBinding resource.

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

matchProjectFromDataAttributeName(dataAttributeName)

matchProjectFromDataAttributeName(dataAttributeName: string): string | number;

Parse the project from DataAttribute resource.

Parameter
Name	Description
`dataAttributeName`	`string` A fully-qualified path representing DataAttribute resource.

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

matchProjectFromDataProductName(dataProductName)

matchProjectFromDataProductName(dataProductName: string): string | number;

Parse the project from DataProduct resource.

Parameter
Name	Description
`dataProductName`	`string` A fully-qualified path representing DataProduct resource.

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

matchProjectFromDataScanJobName(dataScanJobName)

matchProjectFromDataScanJobName(dataScanJobName: string): string | number;

Parse the project from DataScanJob resource.

Parameter
Name	Description
`dataScanJobName`	`string` A fully-qualified path representing DataScanJob resource.

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

matchProjectFromDataScanName(dataScanName)

matchProjectFromDataScanName(dataScanName: string): string | number;

Parse the project from DataScan resource.

Parameter
Name	Description
`dataScanName`	`string` A fully-qualified path representing DataScan resource.

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

matchProjectFromDataTaxonomyName(dataTaxonomyName)

matchProjectFromDataTaxonomyName(dataTaxonomyName: string): string | number;

Parse the project from DataTaxonomy resource.

Parameter
Name	Description
`dataTaxonomyName`	`string` A fully-qualified path representing DataTaxonomy resource.

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

matchProjectFromEntityName(entityName)

matchProjectFromEntityName(entityName: string): string | number;

Parse the project from Entity resource.

Parameter
Name	Description
`entityName`	`string` A fully-qualified path representing Entity resource.

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

matchProjectFromEntryGroupName(entryGroupName)

matchProjectFromEntryGroupName(entryGroupName: string): string | number;

Parse the project from EntryGroup resource.

Parameter
Name	Description
`entryGroupName`	`string` A fully-qualified path representing EntryGroup resource.

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

matchProjectFromEntryLinkName(entryLinkName)

matchProjectFromEntryLinkName(entryLinkName: string): string | number;

Parse the project from EntryLink resource.

Parameter
Name	Description
`entryLinkName`	`string` A fully-qualified path representing EntryLink resource.

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

matchProjectFromEntryName(entryName)

matchProjectFromEntryName(entryName: string): string | number;

Parse the project from Entry resource.

Parameter
Name	Description
`entryName`	`string` A fully-qualified path representing Entry resource.

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

matchProjectFromEntryTypeName(entryTypeName)

matchProjectFromEntryTypeName(entryTypeName: string): string | number;

Parse the project from EntryType resource.

Parameter
Name	Description
`entryTypeName`	`string` A fully-qualified path representing EntryType resource.

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

matchProjectFromEnvironmentName(environmentName)

matchProjectFromEnvironmentName(environmentName: string): string | number;

Parse the project from Environment resource.

Parameter
Name	Description
`environmentName`	`string` A fully-qualified path representing Environment resource.

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

matchProjectFromGlossaryCategoryName(glossaryCategoryName)

matchProjectFromGlossaryCategoryName(glossaryCategoryName: string): string | number;

Parse the project from GlossaryCategory resource.

Parameter
Name	Description
`glossaryCategoryName`	`string` A fully-qualified path representing GlossaryCategory resource.

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

matchProjectFromGlossaryName(glossaryName)

matchProjectFromGlossaryName(glossaryName: string): string | number;

Parse the project from Glossary resource.

Parameter
Name	Description
`glossaryName`	`string` A fully-qualified path representing Glossary resource.

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

matchProjectFromGlossaryTermName(glossaryTermName)

matchProjectFromGlossaryTermName(glossaryTermName: string): string | number;

Parse the project from GlossaryTerm resource.

Parameter
Name	Description
`glossaryTermName`	`string` A fully-qualified path representing GlossaryTerm resource.

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

matchProjectFromJobName(jobName)

matchProjectFromJobName(jobName: string): string | number;

Parse the project from Job resource.

Parameter
Name	Description
`jobName`	`string` A fully-qualified path representing Job resource.

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

matchProjectFromLakeName(lakeName)

matchProjectFromLakeName(lakeName: string): string | number;

Parse the project from Lake resource.

Parameter
Name	Description
`lakeName`	`string` A fully-qualified path representing Lake resource.

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

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

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

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

matchProjectFromMetadataFeedName(metadataFeedName)

matchProjectFromMetadataFeedName(metadataFeedName: string): string | number;

Parse the project from MetadataFeed resource.

Parameter
Name	Description
`metadataFeedName`	`string` A fully-qualified path representing MetadataFeed resource.

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

matchProjectFromMetadataJobName(metadataJobName)

matchProjectFromMetadataJobName(metadataJobName: string): string | number;

Parse the project from MetadataJob resource.

Parameter
Name	Description
`metadataJobName`	`string` A fully-qualified path representing MetadataJob resource.

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

matchProjectFromPartitionName(partitionName)

matchProjectFromPartitionName(partitionName: string): string | number;

Parse the project from Partition resource.

Parameter
Name	Description
`partitionName`	`string` A fully-qualified path representing Partition resource.

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

matchProjectFromProjectLocationLakeActionName(projectLocationLakeActionName)

matchProjectFromProjectLocationLakeActionName(projectLocationLakeActionName: string): string | number;

Parse the project from ProjectLocationLakeAction resource.

Parameter
Name	Description
`projectLocationLakeActionName`	`string` A fully-qualified path representing project_location_lake_action resource.

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

matchProjectFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName)

matchProjectFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName: string): string | number;

Parse the project from ProjectLocationLakeZoneAction resource.

Parameter
Name	Description
`projectLocationLakeZoneActionName`	`string` A fully-qualified path representing project_location_lake_zone_action resource.

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

matchProjectFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName)

matchProjectFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName: string): string | number;

Parse the project from ProjectLocationLakeZoneAssetAction resource.

Parameter
Name	Description
`projectLocationLakeZoneAssetActionName`	`string` A fully-qualified path representing project_location_lake_zone_asset_action resource.

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

matchProjectFromSessionName(sessionName)

matchProjectFromSessionName(sessionName: string): string | number;

Parse the project from Session resource.

Parameter
Name	Description
`sessionName`	`string` A fully-qualified path representing Session resource.

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

matchProjectFromTaskName(taskName)

matchProjectFromTaskName(taskName: string): string | number;

Parse the project from Task resource.

Parameter
Name	Description
`taskName`	`string` A fully-qualified path representing Task resource.

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

matchProjectFromZoneName(zoneName)

matchProjectFromZoneName(zoneName: string): string | number;

Parse the project from Zone resource.

Parameter
Name	Description
`zoneName`	`string` A fully-qualified path representing Zone resource.

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

matchSessionFromSessionName(sessionName)

matchSessionFromSessionName(sessionName: string): string | number;

Parse the session from Session resource.

Parameter
Name	Description
`sessionName`	`string` A fully-qualified path representing Session resource.

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

matchTaskFromJobName(jobName)

matchTaskFromJobName(jobName: string): string | number;

Parse the task from Job resource.

Parameter
Name	Description
`jobName`	`string` A fully-qualified path representing Job resource.

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

matchTaskFromTaskName(taskName)

matchTaskFromTaskName(taskName: string): string | number;

Parse the task from Task resource.

Parameter
Name	Description
`taskName`	`string` A fully-qualified path representing Task resource.

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

matchZoneFromAssetName(assetName)

matchZoneFromAssetName(assetName: string): string | number;

Parse the zone from Asset resource.

Parameter
Name	Description
`assetName`	`string` A fully-qualified path representing Asset resource.

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

matchZoneFromEntityName(entityName)

matchZoneFromEntityName(entityName: string): string | number;

Parse the zone from Entity resource.

Parameter
Name	Description
`entityName`	`string` A fully-qualified path representing Entity resource.

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

matchZoneFromPartitionName(partitionName)

matchZoneFromPartitionName(partitionName: string): string | number;

Parse the zone from Partition resource.

Parameter
Name	Description
`partitionName`	`string` A fully-qualified path representing Partition resource.

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

matchZoneFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName)

matchZoneFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName: string): string | number;

Parse the zone from ProjectLocationLakeZoneAction resource.

Parameter
Name	Description
`projectLocationLakeZoneActionName`	`string` A fully-qualified path representing project_location_lake_zone_action resource.

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

matchZoneFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName)

matchZoneFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName: string): string | number;

Parse the zone from ProjectLocationLakeZoneAssetAction resource.

Parameter
Name	Description
`projectLocationLakeZoneAssetActionName`	`string` A fully-qualified path representing project_location_lake_zone_asset_action resource.

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

matchZoneFromZoneName(zoneName)

matchZoneFromZoneName(zoneName: string): string | number;

Parse the zone from Zone resource.

Parameter
Name	Description
`zoneName`	`string` A fully-qualified path representing Zone resource.

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

metadataFeedPath(project, location, metadataFeed)

metadataFeedPath(project: string, location: string, metadataFeed: string): string;

Return a fully-qualified metadataFeed resource name string.

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

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

metadataJobPath(project, location, metadataJob)

metadataJobPath(project: string, location: string, metadataJob: string): string;

Return a fully-qualified metadataJob resource name string.

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

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

organizationLocationPath(organization, location)

organizationLocationPath(organization: string, location: string): string;

Return a fully-qualified organizationLocation resource name string.

Parameters
Name	Description
`organization`	`string`
`location`	`string`

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

organizationPath(organization)

organizationPath(organization: string): string;

Return a fully-qualified organization resource name string.

Parameter
Name	Description
`organization`	`string`

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

partitionPath(project, location, lake, zone, entity, partition)

partitionPath(project: string, location: string, lake: string, zone: string, entity: string, partition: string): string;

Return a fully-qualified partition resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`lake`	`string`
`zone`	`string`
`entity`	`string`
`partition`	`string`

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

projectLocationLakeActionPath(project, location, lake, action)

projectLocationLakeActionPath(project: string, location: string, lake: string, action: string): string;

Return a fully-qualified projectLocationLakeAction resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`lake`	`string`
`action`	`string`

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

projectLocationLakeZoneActionPath(project, location, lake, zone, action)

projectLocationLakeZoneActionPath(project: string, location: string, lake: string, zone: string, action: string): string;

Return a fully-qualified projectLocationLakeZoneAction resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`lake`	`string`
`zone`	`string`
`action`	`string`

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

projectLocationLakeZoneAssetActionPath(project, location, lake, zone, asset, action)

projectLocationLakeZoneAssetActionPath(project: string, location: string, lake: string, zone: string, asset: string, action: string): string;

Return a fully-qualified projectLocationLakeZoneAssetAction resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`lake`	`string`
`zone`	`string`
`asset`	`string`
`action`	`string`

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

sessionPath(project, location, lake, environment, session)

sessionPath(project: string, location: string, lake: string, environment: string, session: string): string;

Return a fully-qualified session resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`lake`	`string`
`environment`	`string`
`session`	`string`

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

taskPath(project, location, lake, task)

taskPath(project: string, location: string, lake: string, task: string): string;

Return a fully-qualified task resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`lake`	`string`
`task`	`string`

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

updateEncryptionConfig(request, options)

updateEncryptionConfig(request?: protos.google.cloud.dataplex.v1.IUpdateEncryptionConfigRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.dataplex.v1.IEncryptionConfig, protos.google.cloud.dataplex.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Update an EncryptionConfig.

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

Returns
Type	Description
`Promise<[ LROperation<protos.google.cloud.dataplex.v1.IEncryptionConfig, protos.google.cloud.dataplex.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its `promise()` method returns a promise you can `await` for. 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 EncryptionConfig to update.
   */
  // const encryptionConfig = {}
  /**
   *  Optional. Mask of fields to update.
   *  The service treats an omitted field mask as an implied field mask
   *  equivalent to all fields that are populated (have a non-empty value).
   */
  // const updateMask = {}

  // Imports the Dataplex library
  const {CmekServiceClient} = require('@google-cloud/dataplex').v1;

  // Instantiates a client
  const dataplexClient = new CmekServiceClient();

  async function callUpdateEncryptionConfig() {
    // Construct request
    const request = {
      encryptionConfig,
    };

    // Run request
    const [operation] = await dataplexClient.updateEncryptionConfig(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdateEncryptionConfig();

updateEncryptionConfig(request, options, callback)

updateEncryptionConfig(request: protos.google.cloud.dataplex.v1.IUpdateEncryptionConfigRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.dataplex.v1.IEncryptionConfig, protos.google.cloud.dataplex.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IUpdateEncryptionConfigRequest`
`options`	`CallOptions`
`callback`	`Callback<LROperation<protos.google.cloud.dataplex.v1.IEncryptionConfig, protos.google.cloud.dataplex.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

updateEncryptionConfig(request, callback)

updateEncryptionConfig(request: protos.google.cloud.dataplex.v1.IUpdateEncryptionConfigRequest, callback: Callback<LROperation<protos.google.cloud.dataplex.v1.IEncryptionConfig, protos.google.cloud.dataplex.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IUpdateEncryptionConfigRequest`
`callback`	`Callback<LROperation<protos.google.cloud.dataplex.v1.IEncryptionConfig, protos.google.cloud.dataplex.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

zonePath(project, location, lake, zone)

zonePath(project: string, location: string, lake: string, zone: string): string;

Return a fully-qualified zone resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`lake`	`string`
`zone`	`string`

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

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

Package

Constructors

(constructor)(opts, gaxInstance)

Properties

apiEndpoint

apiEndpoint

auth

cmekServiceStub

descriptors

innerApiCalls

locationsClient

operationsClient

pathTemplates

port

scopes

servicePath

universeDomain

warn

Methods

aspectTypePath(project, location, aspectType)

assetPath(project, location, lake, zone, asset)

cancelOperation(request, optionsOrCallback, callback)

checkCreateEncryptionConfigProgress(name)

checkDeleteEncryptionConfigProgress(name)

checkUpdateEncryptionConfigProgress(name)

close()

contentPath(project, location, lake, content)

createEncryptionConfig(request, options)

createEncryptionConfig(request, options, callback)

createEncryptionConfig(request, callback)

dataAssetPath(project, location, dataProduct, dataAsset)

dataAttributeBindingPath(project, location, dataAttributeBindingId)

dataAttributePath(project, location, dataTaxonomy, dataAttributeId)

dataProductPath(project, location, dataProduct)

dataScanJobPath(project, location, dataScan, job)

dataScanPath(project, location, dataScan)

dataTaxonomyPath(project, location, dataTaxonomyId)

deleteEncryptionConfig(request, options)

deleteEncryptionConfig(request, options, callback)

deleteEncryptionConfig(request, callback)

deleteOperation(request, optionsOrCallback, callback)

encryptionConfigPath(organization, location, encryptionConfig)

entityPath(project, location, lake, zone, entity)

entryGroupPath(project, location, entryGroup)

entryLinkPath(project, location, entryGroup, entryLink)

entryPath(project, location, entryGroup, entry)

entryTypePath(project, location, entryType)

environmentPath(project, location, lake, environment)

getEncryptionConfig(request, options)

getEncryptionConfig(request, options, callback)

getEncryptionConfig(request, callback)

getLocation(request, options, callback)

getOperation(request, optionsOrCallback, callback)

getProjectId()

getProjectId(callback)

glossaryCategoryPath(project, location, glossary, glossaryCategory)

glossaryPath(project, location, glossary)

glossaryTermPath(project, location, glossary, glossaryTerm)

initialize()

jobPath(project, location, lake, task, job)

lakePath(project, location, lake)

listEncryptionConfigs(request, options)

listEncryptionConfigs(request, options, callback)

listEncryptionConfigs(request, callback)

listEncryptionConfigsAsync(request, options)

listEncryptionConfigsStream(request, options)

listLocationsAsync(request, options)

listOperationsAsync(request, options)

locationPath(project, location)

matchActionFromProjectLocationLakeActionName(projectLocationLakeActionName)

matchActionFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName)

matchActionFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName)

matchAspectTypeFromAspectTypeName(aspectTypeName)

matchAssetFromAssetName(assetName)

matchAssetFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName)

matchContentFromContentName(contentName)

matchDataAssetFromDataAssetName(dataAssetName)

matchDataAttributeBindingIdFromDataAttributeBindingName(dataAttributeBindingName)

matchDataAttributeIdFromDataAttributeName(dataAttributeName)

Class v1.CmekServiceClient (5.4.0)