Class v1.DataplexServiceClient (2.1.1)

Version 2.1.1

• 3.8.0 (latest)
• 3.7.0
• 3.5.1
• 3.2.0
• 3.1.0
• 2.4.0
• 2.3.2
• 2.2.2
• 2.1.1
• 1.2.0
• 1.1.0
• 1.0.0

Dataplex service provides data lakes as a service. The primary resources offered by this service are Lakes, Zones and Assets which collectively allow a data adminstrator 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)

constructor(opts?: ClientOptions);

Construct an instance of DataplexServiceClient.

Parameter

Name	Description
opts	ClientOptions

Properties

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

auth

auth: gax.GoogleAuth;

dataplexServiceStub

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

descriptors

descriptors: Descriptors;

innerApiCalls

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

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.

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

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.

cancelJob(request, options)

cancelJob(request?: protos.google.cloud.dataplex.v1.ICancelJobRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.cloud.dataplex.v1.ICancelJobRequest | undefined,
        {} | undefined
    ]>;

Cancel jobs running for the task resource.

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.ICancelJobRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[ protos.google.protobuf.IEmpty, protos.google.cloud.dataplex.v1.ICancelJobRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Empty]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the job:
   *  `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/task/{task_id}/job/{job_id}`.
   */
  // const name = 'abc123'

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

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

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

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

  callCancelJob();

cancelJob(request, options, callback)

