Class v1.CatalogServiceClient (3.7.0)

The primary resources offered by this service are EntryGroups, EntryTypes, AspectTypes, Entry and Aspect which collectively allow a data administrator to organize, manage, secure and catalog data across their organization located across cloud projects in a variety of storage systems including Cloud Storage and BigQuery. v1

Package

@google-cloud/dataplex

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of CatalogServiceClient.

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 CatalogServiceClient({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;

catalogServiceStub

catalogServiceStub?: 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, options, callback)

cancelOperation(request: protos.google.longrunning.CancelOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | 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.
`options`	`CallOptions \| Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} \| undefined \| null>` Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
`callback`	`Callback<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: ''});

checkCreateAspectTypeProgress(name)

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

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

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

Returns
Type	Description
`Promise<LROperation<protos.google.cloud.dataplex.v1.AspectType, 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 resource name of the AspectType, of the form:
   *  projects/{project_number}/locations/{location_id}
   *  where `location_id` refers to a GCP region.
   */
  // const parent = 'abc123'
  /**
   *  Required. AspectType identifier.
   */
  // const aspectTypeId = 'abc123'
  /**
   *  Required. AspectType Resource
   */
  // const aspectType = {}
  /**
   *  Optional. Only validate the request, but do not perform mutations.
   *  The default is false.
   */
  // const validateOnly = true

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

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

  async function callCreateAspectType() {
    // Construct request
    const request = {
      parent,
      aspectTypeId,
      aspectType,
    };

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

  callCreateAspectType();

checkCreateEntryGroupProgress(name)

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

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

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

Returns
Type	Description
`Promise<LROperation<protos.google.cloud.dataplex.v1.EntryGroup, 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 resource name of the entryGroup, of the form:
   *  projects/{project_number}/locations/{location_id}
   *  where `location_id` refers to a GCP region.
   */
  // const parent = 'abc123'
  /**
   *  Required. EntryGroup identifier.
   */
  // const entryGroupId = 'abc123'
  /**
   *  Required. EntryGroup Resource
   */
  // const entryGroup = {}
  /**
   *  Optional. Only validate the request, but do not perform mutations.
   *  The default is false.
   */
  // const validateOnly = true

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

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

  async function callCreateEntryGroup() {
    // Construct request
    const request = {
      parent,
      entryGroupId,
      entryGroup,
    };

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

  callCreateEntryGroup();

checkCreateEntryTypeProgress(name)

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

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

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

Returns
Type	Description
`Promise<LROperation<protos.google.cloud.dataplex.v1.EntryType, 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 resource name of the EntryType, of the form:
   *  projects/{project_number}/locations/{location_id}
   *  where `location_id` refers to a GCP region.
   */
  // const parent = 'abc123'
  /**
   *  Required. EntryType identifier.
   */
  // const entryTypeId = 'abc123'
  /**
   *  Required. EntryType Resource
   */
  // const entryType = {}
  /**
   *  Optional. Only validate the request, but do not perform mutations.
   *  The default is false.
   */
  // const validateOnly = true

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

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

  async function callCreateEntryType() {
    // Construct request
    const request = {
      parent,
      entryTypeId,
      entryType,
    };

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

  callCreateEntryType();

checkDeleteAspectTypeProgress(name)

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

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

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 resource name of the AspectType:
   *  `projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}`.
   */
  // const name = 'abc123'
  /**
   *  Optional. If the client provided etag value does not match the current etag
   *  value, the DeleteAspectTypeRequest method returns an ABORTED error response
   */
  // const etag = 'abc123'

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

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

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

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

  callDeleteAspectType();

checkDeleteEntryGroupProgress(name)

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

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

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 resource name of the EntryGroup:
   *  `projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}`.
   */
  // const name = 'abc123'
  /**
   *  Optional. If the client provided etag value does not match the current etag
   *  value, the DeleteEntryGroupRequest method returns an ABORTED error response
   */
  // const etag = 'abc123'

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

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

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

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

  callDeleteEntryGroup();

checkDeleteEntryTypeProgress(name)

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

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

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 resource name of the EntryType:
   *  `projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}`.
   */
  // const name = 'abc123'
  /**
   *  Optional. If the client provided etag value does not match the current etag
   *  value, the DeleteEntryTypeRequest method returns an ABORTED error response
   */
  // const etag = 'abc123'

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

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

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

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

  callDeleteEntryType();

checkUpdateAspectTypeProgress(name)

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

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

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

Returns
Type	Description
`Promise<LROperation<protos.google.cloud.dataplex.v1.AspectType, 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. AspectType Resource
   */
  // const aspectType = {}
  /**
   *  Required. Mask of fields to update.
   */
  // const updateMask = {}
  /**
   *  Optional. Only validate the request, but do not perform mutations.
   *  The default is false.
   */
  // const validateOnly = true

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

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

  async function callUpdateAspectType() {
    // Construct request
    const request = {
      aspectType,
      updateMask,
    };

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

  callUpdateAspectType();

checkUpdateEntryGroupProgress(name)

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

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

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

Returns
Type	Description
`Promise<LROperation<protos.google.cloud.dataplex.v1.EntryGroup, 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. EntryGroup Resource
   */
  // const entryGroup = {}
  /**
   *  Required. Mask of fields to update.
   */
  // const updateMask = {}
  /**
   *  Optional. Only validate the request, but do not perform mutations.
   *  The default is false.
   */
  // const validateOnly = true

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

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

  async function callUpdateEntryGroup() {
    // Construct request
    const request = {
      entryGroup,
      updateMask,
    };

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

  callUpdateEntryGroup();

checkUpdateEntryTypeProgress(name)

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

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

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

Returns
Type	Description
`Promise<LROperation<protos.google.cloud.dataplex.v1.EntryType, 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. EntryType Resource
   */
  // const entryType = {}
  /**
   *  Required. Mask of fields to update.
   */
  // const updateMask = {}
  /**
   *  Optional. Only validate the request, but do not perform mutations.
   *  The default is false.
   */
  // const validateOnly = true

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

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

  async function callUpdateEntryType() {
    // Construct request
    const request = {
      entryType,
      updateMask,
    };

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

  callUpdateEntryType();

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.

createAspectType(request, options)

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

Creates an AspectType

Parameters
Name	Description
`request`	`ICreateAspectTypeRequest` 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.IAspectType, 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 resource name of the AspectType, of the form:
   *  projects/{project_number}/locations/{location_id}
   *  where `location_id` refers to a GCP region.
   */
  // const parent = 'abc123'
  /**
   *  Required. AspectType identifier.
   */
  // const aspectTypeId = 'abc123'
  /**
   *  Required. AspectType Resource
   */
  // const aspectType = {}
  /**
   *  Optional. Only validate the request, but do not perform mutations.
   *  The default is false.
   */
  // const validateOnly = true

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

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

  async function callCreateAspectType() {
    // Construct request
    const request = {
      parent,
      aspectTypeId,
      aspectType,
    };

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

  callCreateAspectType();

createAspectType(request, options, callback)

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

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

Returns
Type	Description
`void`

createAspectType(request, callback)

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

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

Returns
Type	Description
`void`

createEntry(request, options)

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

Creates an Entry.

Parameters
Name	Description
`request`	`ICreateEntryRequest` 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.IEntry, protos.google.cloud.dataplex.v1.ICreateEntryRequest \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing Entry. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the parent Entry Group:
   *  `projects/{project}/locations/{location}/entryGroups/{entry_group}`.
   */
  // const parent = 'abc123'
  /**
   *  Required. Entry identifier. It has to be unique within an Entry Group.
   *  Entries corresponding to Google Cloud resources use Entry ID format based
   *  on Full Resource Names
   *  (https://cloud.google.com/apis/design/resource_names#full_resource_name).
   *  The format is a Full Resource Name of the resource without the
   *  prefix double slashes in the API Service Name part of Full Resource Name.
   *  This allows retrieval of entries using their associated resource name.
   *  For example if the Full Resource Name of a resource is
   *  `//library.googleapis.com/shelves/shelf1/books/book2`,
   *  then the suggested entry_id is
   *  `library.googleapis.com/shelves/shelf1/books/book2`.
   *  It is also suggested to follow the same convention for entries
   *  corresponding to resources from other providers or systems than Google
   *  Cloud.
   *  The maximum size of the field is 4000 characters.
   */
  // const entryId = 'abc123'
  /**
   *  Required. Entry resource.
   */
  // const entry = {}

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

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

  async function callCreateEntry() {
    // Construct request
    const request = {
      parent,
      entryId,
      entry,
    };

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

  callCreateEntry();

createEntry(request, options, callback)

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

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

Returns
Type	Description
`void`

createEntry(request, callback)

createEntry(request: protos.google.cloud.dataplex.v1.ICreateEntryRequest, callback: Callback<protos.google.cloud.dataplex.v1.IEntry, protos.google.cloud.dataplex.v1.ICreateEntryRequest | null | undefined, {} | null | undefined>): void;

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

Returns
Type	Description
`void`

createEntryGroup(request, options)

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

Creates an EntryGroup

Parameters
Name	Description
`request`	`ICreateEntryGroupRequest` 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.IEntryGroup, 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 resource name of the entryGroup, of the form:
   *  projects/{project_number}/locations/{location_id}
   *  where `location_id` refers to a GCP region.
   */
  // const parent = 'abc123'
  /**
   *  Required. EntryGroup identifier.
   */
  // const entryGroupId = 'abc123'
  /**
   *  Required. EntryGroup Resource
   */
  // const entryGroup = {}
  /**
   *  Optional. Only validate the request, but do not perform mutations.
   *  The default is false.
   */
  // const validateOnly = true

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

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

  async function callCreateEntryGroup() {
    // Construct request
    const request = {
      parent,
      entryGroupId,
      entryGroup,
    };

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

  callCreateEntryGroup();

createEntryGroup(request, options, callback)

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

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

Returns
Type	Description
`void`

createEntryGroup(request, callback)

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

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

Returns
Type	Description
`void`

createEntryType(request, options)

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

Creates an EntryType

Parameters
Name	Description
`request`	`ICreateEntryTypeRequest` 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.IEntryType, 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 resource name of the EntryType, of the form:
   *  projects/{project_number}/locations/{location_id}
   *  where `location_id` refers to a GCP region.
   */
  // const parent = 'abc123'
  /**
   *  Required. EntryType identifier.
   */
  // const entryTypeId = 'abc123'
  /**
   *  Required. EntryType Resource
   */
  // const entryType = {}
  /**
   *  Optional. Only validate the request, but do not perform mutations.
   *  The default is false.
   */
  // const validateOnly = true

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

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

  async function callCreateEntryType() {
    // Construct request
    const request = {
      parent,
      entryTypeId,
      entryType,
    };

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

  callCreateEntryType();

createEntryType(request, options, callback)

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

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

Returns
Type	Description
`void`

createEntryType(request, callback)

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

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

Returns
Type	Description
`void`

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.

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.

deleteAspectType(request, options)

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

Deletes a AspectType resource.

Parameters
Name	Description
`request`	`IDeleteAspectTypeRequest` 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 resource name of the AspectType:
   *  `projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}`.
   */
  // const name = 'abc123'
  /**
   *  Optional. If the client provided etag value does not match the current etag
   *  value, the DeleteAspectTypeRequest method returns an ABORTED error response
   */
  // const etag = 'abc123'

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

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

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

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

  callDeleteAspectType();

deleteAspectType(request, options, callback)

deleteAspectType(request: protos.google.cloud.dataplex.v1.IDeleteAspectTypeRequest, 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`	`IDeleteAspectTypeRequest`
`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`

deleteAspectType(request, callback)

deleteAspectType(request: protos.google.cloud.dataplex.v1.IDeleteAspectTypeRequest, 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`	`IDeleteAspectTypeRequest`
`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`

deleteEntry(request, options)

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

Deletes an Entry.

Parameters
Name	Description
`request`	`IDeleteEntryRequest` 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.IEntry, protos.google.cloud.dataplex.v1.IDeleteEntryRequest \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing Entry. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the Entry:
   *  `projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}`.
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteEntry();

deleteEntry(request, options, callback)

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

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

Returns
Type	Description
`void`

deleteEntry(request, callback)

deleteEntry(request: protos.google.cloud.dataplex.v1.IDeleteEntryRequest, callback: Callback<protos.google.cloud.dataplex.v1.IEntry, protos.google.cloud.dataplex.v1.IDeleteEntryRequest | null | undefined, {} | null | undefined>): void;

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

Returns
Type	Description
`void`

deleteEntryGroup(request, options)

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

Deletes a EntryGroup resource.

Parameters
Name	Description
`request`	`IDeleteEntryGroupRequest` 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 resource name of the EntryGroup:
   *  `projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}`.
   */
  // const name = 'abc123'
  /**
   *  Optional. If the client provided etag value does not match the current etag
   *  value, the DeleteEntryGroupRequest method returns an ABORTED error response
   */
  // const etag = 'abc123'

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

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

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

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

  callDeleteEntryGroup();

deleteEntryGroup(request, options, callback)

deleteEntryGroup(request: protos.google.cloud.dataplex.v1.IDeleteEntryGroupRequest, 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`	`IDeleteEntryGroupRequest`
`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`

deleteEntryGroup(request, callback)

deleteEntryGroup(request: protos.google.cloud.dataplex.v1.IDeleteEntryGroupRequest, 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`	`IDeleteEntryGroupRequest`
`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`

deleteEntryType(request, options)

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

Deletes a EntryType resource.

Parameters
Name	Description
`request`	`IDeleteEntryTypeRequest` 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 resource name of the EntryType:
   *  `projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}`.
   */
  // const name = 'abc123'
  /**
   *  Optional. If the client provided etag value does not match the current etag
   *  value, the DeleteEntryTypeRequest method returns an ABORTED error response
   */
  // const etag = 'abc123'

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

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

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

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

  callDeleteEntryType();

deleteEntryType(request, options, callback)

deleteEntryType(request: protos.google.cloud.dataplex.v1.IDeleteEntryTypeRequest, 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`	`IDeleteEntryTypeRequest`
`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`

deleteEntryType(request, callback)

deleteEntryType(request: protos.google.cloud.dataplex.v1.IDeleteEntryTypeRequest, 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`	`IDeleteEntryTypeRequest`
`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, options, callback)

deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, options?: 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.
`options`	`CallOptions \| Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} \| null \| undefined>` Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
`callback`	`Callback<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: ''});

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.

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.

getAspectType(request, options)

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

Retrieves a AspectType resource.

Parameters
Name	Description
`request`	`IGetAspectTypeRequest` 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.IAspectType, protos.google.cloud.dataplex.v1.IGetAspectTypeRequest \| 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 resource name of the AspectType:
   *  `projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}`.
   */
  // const name = 'abc123'

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

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

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

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

  callGetAspectType();

getAspectType(request, options, callback)

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

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

Returns
Type	Description
`void`

getAspectType(request, callback)

getAspectType(request: protos.google.cloud.dataplex.v1.IGetAspectTypeRequest, callback: Callback<protos.google.cloud.dataplex.v1.IAspectType, protos.google.cloud.dataplex.v1.IGetAspectTypeRequest | null | undefined, {} | null | undefined>): void;

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

Returns
Type	Description
`void`

getEntry(request, options)

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

Gets a single entry.

Parameters
Name	Description
`request`	`IGetEntryRequest` 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.IEntry, protos.google.cloud.dataplex.v1.IGetEntryRequest \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing Entry. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the Entry:
   *  `projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}`.
   */
  // const name = 'abc123'
  /**
   *  Optional. View for controlling which parts of an entry are to be returned.
   */
  // const view = {}
  /**
   *  Optional. Limits the aspects returned to the provided aspect types.
   *  Only works if the CUSTOM view is selected.
   */
  // const aspectTypes = ['abc','def']
  /**
   *  Optional. Limits the aspects returned to those associated with the provided
   *  paths within the Entry. Only works if the CUSTOM view is selected.
   */
  // const paths = ['abc','def']

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

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

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

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

  callGetEntry();

getEntry(request, options, callback)

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

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

Returns
Type	Description
`void`

getEntry(request, callback)

getEntry(request: protos.google.cloud.dataplex.v1.IGetEntryRequest, callback: Callback<protos.google.cloud.dataplex.v1.IEntry, protos.google.cloud.dataplex.v1.IGetEntryRequest | null | undefined, {} | null | undefined>): void;

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

Returns
Type	Description
`void`

getEntryGroup(request, options)

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

Retrieves a EntryGroup resource.

Parameters
Name	Description
`request`	`IGetEntryGroupRequest` 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.IEntryGroup, protos.google.cloud.dataplex.v1.IGetEntryGroupRequest \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing EntryGroup. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the EntryGroup:
   *  `projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}`.
   */
  // const name = 'abc123'

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

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

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

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

  callGetEntryGroup();

getEntryGroup(request, options, callback)

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

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

Returns
Type	Description
`void`

getEntryGroup(request, callback)

getEntryGroup(request: protos.google.cloud.dataplex.v1.IGetEntryGroupRequest, callback: Callback<protos.google.cloud.dataplex.v1.IEntryGroup, protos.google.cloud.dataplex.v1.IGetEntryGroupRequest | null | undefined, {} | null | undefined>): void;

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

Returns
Type	Description
`void`

getEntryType(request, options)

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

Retrieves a EntryType resource.

Parameters
Name	Description
`request`	`IGetEntryTypeRequest` 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.IEntryType, protos.google.cloud.dataplex.v1.IGetEntryTypeRequest \| 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 resource name of the EntryType:
   *  `projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}`.
   */
  // const name = 'abc123'

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

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

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

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

  callGetEntryType();

getEntryType(request, options, callback)

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

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

Returns
Type	Description
`void`

getEntryType(request, callback)

getEntryType(request: protos.google.cloud.dataplex.v1.IGetEntryTypeRequest, callback: Callback<protos.google.cloud.dataplex.v1.IEntryType, protos.google.cloud.dataplex.v1.IGetEntryTypeRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetEntryTypeRequest`
`callback`	`Callback<protos.google.cloud.dataplex.v1.IEntryType, protos.google.cloud.dataplex.v1.IGetEntryTypeRequest \| 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, options, callback)

getOperation(request: protos.google.longrunning.GetOperationRequest, options?: 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.
`options`	`CallOptions \| Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} \| null \| undefined>` Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
`callback`	`Callback<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`

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.

listAspectTypes(request, options)

listAspectTypes(request?: protos.google.cloud.dataplex.v1.IListAspectTypesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dataplex.v1.IAspectType[],
        protos.google.cloud.dataplex.v1.IListAspectTypesRequest | null,
        protos.google.cloud.dataplex.v1.IListAspectTypesResponse
    ]>;

Lists AspectType resources in a project and location.

Parameters
Name	Description
`request`	`IListAspectTypesRequest` 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.IAspectType[],
        protos.google.cloud.dataplex.v1.IListAspectTypesRequest | null,
        protos.google.cloud.dataplex.v1.IListAspectTypesResponse
    ]>

{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 listAspectTypesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listAspectTypes(request, options, callback)

listAspectTypes(request: protos.google.cloud.dataplex.v1.IListAspectTypesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dataplex.v1.IListAspectTypesRequest, protos.google.cloud.dataplex.v1.IListAspectTypesResponse | null | undefined, protos.google.cloud.dataplex.v1.IAspectType>): void;

Parameters
Name	Description
`request`	`IListAspectTypesRequest`
`options`	`CallOptions`
`callback`	`PaginationCallback<protos.google.cloud.dataplex.v1.IListAspectTypesRequest, protos.google.cloud.dataplex.v1.IListAspectTypesResponse \| null \| undefined, protos.google.cloud.dataplex.v1.IAspectType>`

Returns
Type	Description
`void`

listAspectTypes(request, callback)

listAspectTypes(request: protos.google.cloud.dataplex.v1.IListAspectTypesRequest, callback: PaginationCallback<protos.google.cloud.dataplex.v1.IListAspectTypesRequest, protos.google.cloud.dataplex.v1.IListAspectTypesResponse | null | undefined, protos.google.cloud.dataplex.v1.IAspectType>): void;

Parameters
Name	Description
`request`	`IListAspectTypesRequest`
`callback`	`PaginationCallback<protos.google.cloud.dataplex.v1.IListAspectTypesRequest, protos.google.cloud.dataplex.v1.IListAspectTypesResponse \| null \| undefined, protos.google.cloud.dataplex.v1.IAspectType>`

Returns
Type	Description
`void`

listAspectTypesAsync(request, options)

listAspectTypesAsync(request?: protos.google.cloud.dataplex.v1.IListAspectTypesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dataplex.v1.IAspectType>;

Equivalent to listAspectTypes, but returns an iterable object.

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

Parameters
Name	Description
`request`	`IListAspectTypesRequest` 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.IAspectType>`	{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 resource name of the AspectType location, of the form:
   *  `projects/{project_number}/locations/{location_id}`
   *  where `location_id` refers to a GCP region.
   */
  // const parent = 'abc123'
  /**
   *  Optional. Maximum number of AspectTypes to return. The service may return
   *  fewer than this value. If unspecified, at most 10 AspectTypes 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 `ListAspectTypes` call.
   *  Provide this to retrieve the subsequent page. When paginating, all other
   *  parameters provided to `ListAspectTypes` must match the call that provided
   *  the page token.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Filter request. Filters are case-sensitive.
   *  The following formats are supported:
   *  labels.key1 = "value1"
   *  labels:key1
   *  name = "value"
   *  These restrictions can be coinjoined with AND, OR and NOT conjunctions.
   */
  // const filter = 'abc123'
  /**
   *  Optional. Order by fields (`name` or `create_time`) for the result.
   *  If not specified, the ordering is undefined.
   */
  // const orderBy = 'abc123'

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

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

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

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

  callListAspectTypes();

listAspectTypesStream(request, options)

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

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

Parameters
Name	Description
`request`	`IListAspectTypesRequest` 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 `listAspectTypesAsync()` method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listEntries(request, options)

listEntries(request?: protos.google.cloud.dataplex.v1.IListEntriesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dataplex.v1.IEntry[],
        protos.google.cloud.dataplex.v1.IListEntriesRequest | null,
        protos.google.cloud.dataplex.v1.IListEntriesResponse
    ]>;

Lists entries within an entry group.

Parameters
Name	Description
`request`	`IListEntriesRequest` 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.IEntry[],
        protos.google.cloud.dataplex.v1.IListEntriesRequest | null,
        protos.google.cloud.dataplex.v1.IListEntriesResponse
    ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of Entry. 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 listEntriesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listEntries(request, options, callback)

listEntries(request: protos.google.cloud.dataplex.v1.IListEntriesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dataplex.v1.IListEntriesRequest, protos.google.cloud.dataplex.v1.IListEntriesResponse | null | undefined, protos.google.cloud.dataplex.v1.IEntry>): void;

Parameters
Name	Description
`request`	`IListEntriesRequest`
`options`	`CallOptions`
`callback`	`PaginationCallback<protos.google.cloud.dataplex.v1.IListEntriesRequest, protos.google.cloud.dataplex.v1.IListEntriesResponse \| null \| undefined, protos.google.cloud.dataplex.v1.IEntry>`

Returns
Type	Description
`void`

listEntries(request, callback)

listEntries(request: protos.google.cloud.dataplex.v1.IListEntriesRequest, callback: PaginationCallback<protos.google.cloud.dataplex.v1.IListEntriesRequest, protos.google.cloud.dataplex.v1.IListEntriesResponse | null | undefined, protos.google.cloud.dataplex.v1.IEntry>): void;

Parameters
Name	Description
`request`	`IListEntriesRequest`
`callback`	`PaginationCallback<protos.google.cloud.dataplex.v1.IListEntriesRequest, protos.google.cloud.dataplex.v1.IListEntriesResponse \| null \| undefined, protos.google.cloud.dataplex.v1.IEntry>`

Returns
Type	Description
`void`

listEntriesAsync(request, options)

listEntriesAsync(request?: protos.google.cloud.dataplex.v1.IListEntriesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dataplex.v1.IEntry>;

Equivalent to listEntries, but returns an iterable object.

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

Parameters
Name	Description
`request`	`IListEntriesRequest` 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.IEntry>`	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Entry. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the parent Entry Group:
   *  `projects/{project}/locations/{location}/entryGroups/{entry_group}`.
   */
  // const parent = 'abc123'
  /**
   */
  // const pageSize = 1234
  /**
   *  Optional. The pagination token returned by a previous request.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. A filter on the entries to return.
   *  Filters are case-sensitive.
   *  The request can be filtered by the following fields:
   *  entry_type, display_name.
   *  The comparison operators are =, !=, <,>, <=,>= (strings are compared
   *  according to lexical order)
   *  The logical operators AND, OR, NOT can be used
   *  in the filter. Example filter expressions:
   *  "display_name=AnExampleDisplayName"
   *  "entry_type=projects/example-project/locations/global/entryTypes/example-entry_type"
   *  "entry_type=projects/a* OR "entry_type=projects/k*"
   *  "NOT display_name=AnotherExampleDisplayName"
   */
  // const filter = 'abc123'

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

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

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

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

  callListEntries();

listEntriesStream(request, options)

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

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

Parameters
Name	Description
`request`	`IListEntriesRequest` 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 Entry 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 `listEntriesAsync()` method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listEntryGroups(request, options)

listEntryGroups(request?: protos.google.cloud.dataplex.v1.IListEntryGroupsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dataplex.v1.IEntryGroup[],
        protos.google.cloud.dataplex.v1.IListEntryGroupsRequest | null,
        protos.google.cloud.dataplex.v1.IListEntryGroupsResponse
    ]>;

Lists EntryGroup resources in a project and location.

Parameters
Name	Description
`request`	`IListEntryGroupsRequest` 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.IEntryGroup[],
        protos.google.cloud.dataplex.v1.IListEntryGroupsRequest | null,
        protos.google.cloud.dataplex.v1.IListEntryGroupsResponse
    ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of EntryGroup. 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 listEntryGroupsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listEntryGroups(request, options, callback)

listEntryGroups(request: protos.google.cloud.dataplex.v1.IListEntryGroupsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dataplex.v1.IListEntryGroupsRequest, protos.google.cloud.dataplex.v1.IListEntryGroupsResponse | null | undefined, protos.google.cloud.dataplex.v1.IEntryGroup>): void;

Parameters
Name	Description
`request`	`IListEntryGroupsRequest`
`options`	`CallOptions`
`callback`	`PaginationCallback<protos.google.cloud.dataplex.v1.IListEntryGroupsRequest, protos.google.cloud.dataplex.v1.IListEntryGroupsResponse \| null \| undefined, protos.google.cloud.dataplex.v1.IEntryGroup>`

Returns
Type	Description
`void`

listEntryGroups(request, callback)

listEntryGroups(request: protos.google.cloud.dataplex.v1.IListEntryGroupsRequest, callback: PaginationCallback<protos.google.cloud.dataplex.v1.IListEntryGroupsRequest, protos.google.cloud.dataplex.v1.IListEntryGroupsResponse | null | undefined, protos.google.cloud.dataplex.v1.IEntryGroup>): void;

Parameters
Name	Description
`request`	`IListEntryGroupsRequest`
`callback`	`PaginationCallback<protos.google.cloud.dataplex.v1.IListEntryGroupsRequest, protos.google.cloud.dataplex.v1.IListEntryGroupsResponse \| null \| undefined, protos.google.cloud.dataplex.v1.IEntryGroup>`

Returns
Type	Description
`void`

listEntryGroupsAsync(request, options)

listEntryGroupsAsync(request?: protos.google.cloud.dataplex.v1.IListEntryGroupsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dataplex.v1.IEntryGroup>;

Equivalent to listEntryGroups, but returns an iterable object.

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

Parameters
Name	Description
`request`	`IListEntryGroupsRequest` 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.IEntryGroup>`	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing EntryGroup. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the entryGroup location, of the form:
   *  `projects/{project_number}/locations/{location_id}`
   *  where `location_id` refers to a GCP region.
   */
  // const parent = 'abc123'
  /**
   *  Optional. Maximum number of EntryGroups to return. The service may return
   *  fewer than this value. If unspecified, at most 10 EntryGroups 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 `ListEntryGroups` call.
   *  Provide this to retrieve the subsequent page. When paginating, all other
   *  parameters provided to `ListEntryGroups` must match the call that provided
   *  the page token.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Filter request.
   */
  // const filter = 'abc123'
  /**
   *  Optional. Order by fields for the result.
   */
  // const orderBy = 'abc123'

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

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

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

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

  callListEntryGroups();

listEntryGroupsStream(request, options)

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

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

Parameters
Name	Description
`request`	`IListEntryGroupsRequest` 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 EntryGroup 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 listEntryGroupsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listEntryTypes(request, options)

listEntryTypes(request?: protos.google.cloud.dataplex.v1.IListEntryTypesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dataplex.v1.IEntryType[],
        protos.google.cloud.dataplex.v1.IListEntryTypesRequest | null,
        protos.google.cloud.dataplex.v1.IListEntryTypesResponse
    ]>;

Lists EntryType resources in a project and location.

Parameters
Name	Description
`request`	`IListEntryTypesRequest` 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.IEntryType[],
        protos.google.cloud.dataplex.v1.IListEntryTypesRequest | null,
        protos.google.cloud.dataplex.v1.IListEntryTypesResponse
    ]>

{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 listEntryTypesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listEntryTypes(request, options, callback)

listEntryTypes(request: protos.google.cloud.dataplex.v1.IListEntryTypesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dataplex.v1.IListEntryTypesRequest, protos.google.cloud.dataplex.v1.IListEntryTypesResponse | null | undefined, protos.google.cloud.dataplex.v1.IEntryType>): void;

Parameters
Name	Description
`request`	`IListEntryTypesRequest`
`options`	`CallOptions`
`callback`	`PaginationCallback<protos.google.cloud.dataplex.v1.IListEntryTypesRequest, protos.google.cloud.dataplex.v1.IListEntryTypesResponse \| null \| undefined, protos.google.cloud.dataplex.v1.IEntryType>`

Returns
Type	Description
`void`

listEntryTypes(request, callback)

listEntryTypes(request: protos.google.cloud.dataplex.v1.IListEntryTypesRequest, callback: PaginationCallback<protos.google.cloud.dataplex.v1.IListEntryTypesRequest, protos.google.cloud.dataplex.v1.IListEntryTypesResponse | null | undefined, protos.google.cloud.dataplex.v1.IEntryType>): void;

Parameters
Name	Description
`request`	`IListEntryTypesRequest`
`callback`	`PaginationCallback<protos.google.cloud.dataplex.v1.IListEntryTypesRequest, protos.google.cloud.dataplex.v1.IListEntryTypesResponse \| null \| undefined, protos.google.cloud.dataplex.v1.IEntryType>`

Returns
Type	Description
`void`

listEntryTypesAsync(request, options)

listEntryTypesAsync(request?: protos.google.cloud.dataplex.v1.IListEntryTypesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dataplex.v1.IEntryType>;

Equivalent to listEntryTypes, but returns an iterable object.

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

Parameters
Name	Description
`request`	`IListEntryTypesRequest` 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.IEntryType>`	{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 resource name of the EntryType location, of the form:
   *  `projects/{project_number}/locations/{location_id}`
   *  where `location_id` refers to a GCP region.
   */
  // const parent = 'abc123'
  /**
   *  Optional. Maximum number of EntryTypes to return. The service may return
   *  fewer than this value. If unspecified, at most 10 EntryTypes 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 `ListEntryTypes` call.
   *  Provide this to retrieve the subsequent page. When paginating, all other
   *  parameters provided to `ListEntryTypes` must match the call that provided
   *  the page token.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Filter request. Filters are case-sensitive.
   *  The following formats are supported:
   *  labels.key1 = "value1"
   *  labels:key1
   *  name = "value"
   *  These restrictions can be coinjoined with AND, OR and NOT conjunctions.
   */
  // const filter = 'abc123'
  /**
   *  Optional. Order by fields (`name` or `create_time`) for the result.
   *  If not specified, the ordering is undefined.
   */
  // const orderBy = 'abc123'

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

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

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

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

  callListEntryTypes();

listEntryTypesStream(request, options)

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

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

Parameters
Name	Description
`request`	`IListEntryTypesRequest` 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 `listEntryTypesAsync()` 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.ListOperationsResponse>;

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.ListOperationsResponse>`	{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.

lookupEntry(request, options)

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

Looks up a single entry.

Parameters
Name	Description
`request`	`ILookupEntryRequest` 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.IEntry, protos.google.cloud.dataplex.v1.ILookupEntryRequest \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing Entry. 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 project to which the request should be attributed in the
   *  following form: `projects/{project}/locations/{location}`.
   */
  // const name = 'abc123'
  /**
   *  Optional. View for controlling which parts of an entry are to be returned.
   */
  // const view = {}
  /**
   *  Optional. Limits the aspects returned to the provided aspect types.
   *  Only works if the CUSTOM view is selected.
   */
  // const aspectTypes = ['abc','def']
  /**
   *  Optional. Limits the aspects returned to those associated with the provided
   *  paths within the Entry. Only works if the CUSTOM view is selected.
   */
  // const paths = ['abc','def']
  /**
   *  Required. The resource name of the Entry:
   *  `projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}`.
   */
  // const entry = 'abc123'

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

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

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

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

  callLookupEntry();

lookupEntry(request, options, callback)

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

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

Returns
Type	Description
`void`

lookupEntry(request, callback)

lookupEntry(request: protos.google.cloud.dataplex.v1.ILookupEntryRequest, callback: Callback<protos.google.cloud.dataplex.v1.IEntry, protos.google.cloud.dataplex.v1.ILookupEntryRequest | null | undefined, {} | null | undefined>): void;

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

Returns
Type	Description
`void`

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

searchEntries(request, options)

searchEntries(request?: protos.google.cloud.dataplex.v1.ISearchEntriesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dataplex.v1.ISearchEntriesResult[],
        protos.google.cloud.dataplex.v1.ISearchEntriesRequest | null,
        protos.google.cloud.dataplex.v1.ISearchEntriesResponse
    ]>;

Searches for entries matching given query and scope.

Parameters
Name	Description
`request`	`ISearchEntriesRequest` 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.ISearchEntriesResult[],
        protos.google.cloud.dataplex.v1.ISearchEntriesRequest | null,
        protos.google.cloud.dataplex.v1.ISearchEntriesResponse
    ]>

{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 searchEntriesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

searchEntries(request, options, callback)

searchEntries(request: protos.google.cloud.dataplex.v1.ISearchEntriesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dataplex.v1.ISearchEntriesRequest, protos.google.cloud.dataplex.v1.ISearchEntriesResponse | null | undefined, protos.google.cloud.dataplex.v1.ISearchEntriesResult>): void;

Parameters
Name	Description
`request`	`ISearchEntriesRequest`
`options`	`CallOptions`
`callback`	`PaginationCallback<protos.google.cloud.dataplex.v1.ISearchEntriesRequest, protos.google.cloud.dataplex.v1.ISearchEntriesResponse \| null \| undefined, protos.google.cloud.dataplex.v1.ISearchEntriesResult>`

Returns
Type	Description
`void`

searchEntries(request, callback)

searchEntries(request: protos.google.cloud.dataplex.v1.ISearchEntriesRequest, callback: PaginationCallback<protos.google.cloud.dataplex.v1.ISearchEntriesRequest, protos.google.cloud.dataplex.v1.ISearchEntriesResponse | null | undefined, protos.google.cloud.dataplex.v1.ISearchEntriesResult>): void;

Parameters
Name	Description
`request`	`ISearchEntriesRequest`
`callback`	`PaginationCallback<protos.google.cloud.dataplex.v1.ISearchEntriesRequest, protos.google.cloud.dataplex.v1.ISearchEntriesResponse \| null \| undefined, protos.google.cloud.dataplex.v1.ISearchEntriesResult>`

Returns
Type	Description
`void`

searchEntriesAsync(request, options)

searchEntriesAsync(request?: protos.google.cloud.dataplex.v1.ISearchEntriesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dataplex.v1.ISearchEntriesResult>;

Equivalent to searchEntries, but returns an iterable object.

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

Parameters
Name	Description
`request`	`ISearchEntriesRequest` 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.ISearchEntriesResult>`	{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 project to which the request should be attributed in the
   *  following form: `projects/{project}/locations/{location}`.
   */
  // const name = 'abc123'
  /**
   *  Required. The query against which entries in scope should be matched.
   */
  // const query = 'abc123'
  /**
   *  Optional. Pagination.
   */
  // const pageSize = 1234
  /**
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Ordering of the results. Supported options to be added later.
   */
  // const orderBy = 'abc123'
  /**
   *  Optional. The scope under which the search should be operating. Should
   *  either be organizations/

searchEntriesStream(request, options)

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

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

Parameters
Name	Description
`request`	`ISearchEntriesRequest` 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 `searchEntriesAsync()` method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

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.

updateAspectType(request, options)

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

Updates a AspectType resource.

Parameters
Name	Description
`request`	`IUpdateAspectTypeRequest` 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.IAspectType, 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. AspectType Resource
   */
  // const aspectType = {}
  /**
   *  Required. Mask of fields to update.
   */
  // const updateMask = {}
  /**
   *  Optional. Only validate the request, but do not perform mutations.
   *  The default is false.
   */
  // const validateOnly = true

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

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

  async function callUpdateAspectType() {
    // Construct request
    const request = {
      aspectType,
      updateMask,
    };

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

  callUpdateAspectType();

updateAspectType(request, options, callback)

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

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

Returns
Type	Description
`void`

updateAspectType(request, callback)

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

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

Returns
Type	Description
`void`

updateEntry(request, options)

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

Updates an Entry.

Parameters
Name	Description
`request`	`IUpdateEntryRequest` 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.IEntry, protos.google.cloud.dataplex.v1.IUpdateEntryRequest \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing Entry. 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. Entry resource.
   */
  // const entry = {}
  /**
   *  Optional. Mask of fields to update. To update Aspects, the update_mask must
   *  contain the value "aspects".
   *  If the update_mask is empty, all modifiable fields present in the request
   *  will be updated.
   */
  // const updateMask = {}
  /**
   *  Optional. If set to true and the entry does not exist, it will be created.
   */
  // const allowMissing = true
  /**
   *  Optional. If set to true and the aspect_keys specify aspect ranges, any
   *  existing aspects from that range not provided in the request will be
   *  deleted.
   */
  // const deleteMissingAspects = true
  /**
   *  Optional. The map keys of the Aspects which should be modified. Supports
   *  the following syntaxes:
   *  *

updateEntry(request, options, callback)

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

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

Returns
Type	Description
`void`

updateEntry(request, callback)

updateEntry(request: protos.google.cloud.dataplex.v1.IUpdateEntryRequest, callback: Callback<protos.google.cloud.dataplex.v1.IEntry, protos.google.cloud.dataplex.v1.IUpdateEntryRequest | null | undefined, {} | null | undefined>): void;

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

Returns
Type	Description
`void`

updateEntryGroup(request, options)

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

Updates a EntryGroup resource.

Parameters
Name	Description
`request`	`IUpdateEntryGroupRequest` 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.IEntryGroup, 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. EntryGroup Resource
   */
  // const entryGroup = {}
  /**
   *  Required. Mask of fields to update.
   */
  // const updateMask = {}
  /**
   *  Optional. Only validate the request, but do not perform mutations.
   *  The default is false.
   */
  // const validateOnly = true

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

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

  async function callUpdateEntryGroup() {
    // Construct request
    const request = {
      entryGroup,
      updateMask,
    };

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

  callUpdateEntryGroup();

updateEntryGroup(request, options, callback)

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

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

Returns
Type	Description
`void`

updateEntryGroup(request, callback)

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

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

Returns
Type	Description
`void`

updateEntryType(request, options)

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

Updates a EntryType resource.

Parameters
Name	Description
`request`	`IUpdateEntryTypeRequest` 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.IEntryType, 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. EntryType Resource
   */
  // const entryType = {}
  /**
   *  Required. Mask of fields to update.
   */
  // const updateMask = {}
  /**
   *  Optional. Only validate the request, but do not perform mutations.
   *  The default is false.
   */
  // const validateOnly = true

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

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

  async function callUpdateEntryType() {
    // Construct request
    const request = {
      entryType,
      updateMask,
    };

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

  callUpdateEntryType();

updateEntryType(request, options, callback)

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

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

Returns
Type	Description
`void`

updateEntryType(request, callback)

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

Parameters
Name	Description
`request`	`IUpdateEntryTypeRequest`
`callback`	`Callback<LROperation<protos.google.cloud.dataplex.v1.IEntryType, 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.