cancelJob(request: protos.google.cloud.dataplex.v1.ICancelJobRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dataplex.v1.ICancelJobRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.ICancelJobRequest
options	CallOptions
callback	Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dataplex.v1.ICancelJobRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

cancelJob(request, callback)

cancelJob(request: protos.google.cloud.dataplex.v1.ICancelJobRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dataplex.v1.ICancelJobRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.ICancelJobRequest
callback	Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dataplex.v1.ICancelJobRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

checkCreateAssetProgress(name)

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

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

Parameter

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

Returns

Type	Description
Promise<LROperation<protos.google.cloud.dataplex.v1.Asset, 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the parent zone:
   *  `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`
   */
  // const parent = 'abc123'
  /**
   *  Required. Asset identifier.
   *  This ID will be used to generate names such as table names when publishing
   *  metadata to Hive Metastore and BigQuery.
   *  * Must contain only lowercase letters, numbers and hyphens.
   *  * Must start with a letter.
   *  * Must end with a number or a letter.
   *  * Must be between 1-63 characters.
   *  * Must be unique within the zone.
   */
  // const assetId = 'abc123'
  /**
   *  Required. Asset resource.
   */
  // const asset = {}
  /**
   *  Optional. Only validate the request, but do not perform mutations.
   *  The default is false.
   */
  // const validateOnly = true

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

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

  async function callCreateAsset() {
    // Construct request
    const request = {
      parent,
      assetId,
      asset,
    };

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

  callCreateAsset();

checkCreateEnvironmentProgress(name)

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

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

Parameter

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

Returns

Type	Description
Promise<LROperation<protos.google.cloud.dataplex.v1.Environment, 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the parent lake:
   *  projects/{project_id}/locations/{location_id}/lakes/{lake_id}
   */
  // const parent = 'abc123'
  /**
   *  Required. Environment identifier.
   *  * Must contain only lowercase letters, numbers and hyphens.
   *  * Must start with a letter.
   *  * Must be between 1-63 characters.
   *  * Must end with a number or a letter.
   *  * Must be unique within the lake.
   */
  // const environmentId = 'abc123'
  /**
   *  Required. Environment resource.
   */
  // const environment = {}
  /**
   *  Optional. Only validate the request, but do not perform mutations.
   *  The default is false.
   */
  // const validateOnly = true

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

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

  async function callCreateEnvironment() {
    // Construct request
    const request = {
      parent,
      environmentId,
      environment,
    };

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

  callCreateEnvironment();

checkCreateLakeProgress(name)

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

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

Parameter

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

Returns

Type	Description
Promise<LROperation<protos.google.cloud.dataplex.v1.Lake, 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the lake location, of the form:
   *  projects/{project_number}/locations/{location_id}
   *  where `location_id` refers to a GCP region.
   */
  // const parent = 'abc123'
  /**
   *  Required. Lake identifier.
   *  This ID will be used to generate names such as database and dataset names
   *  when publishing metadata to Hive Metastore and BigQuery.
   *  * Must contain only lowercase letters, numbers and hyphens.
   *  * Must start with a letter.
   *  * Must end with a number or a letter.
   *  * Must be between 1-63 characters.
   *  * Must be unique within the customer project / location.
   */
  // const lakeId = 'abc123'
  /**
   *  Required. Lake resource
   */
  // const lake = {}
  /**
   *  Optional. Only validate the request, but do not perform mutations.
   *  The default is false.
   */
  // const validateOnly = true

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

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

  async function callCreateLake() {
    // Construct request
    const request = {
      parent,
      lakeId,
      lake,
    };

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

  callCreateLake();

checkCreateTaskProgress(name)

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

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

Parameter

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

Returns

Type	Description
Promise<LROperation<protos.google.cloud.dataplex.v1.Task, 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the parent lake:
   *  `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`.
   */
  // const parent = 'abc123'
  /**
   *  Required. Task identifier.
   */
  // const taskId = 'abc123'
  /**
   *  Required. Task resource.
   */
  // const task = {}
  /**
   *  Optional. Only validate the request, but do not perform mutations.
   *  The default is false.
   */
  // const validateOnly = true

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

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

  async function callCreateTask() {
    // Construct request
    const request = {
      parent,
      taskId,
      task,
    };

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

  callCreateTask();

checkCreateZoneProgress(name)

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

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

Parameter

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

Returns

Type	Description
Promise<LROperation<protos.google.cloud.dataplex.v1.Zone, 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the parent lake:
   *  `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`.
   */
  // const parent = 'abc123'
  /**
   *  Required. Zone identifier.
   *  This ID will be used to generate names such as database and dataset names
   *  when publishing metadata to Hive Metastore and BigQuery.
   *  * Must contain only lowercase letters, numbers and hyphens.
   *  * Must start with a letter.
   *  * Must end with a number or a letter.
   *  * Must be between 1-63 characters.
   *  * Must be unique across all lakes from all locations in a project.
   *  * Must not be one of the reserved IDs (i.e. "default", "global-temp")
   */
  // const zoneId = 'abc123'
  /**
   *  Required. Zone resource.
   */
  // const zone = {}
  /**
   *  Optional. Only validate the request, but do not perform mutations.
   *  The default is false.
   */
  // const validateOnly = true

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

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

  async function callCreateZone() {
    // Construct request
    const request = {
      parent,
      zoneId,
      zone,
    };

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

  callCreateZone();

checkDeleteAssetProgress(name)

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

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

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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the asset:
   *  `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}`.
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteAsset();

checkDeleteEnvironmentProgress(name)

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

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

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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the environment:
   *  projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environments/{environment_id}`
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteEnvironment();

checkDeleteLakeProgress(name)

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

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

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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the lake:
   *  `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteLake();

checkDeleteTaskProgress(name)

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

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

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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the task:
   *  `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/task/{task_id}`.
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteTask();

checkDeleteZoneProgress(name)

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

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

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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the zone:
   *  `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`.
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteZone();

checkUpdateAssetProgress(name)

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

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

Parameter

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

Returns

Type	Description
Promise<LROperation<protos.google.cloud.dataplex.v1.Asset, 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Mask of fields to update.
   */
  // const updateMask = {}
  /**
   *  Required. Update description.
   *  Only fields specified in `update_mask` are updated.
   */
  // const asset = {}
  /**
   *  Optional. Only validate the request, but do not perform mutations.
   *  The default is false.
   */
  // const validateOnly = true

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

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

  async function callUpdateAsset() {
    // Construct request
    const request = {
      updateMask,
      asset,
    };

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

  callUpdateAsset();

checkUpdateEnvironmentProgress(name)

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

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

Parameter

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

Returns

Type	Description
Promise<LROperation<protos.google.cloud.dataplex.v1.Environment, 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Mask of fields to update.
   */
  // const updateMask = {}
  /**
   *  Required. Update description.
   *  Only fields specified in `update_mask` are updated.
   */
  // const environment = {}
  /**
   *  Optional. Only validate the request, but do not perform mutations.
   *  The default is false.
   */
  // const validateOnly = true

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

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

  async function callUpdateEnvironment() {
    // Construct request
    const request = {
      updateMask,
      environment,
    };

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

  callUpdateEnvironment();

checkUpdateLakeProgress(name)

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

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

Parameter

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

Returns

Type	Description
Promise<LROperation<protos.google.cloud.dataplex.v1.Lake, 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Mask of fields to update.
   */
  // const updateMask = {}
  /**
   *  Required. Update description.
   *  Only fields specified in `update_mask` are updated.
   */
  // const lake = {}
  /**
   *  Optional. Only validate the request, but do not perform mutations.
   *  The default is false.
   */
  // const validateOnly = true

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

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

  async function callUpdateLake() {
    // Construct request
    const request = {
      updateMask,
      lake,
    };

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

  callUpdateLake();

checkUpdateTaskProgress(name)

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

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

Parameter

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

Returns

Type	Description
Promise<LROperation<protos.google.cloud.dataplex.v1.Task, 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Mask of fields to update.
   */
  // const updateMask = {}
  /**
   *  Required. Update description.
   *  Only fields specified in `update_mask` are updated.
   */
  // const task = {}
  /**
   *  Optional. Only validate the request, but do not perform mutations.
   *  The default is false.
   */
  // const validateOnly = true

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

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

  async function callUpdateTask() {
    // Construct request
    const request = {
      updateMask,
      task,
    };

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

  callUpdateTask();

checkUpdateZoneProgress(name)

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

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

Parameter

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

Returns

Type	Description
Promise<LROperation<protos.google.cloud.dataplex.v1.Zone, 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Mask of fields to update.
   */
  // const updateMask = {}
  /**
   *  Required. Update description.
   *  Only fields specified in `update_mask` are updated.
   */
  // const zone = {}
  /**
   *  Optional. Only validate the request, but do not perform mutations.
   *  The default is false.
   */
  // const validateOnly = true

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

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

  async function callUpdateZone() {
    // Construct request
    const request = {
      updateMask,
      zone,
    };

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

  callUpdateZone();

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.

createAsset(request, options)

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

Creates an asset resource.

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.ICreateAssetRequest 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.IAsset, 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the parent zone:
   *  `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`
   */
  // const parent = 'abc123'
  /**
   *  Required. Asset identifier.
   *  This ID will be used to generate names such as table names when publishing
   *  metadata to Hive Metastore and BigQuery.
   *  * Must contain only lowercase letters, numbers and hyphens.
   *  * Must start with a letter.
   *  * Must end with a number or a letter.
   *  * Must be between 1-63 characters.
   *  * Must be unique within the zone.
   */
  // const assetId = 'abc123'
  /**
   *  Required. Asset resource.
   */
  // const asset = {}
  /**
   *  Optional. Only validate the request, but do not perform mutations.
   *  The default is false.
   */
  // const validateOnly = true

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

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

  async function callCreateAsset() {
    // Construct request
    const request = {
      parent,
      assetId,
      asset,
    };

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

  callCreateAsset();

createAsset(request, options, callback)

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.ICreateAssetRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.dataplex.v1.IAsset, protos.google.cloud.dataplex.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns

Type	Description
void

createAsset(request, callback)

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.ICreateAssetRequest
callback	Callback<LROperation<protos.google.cloud.dataplex.v1.IAsset, protos.google.cloud.dataplex.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns

Type	Description
void

createEnvironment(request, options)

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

Create an environment resource.

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.ICreateEnvironmentRequest 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.IEnvironment, 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the parent lake:
   *  projects/{project_id}/locations/{location_id}/lakes/{lake_id}
   */
  // const parent = 'abc123'
  /**
   *  Required. Environment identifier.
   *  * Must contain only lowercase letters, numbers and hyphens.
   *  * Must start with a letter.
   *  * Must be between 1-63 characters.
   *  * Must end with a number or a letter.
   *  * Must be unique within the lake.
   */
  // const environmentId = 'abc123'
  /**
   *  Required. Environment resource.
   */
  // const environment = {}
  /**
   *  Optional. Only validate the request, but do not perform mutations.
   *  The default is false.
   */
  // const validateOnly = true

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

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

  async function callCreateEnvironment() {
    // Construct request
    const request = {
      parent,
      environmentId,
      environment,
    };

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

  callCreateEnvironment();

createEnvironment(request, options, callback)

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.ICreateEnvironmentRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.dataplex.v1.IEnvironment, protos.google.cloud.dataplex.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns

Type	Description
void

createEnvironment(request, callback)

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.ICreateEnvironmentRequest
callback	Callback<LROperation<protos.google.cloud.dataplex.v1.IEnvironment, protos.google.cloud.dataplex.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns

Type	Description
void

createLake(request, options)

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

Creates a lake resource.

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.ICreateLakeRequest 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.ILake, 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the lake location, of the form:
   *  projects/{project_number}/locations/{location_id}
   *  where `location_id` refers to a GCP region.
   */
  // const parent = 'abc123'
  /**
   *  Required. Lake identifier.
   *  This ID will be used to generate names such as database and dataset names
   *  when publishing metadata to Hive Metastore and BigQuery.
   *  * Must contain only lowercase letters, numbers and hyphens.
   *  * Must start with a letter.
   *  * Must end with a number or a letter.
   *  * Must be between 1-63 characters.
   *  * Must be unique within the customer project / location.
   */
  // const lakeId = 'abc123'
  /**
   *  Required. Lake resource
   */
  // const lake = {}
  /**
   *  Optional. Only validate the request, but do not perform mutations.
   *  The default is false.
   */
  // const validateOnly = true

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

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

  async function callCreateLake() {
    // Construct request
    const request = {
      parent,
      lakeId,
      lake,
    };

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

  callCreateLake();

createLake(request, options, callback)

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.ICreateLakeRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.dataplex.v1.ILake, protos.google.cloud.dataplex.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns

Type	Description
void

createLake(request, callback)

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.ICreateLakeRequest
callback	Callback<LROperation<protos.google.cloud.dataplex.v1.ILake, protos.google.cloud.dataplex.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns

Type	Description
void

createTask(request, options)

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

Creates a task resource within a lake.

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.ICreateTaskRequest 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.ITask, 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the parent lake:
   *  `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`.
   */
  // const parent = 'abc123'
  /**
   *  Required. Task identifier.
   */
  // const taskId = 'abc123'
  /**
   *  Required. Task resource.
   */
  // const task = {}
  /**
   *  Optional. Only validate the request, but do not perform mutations.
   *  The default is false.
   */
  // const validateOnly = true

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

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

  async function callCreateTask() {
    // Construct request
    const request = {
      parent,
      taskId,
      task,
    };

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

  callCreateTask();

createTask(request, options, callback)

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.ICreateTaskRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.dataplex.v1.ITask, protos.google.cloud.dataplex.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns

Type	Description
void

createTask(request, callback)

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.ICreateTaskRequest
callback	Callback<LROperation<protos.google.cloud.dataplex.v1.ITask, protos.google.cloud.dataplex.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns

Type	Description
void

createZone(request, options)

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

Creates a zone resource within a lake.

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.ICreateZoneRequest 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.IZone, 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the parent lake:
   *  `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`.
   */
  // const parent = 'abc123'
  /**
   *  Required. Zone identifier.
   *  This ID will be used to generate names such as database and dataset names
   *  when publishing metadata to Hive Metastore and BigQuery.
   *  * Must contain only lowercase letters, numbers and hyphens.
   *  * Must start with a letter.
   *  * Must end with a number or a letter.
   *  * Must be between 1-63 characters.
   *  * Must be unique across all lakes from all locations in a project.
   *  * Must not be one of the reserved IDs (i.e. "default", "global-temp")
   */
  // const zoneId = 'abc123'
  /**
   *  Required. Zone resource.
   */
  // const zone = {}
  /**
   *  Optional. Only validate the request, but do not perform mutations.
   *  The default is false.
   */
  // const validateOnly = true

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

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

  async function callCreateZone() {
    // Construct request
    const request = {
      parent,
      zoneId,
      zone,
    };

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

  callCreateZone();

createZone(request, options, callback)

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.ICreateZoneRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.dataplex.v1.IZone, protos.google.cloud.dataplex.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns

Type	Description
void

createZone(request, callback)

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.ICreateZoneRequest
callback	Callback<LROperation<protos.google.cloud.dataplex.v1.IZone, protos.google.cloud.dataplex.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns

Type	Description
void

deleteAsset(request, options)

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

Deletes an asset resource. The referenced storage resource is detached (default) or deleted based on the associated Lifecycle policy.

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IDeleteAssetRequest 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the asset:
   *  `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}`.
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteAsset();

deleteAsset(request, options, callback)

deleteAsset(request: protos.google.cloud.dataplex.v1.IDeleteAssetRequest, 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	protos.google.cloud.dataplex.v1.IDeleteAssetRequest
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

deleteAsset(request, callback)

deleteAsset(request: protos.google.cloud.dataplex.v1.IDeleteAssetRequest, 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	protos.google.cloud.dataplex.v1.IDeleteAssetRequest
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

deleteEnvironment(request, options)

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

Delete the environment resource. All the child resources must have been deleted before environment deletion can be initiated.

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IDeleteEnvironmentRequest 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the environment:
   *  projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environments/{environment_id}`
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteEnvironment();

deleteEnvironment(request, options, callback)

deleteEnvironment(request: protos.google.cloud.dataplex.v1.IDeleteEnvironmentRequest, 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	protos.google.cloud.dataplex.v1.IDeleteEnvironmentRequest
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

deleteEnvironment(request, callback)

deleteEnvironment(request: protos.google.cloud.dataplex.v1.IDeleteEnvironmentRequest, 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	protos.google.cloud.dataplex.v1.IDeleteEnvironmentRequest
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

deleteLake(request, options)

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

Deletes a lake resource. All zones within the lake must be deleted before the lake can be deleted.

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IDeleteLakeRequest 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the lake:
   *  `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteLake();

deleteLake(request, options, callback)

deleteLake(request: protos.google.cloud.dataplex.v1.IDeleteLakeRequest, 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	protos.google.cloud.dataplex.v1.IDeleteLakeRequest
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

deleteLake(request, callback)

deleteLake(request: protos.google.cloud.dataplex.v1.IDeleteLakeRequest, 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	protos.google.cloud.dataplex.v1.IDeleteLakeRequest
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

deleteTask(request, options)

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

Delete the task resource.

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IDeleteTaskRequest 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the task:
   *  `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/task/{task_id}`.
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteTask();

deleteTask(request, options, callback)

deleteTask(request: protos.google.cloud.dataplex.v1.IDeleteTaskRequest, 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	protos.google.cloud.dataplex.v1.IDeleteTaskRequest
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

deleteTask(request, callback)

deleteTask(request: protos.google.cloud.dataplex.v1.IDeleteTaskRequest, 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	protos.google.cloud.dataplex.v1.IDeleteTaskRequest
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

deleteZone(request, options)

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

Deletes a zone resource. All assets within a zone must be deleted before the zone can be deleted.

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IDeleteZoneRequest 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the zone:
   *  `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`.
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteZone();

deleteZone(request, options, callback)

deleteZone(request: protos.google.cloud.dataplex.v1.IDeleteZoneRequest, 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	protos.google.cloud.dataplex.v1.IDeleteZoneRequest
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

deleteZone(request, callback)

deleteZone(request: protos.google.cloud.dataplex.v1.IDeleteZoneRequest, 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	protos.google.cloud.dataplex.v1.IDeleteZoneRequest
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

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.

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.

getAsset(request, options)

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

Retrieves an asset resource.

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IGetAssetRequest 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.IAsset, protos.google.cloud.dataplex.v1.IGetAssetRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Asset]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the asset:
   *  `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}`.
   */
  // const name = 'abc123'

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

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

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

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

  callGetAsset();

getAsset(request, options, callback)

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IGetAssetRequest
options	CallOptions
callback	Callback<protos.google.cloud.dataplex.v1.IAsset, protos.google.cloud.dataplex.v1.IGetAssetRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

getAsset(request, callback)

getAsset(request: protos.google.cloud.dataplex.v1.IGetAssetRequest, callback: Callback<protos.google.cloud.dataplex.v1.IAsset, protos.google.cloud.dataplex.v1.IGetAssetRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IGetAssetRequest
callback	Callback<protos.google.cloud.dataplex.v1.IAsset, protos.google.cloud.dataplex.v1.IGetAssetRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

getEnvironment(request, options)

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

Get environment resource.

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IGetEnvironmentRequest 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.IEnvironment, protos.google.cloud.dataplex.v1.IGetEnvironmentRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Environment]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the environment:
   *  projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environments/{environment_id}
   */
  // const name = 'abc123'

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

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

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

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

  callGetEnvironment();

getEnvironment(request, options, callback)

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IGetEnvironmentRequest
options	CallOptions
callback	Callback<protos.google.cloud.dataplex.v1.IEnvironment, protos.google.cloud.dataplex.v1.IGetEnvironmentRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

getEnvironment(request, callback)

getEnvironment(request: protos.google.cloud.dataplex.v1.IGetEnvironmentRequest, callback: Callback<protos.google.cloud.dataplex.v1.IEnvironment, protos.google.cloud.dataplex.v1.IGetEnvironmentRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IGetEnvironmentRequest
callback	Callback<protos.google.cloud.dataplex.v1.IEnvironment, protos.google.cloud.dataplex.v1.IGetEnvironmentRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

getJob(request, options)

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

Get job resource.

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IGetJobRequest 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.IJob, protos.google.cloud.dataplex.v1.IGetJobRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Job]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the job:
   *  `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}/jobs/{job_id}`.
   */
  // const name = 'abc123'

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

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

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

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

  callGetJob();

getJob(request, options, callback)

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IGetJobRequest
options	CallOptions
callback	Callback<protos.google.cloud.dataplex.v1.IJob, protos.google.cloud.dataplex.v1.IGetJobRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

getJob(request, callback)

getJob(request: protos.google.cloud.dataplex.v1.IGetJobRequest, callback: Callback<protos.google.cloud.dataplex.v1.IJob, protos.google.cloud.dataplex.v1.IGetJobRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IGetJobRequest
callback	Callback<protos.google.cloud.dataplex.v1.IJob, protos.google.cloud.dataplex.v1.IGetJobRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

getLake(request, options)

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

Retrieves a lake resource.

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IGetLakeRequest 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.ILake, protos.google.cloud.dataplex.v1.IGetLakeRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Lake]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the lake:
   *  `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`.
   */
  // const name = 'abc123'

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

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

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

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

  callGetLake();

getLake(request, options, callback)

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IGetLakeRequest
options	CallOptions
callback	Callback<protos.google.cloud.dataplex.v1.ILake, protos.google.cloud.dataplex.v1.IGetLakeRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

getLake(request, callback)

getLake(request: protos.google.cloud.dataplex.v1.IGetLakeRequest, callback: Callback<protos.google.cloud.dataplex.v1.ILake, protos.google.cloud.dataplex.v1.IGetLakeRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IGetLakeRequest
callback	Callback<protos.google.cloud.dataplex.v1.ILake, protos.google.cloud.dataplex.v1.IGetLakeRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

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

getTask(request, options)

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

Get task resource.

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IGetTaskRequest 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.ITask, protos.google.cloud.dataplex.v1.IGetTaskRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Task]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the task:
   *  `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{tasks_id}`
   */
  // const name = 'abc123'

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

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

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

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

  callGetTask();

getTask(request, options, callback)

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IGetTaskRequest
options	CallOptions
callback	Callback<protos.google.cloud.dataplex.v1.ITask, protos.google.cloud.dataplex.v1.IGetTaskRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

getTask(request, callback)

getTask(request: protos.google.cloud.dataplex.v1.IGetTaskRequest, callback: Callback<protos.google.cloud.dataplex.v1.ITask, protos.google.cloud.dataplex.v1.IGetTaskRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IGetTaskRequest
callback	Callback<protos.google.cloud.dataplex.v1.ITask, protos.google.cloud.dataplex.v1.IGetTaskRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

getZone(request, options)

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

Retrieves a zone resource.

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IGetZoneRequest 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.IZone, protos.google.cloud.dataplex.v1.IGetZoneRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Zone]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the zone:
   *  `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`.
   */
  // const name = 'abc123'

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

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

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

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

  callGetZone();

getZone(request, options, callback)

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IGetZoneRequest
options	CallOptions
callback	Callback<protos.google.cloud.dataplex.v1.IZone, protos.google.cloud.dataplex.v1.IGetZoneRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

getZone(request, callback)

getZone(request: protos.google.cloud.dataplex.v1.IGetZoneRequest, callback: Callback<protos.google.cloud.dataplex.v1.IZone, protos.google.cloud.dataplex.v1.IGetZoneRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IGetZoneRequest
callback	Callback<protos.google.cloud.dataplex.v1.IZone, protos.google.cloud.dataplex.v1.IGetZoneRequest | null | undefined, {} | null | 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.

listAssetActions(request, options)

listAssetActions(request?: protos.google.cloud.dataplex.v1.IListAssetActionsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dataplex.v1.IAction[],
        protos.google.cloud.dataplex.v1.IListAssetActionsRequest | null,
        protos.google.cloud.dataplex.v1.IListActionsResponse
    ]>;

Lists action resources in an asset.

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListAssetActionsRequest 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.IAction[], protos.google.cloud.dataplex.v1.IListAssetActionsRequest | null, protos.google.cloud.dataplex.v1.IListActionsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [Action]. 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 listAssetActionsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listAssetActions(request, options, callback)

listAssetActions(request: protos.google.cloud.dataplex.v1.IListAssetActionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dataplex.v1.IListAssetActionsRequest, protos.google.cloud.dataplex.v1.IListActionsResponse | null | undefined, protos.google.cloud.dataplex.v1.IAction>): void;

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListAssetActionsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.dataplex.v1.IListAssetActionsRequest, protos.google.cloud.dataplex.v1.IListActionsResponse | null | undefined, protos.google.cloud.dataplex.v1.IAction>

Returns

Type	Description
void

listAssetActions(request, callback)

listAssetActions(request: protos.google.cloud.dataplex.v1.IListAssetActionsRequest, callback: PaginationCallback<protos.google.cloud.dataplex.v1.IListAssetActionsRequest, protos.google.cloud.dataplex.v1.IListActionsResponse | null | undefined, protos.google.cloud.dataplex.v1.IAction>): void;

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListAssetActionsRequest
callback	PaginationCallback<protos.google.cloud.dataplex.v1.IListAssetActionsRequest, protos.google.cloud.dataplex.v1.IListActionsResponse | null | undefined, protos.google.cloud.dataplex.v1.IAction>

Returns

Type	Description
void

listAssetActionsAsync(request, options)

listAssetActionsAsync(request?: protos.google.cloud.dataplex.v1.IListAssetActionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dataplex.v1.IAction>;

Equivalent to listAssetActions, but returns an iterable object.

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListAssetActionsRequest 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.IAction>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Action]. 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the parent asset:
   *  `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}`.
   */
  // const parent = 'abc123'
  /**
   *  Optional. Maximum number of actions to return. The service may return fewer than this
   *  value. If unspecified, at most 10 actions 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 `ListAssetActions` call. Provide this
   *  to retrieve the subsequent page. When paginating, all other parameters
   *  provided to `ListAssetActions` must match the call that provided the page
   *  token.
   */
  // const pageToken = 'abc123'

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

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

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

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

  callListAssetActions();

listAssetActionsStream(request, options)

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

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListAssetActionsRequest 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 [Action] 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 listAssetActionsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listAssets(request, options)

listAssets(request?: protos.google.cloud.dataplex.v1.IListAssetsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dataplex.v1.IAsset[],
        protos.google.cloud.dataplex.v1.IListAssetsRequest | null,
        protos.google.cloud.dataplex.v1.IListAssetsResponse
    ]>;

Lists asset resources in a zone.

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListAssetsRequest 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.IAsset[], protos.google.cloud.dataplex.v1.IListAssetsRequest | null, protos.google.cloud.dataplex.v1.IListAssetsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [Asset]. 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 listAssetsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listAssets(request, options, callback)

listAssets(request: protos.google.cloud.dataplex.v1.IListAssetsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dataplex.v1.IListAssetsRequest, protos.google.cloud.dataplex.v1.IListAssetsResponse | null | undefined, protos.google.cloud.dataplex.v1.IAsset>): void;

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListAssetsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.dataplex.v1.IListAssetsRequest, protos.google.cloud.dataplex.v1.IListAssetsResponse | null | undefined, protos.google.cloud.dataplex.v1.IAsset>

Returns

Type	Description
void

listAssets(request, callback)

listAssets(request: protos.google.cloud.dataplex.v1.IListAssetsRequest, callback: PaginationCallback<protos.google.cloud.dataplex.v1.IListAssetsRequest, protos.google.cloud.dataplex.v1.IListAssetsResponse | null | undefined, protos.google.cloud.dataplex.v1.IAsset>): void;

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListAssetsRequest
callback	PaginationCallback<protos.google.cloud.dataplex.v1.IListAssetsRequest, protos.google.cloud.dataplex.v1.IListAssetsResponse | null | undefined, protos.google.cloud.dataplex.v1.IAsset>

Returns

Type	Description
void

listAssetsAsync(request, options)

listAssetsAsync(request?: protos.google.cloud.dataplex.v1.IListAssetsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dataplex.v1.IAsset>;

Equivalent to listAssets, but returns an iterable object.

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListAssetsRequest 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.IAsset>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Asset]. 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the parent zone:
   *  `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`.
   */
  // const parent = 'abc123'
  /**
   *  Optional. Maximum number of asset to return. The service may return fewer than
   *  this value. If unspecified, at most 10 assets 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 `ListAssets` call. Provide this to
   *  retrieve the subsequent page. When paginating, all other parameters
   *  provided to `ListAssets` 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 {DataplexServiceClient} = require('@google-cloud/dataplex').v1;

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

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

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

  callListAssets();

listAssetsStream(request, options)

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

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListAssetsRequest 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 [Asset] 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 listAssetsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listEnvironments(request, options)

listEnvironments(request?: protos.google.cloud.dataplex.v1.IListEnvironmentsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dataplex.v1.IEnvironment[],
        protos.google.cloud.dataplex.v1.IListEnvironmentsRequest | null,
        protos.google.cloud.dataplex.v1.IListEnvironmentsResponse
    ]>;

Lists environments under the given lake.

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListEnvironmentsRequest 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.IEnvironment[], protos.google.cloud.dataplex.v1.IListEnvironmentsRequest | null, protos.google.cloud.dataplex.v1.IListEnvironmentsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [Environment]. 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 listEnvironmentsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listEnvironments(request, options, callback)

listEnvironments(request: protos.google.cloud.dataplex.v1.IListEnvironmentsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dataplex.v1.IListEnvironmentsRequest, protos.google.cloud.dataplex.v1.IListEnvironmentsResponse | null | undefined, protos.google.cloud.dataplex.v1.IEnvironment>): void;

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListEnvironmentsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.dataplex.v1.IListEnvironmentsRequest, protos.google.cloud.dataplex.v1.IListEnvironmentsResponse | null | undefined, protos.google.cloud.dataplex.v1.IEnvironment>

Returns

Type	Description
void

listEnvironments(request, callback)

listEnvironments(request: protos.google.cloud.dataplex.v1.IListEnvironmentsRequest, callback: PaginationCallback<protos.google.cloud.dataplex.v1.IListEnvironmentsRequest, protos.google.cloud.dataplex.v1.IListEnvironmentsResponse | null | undefined, protos.google.cloud.dataplex.v1.IEnvironment>): void;

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListEnvironmentsRequest
callback	PaginationCallback<protos.google.cloud.dataplex.v1.IListEnvironmentsRequest, protos.google.cloud.dataplex.v1.IListEnvironmentsResponse | null | undefined, protos.google.cloud.dataplex.v1.IEnvironment>

Returns

Type	Description
void

listEnvironmentsAsync(request, options)

listEnvironmentsAsync(request?: protos.google.cloud.dataplex.v1.IListEnvironmentsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dataplex.v1.IEnvironment>;

Equivalent to listEnvironments, but returns an iterable object.

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListEnvironmentsRequest 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.IEnvironment>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Environment]. 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the parent lake:
   *  projects/{project_id}/locations/{location_id}/lakes/{lake_id}
   */
  // const parent = 'abc123'
  /**
   *  Optional. Maximum number of environments to return. The service may return fewer than
   *  this value. If unspecified, at most 10 environments 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 `ListEnvironments` call. Provide this
   *  to retrieve the subsequent page. When paginating, all other parameters
   *  provided to `ListEnvironments` 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 {DataplexServiceClient} = require('@google-cloud/dataplex').v1;

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

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

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

  callListEnvironments();

listEnvironmentsStream(request, options)

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

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListEnvironmentsRequest 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 [Environment] 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 listEnvironmentsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listJobs(request, options)

listJobs(request?: protos.google.cloud.dataplex.v1.IListJobsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dataplex.v1.IJob[],
        protos.google.cloud.dataplex.v1.IListJobsRequest | null,
        protos.google.cloud.dataplex.v1.IListJobsResponse
    ]>;

Lists Jobs under the given task.

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListJobsRequest 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.IJob[], protos.google.cloud.dataplex.v1.IListJobsRequest | null, protos.google.cloud.dataplex.v1.IListJobsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [Job]. 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 listJobsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listJobs(request, options, callback)

listJobs(request: protos.google.cloud.dataplex.v1.IListJobsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dataplex.v1.IListJobsRequest, protos.google.cloud.dataplex.v1.IListJobsResponse | null | undefined, protos.google.cloud.dataplex.v1.IJob>): void;

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListJobsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.dataplex.v1.IListJobsRequest, protos.google.cloud.dataplex.v1.IListJobsResponse | null | undefined, protos.google.cloud.dataplex.v1.IJob>

Returns

Type	Description
void

listJobs(request, callback)

listJobs(request: protos.google.cloud.dataplex.v1.IListJobsRequest, callback: PaginationCallback<protos.google.cloud.dataplex.v1.IListJobsRequest, protos.google.cloud.dataplex.v1.IListJobsResponse | null | undefined, protos.google.cloud.dataplex.v1.IJob>): void;

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListJobsRequest
callback	PaginationCallback<protos.google.cloud.dataplex.v1.IListJobsRequest, protos.google.cloud.dataplex.v1.IListJobsResponse | null | undefined, protos.google.cloud.dataplex.v1.IJob>

Returns

Type	Description
void

listJobsAsync(request, options)

listJobsAsync(request?: protos.google.cloud.dataplex.v1.IListJobsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dataplex.v1.IJob>;

Equivalent to listJobs, but returns an iterable object.

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListJobsRequest 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.IJob>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Job]. 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the parent environment:
   *  `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}`.
   */
  // const parent = 'abc123'
  /**
   *  Optional. Maximum number of jobs to return. The service may return fewer than
   *  this value. If unspecified, at most 10 jobs 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 `ListJobs` call. Provide this to
   *  retrieve the subsequent page. When paginating, all other parameters
   *  provided to `ListJobs` must match the call that provided the page
   *  token.
   */
  // const pageToken = 'abc123'

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

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

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

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

  callListJobs();

listJobsStream(request, options)

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

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListJobsRequest 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 [Job] 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 listJobsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listLakeActions(request, options)

listLakeActions(request?: protos.google.cloud.dataplex.v1.IListLakeActionsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dataplex.v1.IAction[],
        protos.google.cloud.dataplex.v1.IListLakeActionsRequest | null,
        protos.google.cloud.dataplex.v1.IListActionsResponse
    ]>;

Lists action resources in a lake.

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListLakeActionsRequest 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.IAction[], protos.google.cloud.dataplex.v1.IListLakeActionsRequest | null, protos.google.cloud.dataplex.v1.IListActionsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [Action]. 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 listLakeActionsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listLakeActions(request, options, callback)

listLakeActions(request: protos.google.cloud.dataplex.v1.IListLakeActionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dataplex.v1.IListLakeActionsRequest, protos.google.cloud.dataplex.v1.IListActionsResponse | null | undefined, protos.google.cloud.dataplex.v1.IAction>): void;

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListLakeActionsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.dataplex.v1.IListLakeActionsRequest, protos.google.cloud.dataplex.v1.IListActionsResponse | null | undefined, protos.google.cloud.dataplex.v1.IAction>

Returns

Type	Description
void

listLakeActions(request, callback)

listLakeActions(request: protos.google.cloud.dataplex.v1.IListLakeActionsRequest, callback: PaginationCallback<protos.google.cloud.dataplex.v1.IListLakeActionsRequest, protos.google.cloud.dataplex.v1.IListActionsResponse | null | undefined, protos.google.cloud.dataplex.v1.IAction>): void;

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListLakeActionsRequest
callback	PaginationCallback<protos.google.cloud.dataplex.v1.IListLakeActionsRequest, protos.google.cloud.dataplex.v1.IListActionsResponse | null | undefined, protos.google.cloud.dataplex.v1.IAction>

Returns

Type	Description
void

listLakeActionsAsync(request, options)

listLakeActionsAsync(request?: protos.google.cloud.dataplex.v1.IListLakeActionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dataplex.v1.IAction>;

Equivalent to listLakeActions, but returns an iterable object.

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListLakeActionsRequest 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.IAction>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Action]. 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the parent lake:
   *  `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`
   */
  // const parent = 'abc123'
  /**
   *  Optional. Maximum number of actions to return. The service may return fewer than this
   *  value. If unspecified, at most 10 actions 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 `ListLakeActions` call. Provide this to
   *  retrieve the subsequent page. When paginating, all other parameters
   *  provided to `ListLakeActions` must match the call that provided the page
   *  token.
   */
  // const pageToken = 'abc123'

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

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

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

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

  callListLakeActions();

listLakeActionsStream(request, options)

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

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListLakeActionsRequest 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 [Action] 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 listLakeActionsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listLakes(request, options)

listLakes(request?: protos.google.cloud.dataplex.v1.IListLakesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dataplex.v1.ILake[],
        protos.google.cloud.dataplex.v1.IListLakesRequest | null,
        protos.google.cloud.dataplex.v1.IListLakesResponse
    ]>;

Lists lake resources in a project and location.

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListLakesRequest 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.ILake[], protos.google.cloud.dataplex.v1.IListLakesRequest | null, protos.google.cloud.dataplex.v1.IListLakesResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [Lake]. 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 listLakesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listLakes(request, options, callback)

listLakes(request: protos.google.cloud.dataplex.v1.IListLakesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dataplex.v1.IListLakesRequest, protos.google.cloud.dataplex.v1.IListLakesResponse | null | undefined, protos.google.cloud.dataplex.v1.ILake>): void;

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListLakesRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.dataplex.v1.IListLakesRequest, protos.google.cloud.dataplex.v1.IListLakesResponse | null | undefined, protos.google.cloud.dataplex.v1.ILake>

Returns

Type	Description
void

listLakes(request, callback)

listLakes(request: protos.google.cloud.dataplex.v1.IListLakesRequest, callback: PaginationCallback<protos.google.cloud.dataplex.v1.IListLakesRequest, protos.google.cloud.dataplex.v1.IListLakesResponse | null | undefined, protos.google.cloud.dataplex.v1.ILake>): void;

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListLakesRequest
callback	PaginationCallback<protos.google.cloud.dataplex.v1.IListLakesRequest, protos.google.cloud.dataplex.v1.IListLakesResponse | null | undefined, protos.google.cloud.dataplex.v1.ILake>

Returns

Type	Description
void

listLakesAsync(request, options)

listLakesAsync(request?: protos.google.cloud.dataplex.v1.IListLakesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dataplex.v1.ILake>;

Equivalent to listLakes, but returns an iterable object.

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListLakesRequest 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.ILake>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Lake]. 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the lake 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 Lakes to return. The service may return fewer than this
   *  value. If unspecified, at most 10 lakes 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 `ListLakes` call. Provide this to
   *  retrieve the subsequent page. When paginating, all other parameters
   *  provided to `ListLakes` 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 {DataplexServiceClient} = require('@google-cloud/dataplex').v1;

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

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

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

  callListLakes();

listLakesStream(request, options)

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

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListLakesRequest 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 [Lake] 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 listLakesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listSessions(request, options)

listSessions(request?: protos.google.cloud.dataplex.v1.IListSessionsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dataplex.v1.ISession[],
        protos.google.cloud.dataplex.v1.IListSessionsRequest | null,
        protos.google.cloud.dataplex.v1.IListSessionsResponse
    ]>;

Lists session resources in an environment.

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListSessionsRequest 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.ISession[], protos.google.cloud.dataplex.v1.IListSessionsRequest | null, protos.google.cloud.dataplex.v1.IListSessionsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [Session]. 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 listSessionsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listSessions(request, options, callback)

listSessions(request: protos.google.cloud.dataplex.v1.IListSessionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dataplex.v1.IListSessionsRequest, protos.google.cloud.dataplex.v1.IListSessionsResponse | null | undefined, protos.google.cloud.dataplex.v1.ISession>): void;

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListSessionsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.dataplex.v1.IListSessionsRequest, protos.google.cloud.dataplex.v1.IListSessionsResponse | null | undefined, protos.google.cloud.dataplex.v1.ISession>

Returns

Type	Description
void

listSessions(request, callback)

listSessions(request: protos.google.cloud.dataplex.v1.IListSessionsRequest, callback: PaginationCallback<protos.google.cloud.dataplex.v1.IListSessionsRequest, protos.google.cloud.dataplex.v1.IListSessionsResponse | null | undefined, protos.google.cloud.dataplex.v1.ISession>): void;

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListSessionsRequest
callback	PaginationCallback<protos.google.cloud.dataplex.v1.IListSessionsRequest, protos.google.cloud.dataplex.v1.IListSessionsResponse | null | undefined, protos.google.cloud.dataplex.v1.ISession>

Returns

Type	Description
void

listSessionsAsync(request, options)

listSessionsAsync(request?: protos.google.cloud.dataplex.v1.IListSessionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dataplex.v1.ISession>;

Equivalent to listSessions, but returns an iterable object.

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListSessionsRequest 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.ISession>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Session]. 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the parent environment:
   *  projects/{project_number}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}
   */
  // const parent = 'abc123'
  /**
   *  Optional. Maximum number of sessions to return. The service may return fewer than
   *  this value. If unspecified, at most 10 sessions 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 `ListSessions` call. Provide this to
   *  retrieve the subsequent page. When paginating, all other parameters
   *  provided to `ListSessions` must match the call that provided the page
   *  token.
   */
  // const pageToken = 'abc123'

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

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

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

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

  callListSessions();

listSessionsStream(request, options)

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

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListSessionsRequest 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 [Session] 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 listSessionsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listTasks(request, options)

listTasks(request?: protos.google.cloud.dataplex.v1.IListTasksRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dataplex.v1.ITask[],
        protos.google.cloud.dataplex.v1.IListTasksRequest | null,
        protos.google.cloud.dataplex.v1.IListTasksResponse
    ]>;

Lists tasks under the given lake.

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListTasksRequest 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.ITask[], protos.google.cloud.dataplex.v1.IListTasksRequest | null, protos.google.cloud.dataplex.v1.IListTasksResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [Task]. 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 listTasksAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listTasks(request, options, callback)

listTasks(request: protos.google.cloud.dataplex.v1.IListTasksRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dataplex.v1.IListTasksRequest, protos.google.cloud.dataplex.v1.IListTasksResponse | null | undefined, protos.google.cloud.dataplex.v1.ITask>): void;

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListTasksRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.dataplex.v1.IListTasksRequest, protos.google.cloud.dataplex.v1.IListTasksResponse | null | undefined, protos.google.cloud.dataplex.v1.ITask>

Returns

Type	Description
void

listTasks(request, callback)

listTasks(request: protos.google.cloud.dataplex.v1.IListTasksRequest, callback: PaginationCallback<protos.google.cloud.dataplex.v1.IListTasksRequest, protos.google.cloud.dataplex.v1.IListTasksResponse | null | undefined, protos.google.cloud.dataplex.v1.ITask>): void;

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListTasksRequest
callback	PaginationCallback<protos.google.cloud.dataplex.v1.IListTasksRequest, protos.google.cloud.dataplex.v1.IListTasksResponse | null | undefined, protos.google.cloud.dataplex.v1.ITask>

Returns

Type	Description
void

listTasksAsync(request, options)

listTasksAsync(request?: protos.google.cloud.dataplex.v1.IListTasksRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dataplex.v1.ITask>;

Equivalent to listTasks, but returns an iterable object.

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListTasksRequest 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.ITask>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Task]. 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the parent lake:
   *  `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`.
   */
  // const parent = 'abc123'
  /**
   *  Optional. Maximum number of tasks to return. The service may return fewer than this
   *  value. If unspecified, at most 10 tasks 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 `ListZones` call. Provide this to
   *  retrieve the subsequent page. When paginating, all other parameters
   *  provided to `ListZones` 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 {DataplexServiceClient} = require('@google-cloud/dataplex').v1;

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

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

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

  callListTasks();

listTasksStream(request, options)

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

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListTasksRequest 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 [Task] 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 listTasksAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listZoneActions(request, options)

listZoneActions(request?: protos.google.cloud.dataplex.v1.IListZoneActionsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dataplex.v1.IAction[],
        protos.google.cloud.dataplex.v1.IListZoneActionsRequest | null,
        protos.google.cloud.dataplex.v1.IListActionsResponse
    ]>;

Lists action resources in a zone.

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListZoneActionsRequest 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.IAction[], protos.google.cloud.dataplex.v1.IListZoneActionsRequest | null, protos.google.cloud.dataplex.v1.IListActionsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [Action]. 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 listZoneActionsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listZoneActions(request, options, callback)

listZoneActions(request: protos.google.cloud.dataplex.v1.IListZoneActionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dataplex.v1.IListZoneActionsRequest, protos.google.cloud.dataplex.v1.IListActionsResponse | null | undefined, protos.google.cloud.dataplex.v1.IAction>): void;

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListZoneActionsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.dataplex.v1.IListZoneActionsRequest, protos.google.cloud.dataplex.v1.IListActionsResponse | null | undefined, protos.google.cloud.dataplex.v1.IAction>

Returns

Type	Description
void

listZoneActions(request, callback)

listZoneActions(request: protos.google.cloud.dataplex.v1.IListZoneActionsRequest, callback: PaginationCallback<protos.google.cloud.dataplex.v1.IListZoneActionsRequest, protos.google.cloud.dataplex.v1.IListActionsResponse | null | undefined, protos.google.cloud.dataplex.v1.IAction>): void;

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListZoneActionsRequest
callback	PaginationCallback<protos.google.cloud.dataplex.v1.IListZoneActionsRequest, protos.google.cloud.dataplex.v1.IListActionsResponse | null | undefined, protos.google.cloud.dataplex.v1.IAction>

Returns

Type	Description
void

listZoneActionsAsync(request, options)

listZoneActionsAsync(request?: protos.google.cloud.dataplex.v1.IListZoneActionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dataplex.v1.IAction>;

Equivalent to listZoneActions, but returns an iterable object.

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListZoneActionsRequest 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.IAction>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Action]. 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the parent zone:
   *  `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`.
   */
  // const parent = 'abc123'
  /**
   *  Optional. Maximum number of actions to return. The service may return fewer than this
   *  value. If unspecified, at most 10 actions 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 `ListZoneActions` call. Provide this to
   *  retrieve the subsequent page. When paginating, all other parameters
   *  provided to `ListZoneActions` must match the call that provided the page
   *  token.
   */
  // const pageToken = 'abc123'

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

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

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

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

  callListZoneActions();

listZoneActionsStream(request, options)

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

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListZoneActionsRequest 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 [Action] 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 listZoneActionsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listZones(request, options)

listZones(request?: protos.google.cloud.dataplex.v1.IListZonesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dataplex.v1.IZone[],
        protos.google.cloud.dataplex.v1.IListZonesRequest | null,
        protos.google.cloud.dataplex.v1.IListZonesResponse
    ]>;

Lists zone resources in a lake.

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListZonesRequest 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.IZone[], protos.google.cloud.dataplex.v1.IListZonesRequest | null, protos.google.cloud.dataplex.v1.IListZonesResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [Zone]. 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 listZonesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listZones(request, options, callback)

listZones(request: protos.google.cloud.dataplex.v1.IListZonesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dataplex.v1.IListZonesRequest, protos.google.cloud.dataplex.v1.IListZonesResponse | null | undefined, protos.google.cloud.dataplex.v1.IZone>): void;

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListZonesRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.dataplex.v1.IListZonesRequest, protos.google.cloud.dataplex.v1.IListZonesResponse | null | undefined, protos.google.cloud.dataplex.v1.IZone>

Returns

Type	Description
void

listZones(request, callback)

listZones(request: protos.google.cloud.dataplex.v1.IListZonesRequest, callback: PaginationCallback<protos.google.cloud.dataplex.v1.IListZonesRequest, protos.google.cloud.dataplex.v1.IListZonesResponse | null | undefined, protos.google.cloud.dataplex.v1.IZone>): void;

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListZonesRequest
callback	PaginationCallback<protos.google.cloud.dataplex.v1.IListZonesRequest, protos.google.cloud.dataplex.v1.IListZonesResponse | null | undefined, protos.google.cloud.dataplex.v1.IZone>

Returns

Type	Description
void

listZonesAsync(request, options)

listZonesAsync(request?: protos.google.cloud.dataplex.v1.IListZonesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dataplex.v1.IZone>;

Equivalent to listZones, but returns an iterable object.

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListZonesRequest 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.IZone>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Zone]. 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the parent lake:
   *  `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`.
   */
  // const parent = 'abc123'
  /**
   *  Optional. Maximum number of zones to return. The service may return fewer than this
   *  value. If unspecified, at most 10 zones 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 `ListZones` call. Provide this to
   *  retrieve the subsequent page. When paginating, all other parameters
   *  provided to `ListZones` 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 {DataplexServiceClient} = require('@google-cloud/dataplex').v1;

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

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

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

  callListZones();

listZonesStream(request, options)

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

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IListZonesRequest 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 [Zone] 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 listZonesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

locationPath(project, location)

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

Return a fully-qualified location resource name string.

Parameters

Name	Description
project	string
location	string

Returns

Type	Description
string	{string} Resource name string.

matchActionFromProjectLocationLakeActionName(projectLocationLakeActionName)

matchActionFromProjectLocationLakeActionName(projectLocationLakeActionName: string): string | number;

Parse the action from ProjectLocationLakeAction resource.

Parameter

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

Returns

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

matchActionFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName)

matchActionFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName: string): string | number;

Parse the action from ProjectLocationLakeZoneAction resource.

Parameter

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

Returns

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

matchActionFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName)

matchActionFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName: string): string | number;

Parse the action from ProjectLocationLakeZoneAssetAction resource.

Parameter

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

Returns

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

updateAsset(request, options)

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

Updates an asset resource.

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IUpdateAssetRequest 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.IAsset, 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Mask of fields to update.
   */
  // const updateMask = {}
  /**
   *  Required. Update description.
   *  Only fields specified in `update_mask` are updated.
   */
  // const asset = {}
  /**
   *  Optional. Only validate the request, but do not perform mutations.
   *  The default is false.
   */
  // const validateOnly = true

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

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

  async function callUpdateAsset() {
    // Construct request
    const request = {
      updateMask,
      asset,
    };

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

  callUpdateAsset();

updateAsset(request, options, callback)

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IUpdateAssetRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.dataplex.v1.IAsset, protos.google.cloud.dataplex.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns

Type	Description
void

updateAsset(request, callback)

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IUpdateAssetRequest
callback	Callback<LROperation<protos.google.cloud.dataplex.v1.IAsset, protos.google.cloud.dataplex.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns

Type	Description
void

updateEnvironment(request, options)

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

Update the environment resource.

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IUpdateEnvironmentRequest 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.IEnvironment, 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Mask of fields to update.
   */
  // const updateMask = {}
  /**
   *  Required. Update description.
   *  Only fields specified in `update_mask` are updated.
   */
  // const environment = {}
  /**
   *  Optional. Only validate the request, but do not perform mutations.
   *  The default is false.
   */
  // const validateOnly = true

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

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

  async function callUpdateEnvironment() {
    // Construct request
    const request = {
      updateMask,
      environment,
    };

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

  callUpdateEnvironment();

updateEnvironment(request, options, callback)

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IUpdateEnvironmentRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.dataplex.v1.IEnvironment, protos.google.cloud.dataplex.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns

Type	Description
void

updateEnvironment(request, callback)

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IUpdateEnvironmentRequest
callback	Callback<LROperation<protos.google.cloud.dataplex.v1.IEnvironment, protos.google.cloud.dataplex.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns

Type	Description
void

updateLake(request, options)

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

Updates a lake resource.

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IUpdateLakeRequest 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.ILake, 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Mask of fields to update.
   */
  // const updateMask = {}
  /**
   *  Required. Update description.
   *  Only fields specified in `update_mask` are updated.
   */
  // const lake = {}
  /**
   *  Optional. Only validate the request, but do not perform mutations.
   *  The default is false.
   */
  // const validateOnly = true

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

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

  async function callUpdateLake() {
    // Construct request
    const request = {
      updateMask,
      lake,
    };

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

  callUpdateLake();

updateLake(request, options, callback)

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IUpdateLakeRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.dataplex.v1.ILake, protos.google.cloud.dataplex.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns

Type	Description
void

updateLake(request, callback)

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IUpdateLakeRequest
callback	Callback<LROperation<protos.google.cloud.dataplex.v1.ILake, protos.google.cloud.dataplex.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns

Type	Description
void

updateTask(request, options)

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

Update the task resource.

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IUpdateTaskRequest 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.ITask, 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Mask of fields to update.
   */
  // const updateMask = {}
  /**
   *  Required. Update description.
   *  Only fields specified in `update_mask` are updated.
   */
  // const task = {}
  /**
   *  Optional. Only validate the request, but do not perform mutations.
   *  The default is false.
   */
  // const validateOnly = true

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

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

  async function callUpdateTask() {
    // Construct request
    const request = {
      updateMask,
      task,
    };

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

  callUpdateTask();

updateTask(request, options, callback)

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IUpdateTaskRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.dataplex.v1.ITask, protos.google.cloud.dataplex.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns

Type	Description
void

updateTask(request, callback)

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IUpdateTaskRequest
callback	Callback<LROperation<protos.google.cloud.dataplex.v1.ITask, protos.google.cloud.dataplex.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns

Type	Description
void

updateZone(request, options)

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

Updates a zone resource.

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IUpdateZoneRequest 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.IZone, 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Mask of fields to update.
   */
  // const updateMask = {}
  /**
   *  Required. Update description.
   *  Only fields specified in `update_mask` are updated.
   */
  // const zone = {}
  /**
   *  Optional. Only validate the request, but do not perform mutations.
   *  The default is false.
   */
  // const validateOnly = true

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

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

  async function callUpdateZone() {
    // Construct request
    const request = {
      updateMask,
      zone,
    };

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

  callUpdateZone();

updateZone(request, options, callback)

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IUpdateZoneRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.dataplex.v1.IZone, protos.google.cloud.dataplex.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns

Type	Description
void

updateZone(request, callback)

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

Parameters

Name	Description
request	protos.google.cloud.dataplex.v1.IUpdateZoneRequest
callback	Callback<LROperation<protos.google.cloud.dataplex.v1.IZone, 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.