Class v1.MetadataServiceClient (3.2.0)

Metadata service manages metadata resources such as tables, filesets and partitions. v1

Package

@google-cloud/dataplex

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of MetadataServiceClient.

Parameters
NameDescription
opts ClientOptions
gaxInstance typeof gax | typeof fallback

: loaded instance of google-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new MetadataServiceClient({fallback: true}, gax); ```

Properties

apiEndpoint

static get apiEndpoint(): string;

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

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

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

locationsClient

locationsClient: LocationsClient;

metadataServiceStub

metadataServiceStub?: Promise<{
        [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
NameDescription
project string
location string
lake string
zone string
asset string
Returns
TypeDescription
string

{string} Resource name string.

cancelOperation(request, options, callback)

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

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

Parameters
NameDescription
request CancelOperationRequest

The request object that will be sent.

options CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>

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

callback Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>

The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
TypeDescription
Promise<protos.google.protobuf.Empty>
Example

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

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
TypeDescription
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
NameDescription
project string
location string
lake string
content string
Returns
TypeDescription
string

{string} Resource name string.

createEntity(request, options)

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

Create a metadata entity.

Parameters
NameDescription
request ICreateEntityRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.dataplex.v1.IEntity, protos.google.cloud.dataplex.v1.ICreateEntityRequest | undefined, {} | undefined ]>

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

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the parent zone:
   *  `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`.
   */
  // const parent = 'abc123'
  /**
   *  Required. Entity resource.
   */
  // const entity = {}
  /**
   *  Optional. Only validate the request, but do not perform mutations.
   *  The default is false.
   */
  // const validateOnly = true

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

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

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

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

  callCreateEntity();

createEntity(request, options, callback)

createEntity(request: protos.google.cloud.dataplex.v1.ICreateEntityRequest, options: CallOptions, callback: Callback<protos.google.cloud.dataplex.v1.IEntity, protos.google.cloud.dataplex.v1.ICreateEntityRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request ICreateEntityRequest
options CallOptions
callback Callback<protos.google.cloud.dataplex.v1.IEntity, protos.google.cloud.dataplex.v1.ICreateEntityRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createEntity(request, callback)

createEntity(request: protos.google.cloud.dataplex.v1.ICreateEntityRequest, callback: Callback<protos.google.cloud.dataplex.v1.IEntity, protos.google.cloud.dataplex.v1.ICreateEntityRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request ICreateEntityRequest
callback Callback<protos.google.cloud.dataplex.v1.IEntity, protos.google.cloud.dataplex.v1.ICreateEntityRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createPartition(request, options)

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

Create a metadata partition.

Parameters
NameDescription
request ICreatePartitionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.dataplex.v1.IPartition, protos.google.cloud.dataplex.v1.ICreatePartitionRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Partition. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the parent zone:
   *  `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}`.
   */
  // const parent = 'abc123'
  /**
   *  Required. Partition resource.
   */
  // const partition = {}
  /**
   *  Optional. Only validate the request, but do not perform mutations.
   *  The default is false.
   */
  // const validateOnly = true

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

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

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

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

  callCreatePartition();

createPartition(request, options, callback)

createPartition(request: protos.google.cloud.dataplex.v1.ICreatePartitionRequest, options: CallOptions, callback: Callback<protos.google.cloud.dataplex.v1.IPartition, protos.google.cloud.dataplex.v1.ICreatePartitionRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request ICreatePartitionRequest
options CallOptions
callback Callback<protos.google.cloud.dataplex.v1.IPartition, protos.google.cloud.dataplex.v1.ICreatePartitionRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createPartition(request, callback)

createPartition(request: protos.google.cloud.dataplex.v1.ICreatePartitionRequest, callback: Callback<protos.google.cloud.dataplex.v1.IPartition, protos.google.cloud.dataplex.v1.ICreatePartitionRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request ICreatePartitionRequest
callback Callback<protos.google.cloud.dataplex.v1.IPartition, protos.google.cloud.dataplex.v1.ICreatePartitionRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

dataAttributeBindingPath(project, location, dataAttributeBindingId)

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

Return a fully-qualified dataAttributeBinding resource name string.

Parameters
NameDescription
project string
location string
dataAttributeBindingId string
Returns
TypeDescription
string

{string} Resource name string.

dataAttributePath(project, location, dataTaxonomy, dataAttributeId)

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

Return a fully-qualified dataAttribute resource name string.

Parameters
NameDescription
project string
location string
dataTaxonomy string
dataAttributeId string
Returns
TypeDescription
string

{string} Resource name string.

dataScanJobPath(project, location, dataScan, job)

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

Return a fully-qualified dataScanJob resource name string.

Parameters
NameDescription
project string
location string
dataScan string
job string
Returns
TypeDescription
string

{string} Resource name string.

dataScanPath(project, location, dataScan)

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

Return a fully-qualified dataScan resource name string.

Parameters
NameDescription
project string
location string
dataScan string
Returns
TypeDescription
string

{string} Resource name string.

dataTaxonomyPath(project, location, dataTaxonomyId)

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

Return a fully-qualified dataTaxonomy resource name string.

Parameters
NameDescription
project string
location string
dataTaxonomyId string
Returns
TypeDescription
string

{string} Resource name string.

deleteEntity(request, options)

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

Delete a metadata entity.

Parameters
NameDescription
request IDeleteEntityRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.protobuf.IEmpty, protos.google.cloud.dataplex.v1.IDeleteEntityRequest | 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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the entity:
   *  `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}`.
   */
  // const name = 'abc123'
  /**
   *  Required. The etag associated with the entity, which can be retrieved with
   *  a GetEntity   request.
   */
  // const etag = 'abc123'

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

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

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

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

  callDeleteEntity();

deleteEntity(request, options, callback)

deleteEntity(request: protos.google.cloud.dataplex.v1.IDeleteEntityRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dataplex.v1.IDeleteEntityRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDeleteEntityRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dataplex.v1.IDeleteEntityRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteEntity(request, callback)

deleteEntity(request: protos.google.cloud.dataplex.v1.IDeleteEntityRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dataplex.v1.IDeleteEntityRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDeleteEntityRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dataplex.v1.IDeleteEntityRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteOperation(request, options, callback)

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

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

Parameters
NameDescription
request DeleteOperationRequest

The request object that will be sent.

options CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>

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

callback Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>

The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
TypeDescription
Promise<protos.google.protobuf.Empty>
Example

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

deletePartition(request, options)

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

Delete a metadata partition.

Parameters
NameDescription
request IDeletePartitionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.protobuf.IEmpty, protos.google.cloud.dataplex.v1.IDeletePartitionRequest | 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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the partition.
   *  format:
   *  `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}/partitions/{partition_value_path}`.
   *  The {partition_value_path} segment consists of an ordered sequence of
   *  partition values separated by "/". All values must be provided.
   */
  // const name = 'abc123'
  /**
   *  Optional. The etag associated with the partition.
   */
  // const etag = 'abc123'

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

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

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

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

  callDeletePartition();

deletePartition(request, options, callback)

deletePartition(request: protos.google.cloud.dataplex.v1.IDeletePartitionRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dataplex.v1.IDeletePartitionRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDeletePartitionRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dataplex.v1.IDeletePartitionRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deletePartition(request, callback)

deletePartition(request: protos.google.cloud.dataplex.v1.IDeletePartitionRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dataplex.v1.IDeletePartitionRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDeletePartitionRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dataplex.v1.IDeletePartitionRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
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
NameDescription
project string
location string
lake string
zone string
entity string
Returns
TypeDescription
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
NameDescription
project string
location string
lake string
environment string
Returns
TypeDescription
string

{string} Resource name string.

getEntity(request, options)

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

Get a metadata entity.

Parameters
NameDescription
request IGetEntityRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.dataplex.v1.IEntity, protos.google.cloud.dataplex.v1.IGetEntityRequest | undefined, {} | undefined ]>

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

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the entity:
   *  `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.`
   */
  // const name = 'abc123'
  /**
   *  Optional. Used to select the subset of entity information to return.
   *  Defaults to `BASIC`.
   */
  // const view = {}

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

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

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

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

  callGetEntity();

getEntity(request, options, callback)

getEntity(request: protos.google.cloud.dataplex.v1.IGetEntityRequest, options: CallOptions, callback: Callback<protos.google.cloud.dataplex.v1.IEntity, protos.google.cloud.dataplex.v1.IGetEntityRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetEntityRequest
options CallOptions
callback Callback<protos.google.cloud.dataplex.v1.IEntity, protos.google.cloud.dataplex.v1.IGetEntityRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getEntity(request, callback)

getEntity(request: protos.google.cloud.dataplex.v1.IGetEntityRequest, callback: Callback<protos.google.cloud.dataplex.v1.IEntity, protos.google.cloud.dataplex.v1.IGetEntityRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetEntityRequest
callback Callback<protos.google.cloud.dataplex.v1.IEntity, protos.google.cloud.dataplex.v1.IGetEntityRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getLocation(request, options, callback)

getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;

Gets information about a location.

Parameters
NameDescription
request LocationProtos.google.cloud.location.IGetLocationRequest

The request object that will be sent.

options CallOptions | Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>

Call options. See CallOptions for more details.

callback Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
Promise<google.cloud.location.ILocation>

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

Example

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

getOperation(request, options, callback)

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

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

Parameters
NameDescription
request GetOperationRequest

The request object that will be sent.

options CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>

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

callback Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

Returns
TypeDescription
Promise<[protos.google.longrunning.Operation]>
Example

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

getPartition(request, options)

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

Get a metadata partition of an entity.

Parameters
NameDescription
request IGetPartitionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.dataplex.v1.IPartition, protos.google.cloud.dataplex.v1.IGetPartitionRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Partition. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the partition:
   *  `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}/partitions/{partition_value_path}`.
   *  The {partition_value_path} segment consists of an ordered sequence of
   *  partition values separated by "/". All values must be provided.
   */
  // const name = 'abc123'

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

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

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

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

  callGetPartition();

getPartition(request, options, callback)

getPartition(request: protos.google.cloud.dataplex.v1.IGetPartitionRequest, options: CallOptions, callback: Callback<protos.google.cloud.dataplex.v1.IPartition, protos.google.cloud.dataplex.v1.IGetPartitionRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetPartitionRequest
options CallOptions
callback Callback<protos.google.cloud.dataplex.v1.IPartition, protos.google.cloud.dataplex.v1.IGetPartitionRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getPartition(request, callback)

getPartition(request: protos.google.cloud.dataplex.v1.IGetPartitionRequest, callback: Callback<protos.google.cloud.dataplex.v1.IPartition, protos.google.cloud.dataplex.v1.IGetPartitionRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetPartitionRequest
callback Callback<protos.google.cloud.dataplex.v1.IPartition, protos.google.cloud.dataplex.v1.IGetPartitionRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getProjectId()

getProjectId(): Promise<string>;
Returns
TypeDescription
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
NameDescription
callback Callback<string, undefined, undefined>
Returns
TypeDescription
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
TypeDescription
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
NameDescription
project string
location string
lake string
task string
job string
Returns
TypeDescription
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
NameDescription
project string
location string
lake string
Returns
TypeDescription
string

{string} Resource name string.

listEntities(request, options)

listEntities(request?: protos.google.cloud.dataplex.v1.IListEntitiesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dataplex.v1.IEntity[],
        protos.google.cloud.dataplex.v1.IListEntitiesRequest | null,
        protos.google.cloud.dataplex.v1.IListEntitiesResponse
    ]>;

List metadata entities in a zone.

Parameters
NameDescription
request IListEntitiesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.dataplex.v1.IEntity[], protos.google.cloud.dataplex.v1.IListEntitiesRequest | null, protos.google.cloud.dataplex.v1.IListEntitiesResponse ]>

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

listEntities(request, options, callback)

listEntities(request: protos.google.cloud.dataplex.v1.IListEntitiesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dataplex.v1.IListEntitiesRequest, protos.google.cloud.dataplex.v1.IListEntitiesResponse | null | undefined, protos.google.cloud.dataplex.v1.IEntity>): void;
Parameters
NameDescription
request IListEntitiesRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.dataplex.v1.IListEntitiesRequest, protos.google.cloud.dataplex.v1.IListEntitiesResponse | null | undefined, protos.google.cloud.dataplex.v1.IEntity>
Returns
TypeDescription
void

listEntities(request, callback)

listEntities(request: protos.google.cloud.dataplex.v1.IListEntitiesRequest, callback: PaginationCallback<protos.google.cloud.dataplex.v1.IListEntitiesRequest, protos.google.cloud.dataplex.v1.IListEntitiesResponse | null | undefined, protos.google.cloud.dataplex.v1.IEntity>): void;
Parameters
NameDescription
request IListEntitiesRequest
callback PaginationCallback<protos.google.cloud.dataplex.v1.IListEntitiesRequest, protos.google.cloud.dataplex.v1.IListEntitiesResponse | null | undefined, protos.google.cloud.dataplex.v1.IEntity>
Returns
TypeDescription
void

listEntitiesAsync(request, options)

listEntitiesAsync(request?: protos.google.cloud.dataplex.v1.IListEntitiesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dataplex.v1.IEntity>;

Equivalent to listEntities, but returns an iterable object.

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

Parameters
NameDescription
request IListEntitiesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.dataplex.v1.IEntity>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the parent zone:
   *  `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`.
   */
  // const parent = 'abc123'
  /**
   *  Required. Specify the entity view to make a partial list request.
   */
  // const view = {}
  /**
   *  Optional. Maximum number of entities to return. The service may return
   *  fewer than this value. If unspecified, 100 entities will be returned by
   *  default. The maximum value is 500; larger values will will be truncated to
   *  500.
   */
  // const pageSize = 1234
  /**
   *  Optional. Page token received from a previous `ListEntities` call. Provide
   *  this to retrieve the subsequent page. When paginating, all other parameters
   *  provided to `ListEntities` must match the call that provided the
   *  page token.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. The following filter parameters can be added to the URL to limit
   *  the entities returned by the API:
   *  - Entity ID: ?filter="id=entityID"
   *  - Asset ID: ?filter="asset=assetID"
   *  - Data path ?filter="data_path=gs://my-bucket"
   *  - Is HIVE compatible: ?filter="hive_compatible=true"
   *  - Is BigQuery compatible: ?filter="bigquery_compatible=true"
   */
  // const filter = 'abc123'

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

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

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

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

  callListEntities();

listEntitiesStream(request, options)

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

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

Parameters
NameDescription
request IListEntitiesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listEntitiesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listLocationsAsync(request, options)

listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;

Lists information about the supported locations for this service. Returns an iterable object.

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

Parameters
NameDescription
request LocationProtos.google.cloud.location.IListLocationsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<google.cloud.location.ILocation>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

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

listOperationsAsync(request, options)

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

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

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

Parameters
NameDescription
request ListOperationsRequest

The request object that will be sent.

options CallOptions

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

Returns
TypeDescription
AsyncIterable<protos.google.longrunning.ListOperationsResponse>

{Object} An iterable Object that conforms to iteration protocols.

Example

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

listPartitions(request, options)

listPartitions(request?: protos.google.cloud.dataplex.v1.IListPartitionsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dataplex.v1.IPartition[],
        protos.google.cloud.dataplex.v1.IListPartitionsRequest | null,
        protos.google.cloud.dataplex.v1.IListPartitionsResponse
    ]>;

List metadata partitions of an entity.

Parameters
NameDescription
request IListPartitionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.dataplex.v1.IPartition[], protos.google.cloud.dataplex.v1.IListPartitionsRequest | null, protos.google.cloud.dataplex.v1.IListPartitionsResponse ]>

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

listPartitions(request, options, callback)

listPartitions(request: protos.google.cloud.dataplex.v1.IListPartitionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dataplex.v1.IListPartitionsRequest, protos.google.cloud.dataplex.v1.IListPartitionsResponse | null | undefined, protos.google.cloud.dataplex.v1.IPartition>): void;
Parameters
NameDescription
request IListPartitionsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.dataplex.v1.IListPartitionsRequest, protos.google.cloud.dataplex.v1.IListPartitionsResponse | null | undefined, protos.google.cloud.dataplex.v1.IPartition>
Returns
TypeDescription
void

listPartitions(request, callback)

listPartitions(request: protos.google.cloud.dataplex.v1.IListPartitionsRequest, callback: PaginationCallback<protos.google.cloud.dataplex.v1.IListPartitionsRequest, protos.google.cloud.dataplex.v1.IListPartitionsResponse | null | undefined, protos.google.cloud.dataplex.v1.IPartition>): void;
Parameters
NameDescription
request IListPartitionsRequest
callback PaginationCallback<protos.google.cloud.dataplex.v1.IListPartitionsRequest, protos.google.cloud.dataplex.v1.IListPartitionsResponse | null | undefined, protos.google.cloud.dataplex.v1.IPartition>
Returns
TypeDescription
void

listPartitionsAsync(request, options)

listPartitionsAsync(request?: protos.google.cloud.dataplex.v1.IListPartitionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dataplex.v1.IPartition>;

Equivalent to listPartitions, but returns an iterable object.

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

Parameters
NameDescription
request IListPartitionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.dataplex.v1.IPartition>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Partition. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the parent entity:
   *  `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}`.
   */
  // const parent = 'abc123'
  /**
   *  Optional. Maximum number of partitions to return. The service may return
   *  fewer than this value. If unspecified, 100 partitions will be returned by
   *  default. The maximum page size is 500; larger values will will be truncated
   *  to 500.
   */
  // const pageSize = 1234
  /**
   *  Optional. Page token received from a previous `ListPartitions` call.
   *  Provide this to retrieve the subsequent page. When paginating, all other
   *  parameters provided to `ListPartitions` must match the call that provided
   *  the page token.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Filter the partitions returned to the caller using a key value
   *  pair expression. Supported operators and syntax:
   *  - logic operators: AND, OR
   *  - comparison operators: <,>, >=, <= ,="," !="*" -="" like="" operators:="" *="" -="" the="" right="" hand="" of="" a="" like="" operator="" supports="" "."="" and="" *="" "*"="" for="" wildcard="" searches,="" for="" example="" "value1="" like="" ".*oo.*"="" *="" -="" parenthetical="" grouping:="" (="" )="" *="" sample="" filter="" expression:="" `?filter="key1 < value1 OR key2 > value2" *="" **notes:**="" *="" -="" keys="" to="" the="" left="" of="" operators="" are="" case="" insensitive.="" *="" -="" partition="" results="" are="" sorted="" first="" by="" creation="" time,="" then="" by="" *="" lexicographic="" order.="" *="" -="" up="" to="" 20="" key="" value="" filter="" pairs="" are="" allowed,="" but="" due="" to="" performance="" *="" considerations,="" only="" the="" first="" 10="" will="" be="" used="" as="" a="" filter.="" */="" const="" filter='abc123' imports="" the="" dataplex="" library="" const="" {metadataserviceclient}="require('@google-cloud/dataplex').v1;" instantiates="" a="" client="" const="" dataplexclient="new" metadataserviceclient();="" async="" function="" calllistpartitions()="" {="" construct="" request="" const="" request="{" parent,="" };="" run="" request="" const="" iterable="await" dataplexclient.listpartitionsasync(request);="" for="" await="" (const="" response="" of="" iterable)="" {="" console.log(response);="" }="" }="" calllistpartitions();="">

listPartitionsStream(request, options)

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

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

Parameters
NameDescription
request IListPartitionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

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

matchActionFromProjectLocationLakeActionName(projectLocationLakeActionName)

matchActionFromProjectLocationLakeActionName(projectLocationLakeActionName: string): string | number;

Parse the action from ProjectLocationLakeAction resource.

Parameter
NameDescription
projectLocationLakeActionName string

A fully-qualified path representing project_location_lake_action resource.

Returns
TypeDescription
string | number

{string} A string representing the action.

matchActionFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName)

matchActionFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName: string): string | number;

Parse the action from ProjectLocationLakeZoneAction resource.

Parameter
NameDescription
projectLocationLakeZoneActionName string

A fully-qualified path representing project_location_lake_zone_action resource.

Returns
TypeDescription
string | number

{string} A string representing the action.

matchActionFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName)

matchActionFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName: string): string | number;

Parse the action from ProjectLocationLakeZoneAssetAction resource.

Parameter
NameDescription
projectLocationLakeZoneAssetActionName string

A fully-qualified path representing project_location_lake_zone_asset_action resource.

Returns
TypeDescription
string | number

{string} A string representing the action.

matchAssetFromAssetName(assetName)

matchAssetFromAssetName(assetName: string): string | number;

Parse the asset from Asset resource.

Parameter
NameDescription
assetName string

A fully-qualified path representing Asset resource.

Returns
TypeDescription
string | number

{string} A string representing the asset.

matchAssetFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName)

matchAssetFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName: string): string | number;

Parse the asset from ProjectLocationLakeZoneAssetAction resource.

Parameter
NameDescription
projectLocationLakeZoneAssetActionName string

A fully-qualified path representing project_location_lake_zone_asset_action resource.

Returns
TypeDescription
string | number

{string} A string representing the asset.

matchContentFromContentName(contentName)

matchContentFromContentName(contentName: string): string | number;

Parse the content from Content resource.

Parameter
NameDescription
contentName string

A fully-qualified path representing Content resource.

Returns
TypeDescription
string | number

{string} A string representing the content.

matchDataAttributeBindingIdFromDataAttributeBindingName(dataAttributeBindingName)

matchDataAttributeBindingIdFromDataAttributeBindingName(dataAttributeBindingName: string): string | number;

Parse the data_attribute_binding_id from DataAttributeBinding resource.

Parameter
NameDescription
dataAttributeBindingName string

A fully-qualified path representing DataAttributeBinding resource.

Returns
TypeDescription
string | number

{string} A string representing the data_attribute_binding_id.

matchDataAttributeIdFromDataAttributeName(dataAttributeName)

matchDataAttributeIdFromDataAttributeName(dataAttributeName: string): string | number;

Parse the data_attribute_id from DataAttribute resource.

Parameter
NameDescription
dataAttributeName string

A fully-qualified path representing DataAttribute resource.

Returns
TypeDescription
string | number

{string} A string representing the data_attribute_id.

matchDataScanFromDataScanJobName(dataScanJobName)

matchDataScanFromDataScanJobName(dataScanJobName: string): string | number;

Parse the dataScan from DataScanJob resource.

Parameter
NameDescription
dataScanJobName string

A fully-qualified path representing DataScanJob resource.

Returns
TypeDescription
string | number

{string} A string representing the dataScan.

matchDataScanFromDataScanName(dataScanName)

matchDataScanFromDataScanName(dataScanName: string): string | number;

Parse the dataScan from DataScan resource.

Parameter
NameDescription
dataScanName string

A fully-qualified path representing DataScan resource.

Returns
TypeDescription
string | number

{string} A string representing the dataScan.

matchDataTaxonomyFromDataAttributeName(dataAttributeName)

matchDataTaxonomyFromDataAttributeName(dataAttributeName: string): string | number;

Parse the dataTaxonomy from DataAttribute resource.

Parameter
NameDescription
dataAttributeName string

A fully-qualified path representing DataAttribute resource.

Returns
TypeDescription
string | number

{string} A string representing the dataTaxonomy.

matchDataTaxonomyIdFromDataTaxonomyName(dataTaxonomyName)

matchDataTaxonomyIdFromDataTaxonomyName(dataTaxonomyName: string): string | number;

Parse the data_taxonomy_id from DataTaxonomy resource.

Parameter
NameDescription
dataTaxonomyName string

A fully-qualified path representing DataTaxonomy resource.

Returns
TypeDescription
string | number

{string} A string representing the data_taxonomy_id.

matchEntityFromEntityName(entityName)

matchEntityFromEntityName(entityName: string): string | number;

Parse the entity from Entity resource.

Parameter
NameDescription
entityName string

A fully-qualified path representing Entity resource.

Returns
TypeDescription
string | number

{string} A string representing the entity.

matchEntityFromPartitionName(partitionName)

matchEntityFromPartitionName(partitionName: string): string | number;

Parse the entity from Partition resource.

Parameter
NameDescription
partitionName string

A fully-qualified path representing Partition resource.

Returns
TypeDescription
string | number

{string} A string representing the entity.

matchEnvironmentFromEnvironmentName(environmentName)

matchEnvironmentFromEnvironmentName(environmentName: string): string | number;

Parse the environment from Environment resource.

Parameter
NameDescription
environmentName string

A fully-qualified path representing Environment resource.

Returns
TypeDescription
string | number

{string} A string representing the environment.

matchEnvironmentFromSessionName(sessionName)

matchEnvironmentFromSessionName(sessionName: string): string | number;

Parse the environment from Session resource.

Parameter
NameDescription
sessionName string

A fully-qualified path representing Session resource.

Returns
TypeDescription
string | number

{string} A string representing the environment.

matchJobFromDataScanJobName(dataScanJobName)

matchJobFromDataScanJobName(dataScanJobName: string): string | number;

Parse the job from DataScanJob resource.

Parameter
NameDescription
dataScanJobName string

A fully-qualified path representing DataScanJob resource.

Returns
TypeDescription
string | number

{string} A string representing the job.

matchJobFromJobName(jobName)

matchJobFromJobName(jobName: string): string | number;

Parse the job from Job resource.

Parameter
NameDescription
jobName string

A fully-qualified path representing Job resource.

Returns
TypeDescription
string | number

{string} A string representing the job.

matchLakeFromAssetName(assetName)

matchLakeFromAssetName(assetName: string): string | number;

Parse the lake from Asset resource.

Parameter
NameDescription
assetName string

A fully-qualified path representing Asset resource.

Returns
TypeDescription
string | number

{string} A string representing the lake.

matchLakeFromContentName(contentName)

matchLakeFromContentName(contentName: string): string | number;

Parse the lake from Content resource.

Parameter
NameDescription
contentName string

A fully-qualified path representing Content resource.

Returns
TypeDescription
string | number

{string} A string representing the lake.

matchLakeFromEntityName(entityName)

matchLakeFromEntityName(entityName: string): string | number;

Parse the lake from Entity resource.

Parameter
NameDescription
entityName string

A fully-qualified path representing Entity resource.

Returns
TypeDescription
string | number

{string} A string representing the lake.

matchLakeFromEnvironmentName(environmentName)

matchLakeFromEnvironmentName(environmentName: string): string | number;

Parse the lake from Environment resource.

Parameter
NameDescription
environmentName string

A fully-qualified path representing Environment resource.

Returns
TypeDescription
string | number

{string} A string representing the lake.

matchLakeFromJobName(jobName)

matchLakeFromJobName(jobName: string): string | number;

Parse the lake from Job resource.

Parameter
NameDescription
jobName string

A fully-qualified path representing Job resource.

Returns
TypeDescription
string | number

{string} A string representing the lake.

matchLakeFromLakeName(lakeName)

matchLakeFromLakeName(lakeName: string): string | number;

Parse the lake from Lake resource.

Parameter
NameDescription
lakeName string

A fully-qualified path representing Lake resource.

Returns
TypeDescription
string | number

{string} A string representing the lake.

matchLakeFromPartitionName(partitionName)

matchLakeFromPartitionName(partitionName: string): string | number;

Parse the lake from Partition resource.

Parameter
NameDescription
partitionName string

A fully-qualified path representing Partition resource.

Returns
TypeDescription
string | number

{string} A string representing the lake.

matchLakeFromProjectLocationLakeActionName(projectLocationLakeActionName)

matchLakeFromProjectLocationLakeActionName(projectLocationLakeActionName: string): string | number;

Parse the lake from ProjectLocationLakeAction resource.

Parameter
NameDescription
projectLocationLakeActionName string

A fully-qualified path representing project_location_lake_action resource.

Returns
TypeDescription
string | number

{string} A string representing the lake.

matchLakeFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName)

matchLakeFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName: string): string | number;

Parse the lake from ProjectLocationLakeZoneAction resource.

Parameter
NameDescription
projectLocationLakeZoneActionName string

A fully-qualified path representing project_location_lake_zone_action resource.

Returns
TypeDescription
string | number

{string} A string representing the lake.

matchLakeFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName)

matchLakeFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName: string): string | number;

Parse the lake from ProjectLocationLakeZoneAssetAction resource.

Parameter
NameDescription
projectLocationLakeZoneAssetActionName string

A fully-qualified path representing project_location_lake_zone_asset_action resource.

Returns
TypeDescription
string | number

{string} A string representing the lake.

matchLakeFromSessionName(sessionName)

matchLakeFromSessionName(sessionName: string): string | number;

Parse the lake from Session resource.

Parameter
NameDescription
sessionName string

A fully-qualified path representing Session resource.

Returns
TypeDescription
string | number

{string} A string representing the lake.

matchLakeFromTaskName(taskName)

matchLakeFromTaskName(taskName: string): string | number;

Parse the lake from Task resource.

Parameter
NameDescription
taskName string

A fully-qualified path representing Task resource.

Returns
TypeDescription
string | number

{string} A string representing the lake.

matchLakeFromZoneName(zoneName)

matchLakeFromZoneName(zoneName: string): string | number;

Parse the lake from Zone resource.

Parameter
NameDescription
zoneName string

A fully-qualified path representing Zone resource.

Returns
TypeDescription
string | number

{string} A string representing the lake.

matchLocationFromAssetName(assetName)

matchLocationFromAssetName(assetName: string): string | number;

Parse the location from Asset resource.

Parameter
NameDescription
assetName string

A fully-qualified path representing Asset resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromContentName(contentName)

matchLocationFromContentName(contentName: string): string | number;

Parse the location from Content resource.

Parameter
NameDescription
contentName string

A fully-qualified path representing Content resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromDataAttributeBindingName(dataAttributeBindingName)

matchLocationFromDataAttributeBindingName(dataAttributeBindingName: string): string | number;

Parse the location from DataAttributeBinding resource.

Parameter
NameDescription
dataAttributeBindingName string

A fully-qualified path representing DataAttributeBinding resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromDataAttributeName(dataAttributeName)

matchLocationFromDataAttributeName(dataAttributeName: string): string | number;

Parse the location from DataAttribute resource.

Parameter
NameDescription
dataAttributeName string

A fully-qualified path representing DataAttribute resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromDataScanJobName(dataScanJobName)

matchLocationFromDataScanJobName(dataScanJobName: string): string | number;

Parse the location from DataScanJob resource.

Parameter
NameDescription
dataScanJobName string

A fully-qualified path representing DataScanJob resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromDataScanName(dataScanName)

matchLocationFromDataScanName(dataScanName: string): string | number;

Parse the location from DataScan resource.

Parameter
NameDescription
dataScanName string

A fully-qualified path representing DataScan resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromDataTaxonomyName(dataTaxonomyName)

matchLocationFromDataTaxonomyName(dataTaxonomyName: string): string | number;

Parse the location from DataTaxonomy resource.

Parameter
NameDescription
dataTaxonomyName string

A fully-qualified path representing DataTaxonomy resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromEntityName(entityName)

matchLocationFromEntityName(entityName: string): string | number;

Parse the location from Entity resource.

Parameter
NameDescription
entityName string

A fully-qualified path representing Entity resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromEnvironmentName(environmentName)

matchLocationFromEnvironmentName(environmentName: string): string | number;

Parse the location from Environment resource.

Parameter
NameDescription
environmentName string

A fully-qualified path representing Environment resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromJobName(jobName)

matchLocationFromJobName(jobName: string): string | number;

Parse the location from Job resource.

Parameter
NameDescription
jobName string

A fully-qualified path representing Job resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromLakeName(lakeName)

matchLocationFromLakeName(lakeName: string): string | number;

Parse the location from Lake resource.

Parameter
NameDescription
lakeName string

A fully-qualified path representing Lake resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromPartitionName(partitionName)

matchLocationFromPartitionName(partitionName: string): string | number;

Parse the location from Partition resource.

Parameter
NameDescription
partitionName string

A fully-qualified path representing Partition resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromProjectLocationLakeActionName(projectLocationLakeActionName)

matchLocationFromProjectLocationLakeActionName(projectLocationLakeActionName: string): string | number;

Parse the location from ProjectLocationLakeAction resource.

Parameter
NameDescription
projectLocationLakeActionName string

A fully-qualified path representing project_location_lake_action resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName)

matchLocationFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName: string): string | number;

Parse the location from ProjectLocationLakeZoneAction resource.

Parameter
NameDescription
projectLocationLakeZoneActionName string

A fully-qualified path representing project_location_lake_zone_action resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName)

matchLocationFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName: string): string | number;

Parse the location from ProjectLocationLakeZoneAssetAction resource.

Parameter
NameDescription
projectLocationLakeZoneAssetActionName string

A fully-qualified path representing project_location_lake_zone_asset_action resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromSessionName(sessionName)

matchLocationFromSessionName(sessionName: string): string | number;

Parse the location from Session resource.

Parameter
NameDescription
sessionName string

A fully-qualified path representing Session resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromTaskName(taskName)

matchLocationFromTaskName(taskName: string): string | number;

Parse the location from Task resource.

Parameter
NameDescription
taskName string

A fully-qualified path representing Task resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromZoneName(zoneName)

matchLocationFromZoneName(zoneName: string): string | number;

Parse the location from Zone resource.

Parameter
NameDescription
zoneName string

A fully-qualified path representing Zone resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchPartitionFromPartitionName(partitionName)

matchPartitionFromPartitionName(partitionName: string): string | number;

Parse the partition from Partition resource.

Parameter
NameDescription
partitionName string

A fully-qualified path representing Partition resource.

Returns
TypeDescription
string | number

{string} A string representing the partition.

matchProjectFromAssetName(assetName)

matchProjectFromAssetName(assetName: string): string | number;

Parse the project from Asset resource.

Parameter
NameDescription
assetName string

A fully-qualified path representing Asset resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromContentName(contentName)

matchProjectFromContentName(contentName: string): string | number;

Parse the project from Content resource.

Parameter
NameDescription
contentName string

A fully-qualified path representing Content resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromDataAttributeBindingName(dataAttributeBindingName)

matchProjectFromDataAttributeBindingName(dataAttributeBindingName: string): string | number;

Parse the project from DataAttributeBinding resource.

Parameter
NameDescription
dataAttributeBindingName string

A fully-qualified path representing DataAttributeBinding resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromDataAttributeName(dataAttributeName)

matchProjectFromDataAttributeName(dataAttributeName: string): string | number;

Parse the project from DataAttribute resource.

Parameter
NameDescription
dataAttributeName string

A fully-qualified path representing DataAttribute resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromDataScanJobName(dataScanJobName)

matchProjectFromDataScanJobName(dataScanJobName: string): string | number;

Parse the project from DataScanJob resource.

Parameter
NameDescription
dataScanJobName string

A fully-qualified path representing DataScanJob resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromDataScanName(dataScanName)

matchProjectFromDataScanName(dataScanName: string): string | number;

Parse the project from DataScan resource.

Parameter
NameDescription
dataScanName string

A fully-qualified path representing DataScan resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromDataTaxonomyName(dataTaxonomyName)

matchProjectFromDataTaxonomyName(dataTaxonomyName: string): string | number;

Parse the project from DataTaxonomy resource.

Parameter
NameDescription
dataTaxonomyName string

A fully-qualified path representing DataTaxonomy resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromEntityName(entityName)

matchProjectFromEntityName(entityName: string): string | number;

Parse the project from Entity resource.

Parameter
NameDescription
entityName string

A fully-qualified path representing Entity resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromEnvironmentName(environmentName)

matchProjectFromEnvironmentName(environmentName: string): string | number;

Parse the project from Environment resource.

Parameter
NameDescription
environmentName string

A fully-qualified path representing Environment resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromJobName(jobName)

matchProjectFromJobName(jobName: string): string | number;

Parse the project from Job resource.

Parameter
NameDescription
jobName string

A fully-qualified path representing Job resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromLakeName(lakeName)

matchProjectFromLakeName(lakeName: string): string | number;

Parse the project from Lake resource.

Parameter
NameDescription
lakeName string

A fully-qualified path representing Lake resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromPartitionName(partitionName)

matchProjectFromPartitionName(partitionName: string): string | number;

Parse the project from Partition resource.

Parameter
NameDescription
partitionName string

A fully-qualified path representing Partition resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectLocationLakeActionName(projectLocationLakeActionName)

matchProjectFromProjectLocationLakeActionName(projectLocationLakeActionName: string): string | number;

Parse the project from ProjectLocationLakeAction resource.

Parameter
NameDescription
projectLocationLakeActionName string

A fully-qualified path representing project_location_lake_action resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName)

matchProjectFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName: string): string | number;

Parse the project from ProjectLocationLakeZoneAction resource.

Parameter
NameDescription
projectLocationLakeZoneActionName string

A fully-qualified path representing project_location_lake_zone_action resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName)

matchProjectFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName: string): string | number;

Parse the project from ProjectLocationLakeZoneAssetAction resource.

Parameter
NameDescription
projectLocationLakeZoneAssetActionName string

A fully-qualified path representing project_location_lake_zone_asset_action resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromSessionName(sessionName)

matchProjectFromSessionName(sessionName: string): string | number;

Parse the project from Session resource.

Parameter
NameDescription
sessionName string

A fully-qualified path representing Session resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromTaskName(taskName)

matchProjectFromTaskName(taskName: string): string | number;

Parse the project from Task resource.

Parameter
NameDescription
taskName string

A fully-qualified path representing Task resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromZoneName(zoneName)

matchProjectFromZoneName(zoneName: string): string | number;

Parse the project from Zone resource.

Parameter
NameDescription
zoneName string

A fully-qualified path representing Zone resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchSessionFromSessionName(sessionName)

matchSessionFromSessionName(sessionName: string): string | number;

Parse the session from Session resource.

Parameter
NameDescription
sessionName string

A fully-qualified path representing Session resource.

Returns
TypeDescription
string | number

{string} A string representing the session.

matchTaskFromJobName(jobName)

matchTaskFromJobName(jobName: string): string | number;

Parse the task from Job resource.

Parameter
NameDescription
jobName string

A fully-qualified path representing Job resource.

Returns
TypeDescription
string | number

{string} A string representing the task.

matchTaskFromTaskName(taskName)

matchTaskFromTaskName(taskName: string): string | number;

Parse the task from Task resource.

Parameter
NameDescription
taskName string

A fully-qualified path representing Task resource.

Returns
TypeDescription
string | number

{string} A string representing the task.

matchZoneFromAssetName(assetName)

matchZoneFromAssetName(assetName: string): string | number;

Parse the zone from Asset resource.

Parameter
NameDescription
assetName string

A fully-qualified path representing Asset resource.

Returns
TypeDescription
string | number

{string} A string representing the zone.

matchZoneFromEntityName(entityName)

matchZoneFromEntityName(entityName: string): string | number;

Parse the zone from Entity resource.

Parameter
NameDescription
entityName string

A fully-qualified path representing Entity resource.

Returns
TypeDescription
string | number

{string} A string representing the zone.

matchZoneFromPartitionName(partitionName)

matchZoneFromPartitionName(partitionName: string): string | number;

Parse the zone from Partition resource.

Parameter
NameDescription
partitionName string

A fully-qualified path representing Partition resource.

Returns
TypeDescription
string | number

{string} A string representing the zone.

matchZoneFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName)

matchZoneFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName: string): string | number;

Parse the zone from ProjectLocationLakeZoneAction resource.

Parameter
NameDescription
projectLocationLakeZoneActionName string

A fully-qualified path representing project_location_lake_zone_action resource.

Returns
TypeDescription
string | number

{string} A string representing the zone.

matchZoneFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName)

matchZoneFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName: string): string | number;

Parse the zone from ProjectLocationLakeZoneAssetAction resource.

Parameter
NameDescription
projectLocationLakeZoneAssetActionName string

A fully-qualified path representing project_location_lake_zone_asset_action resource.

Returns
TypeDescription
string | number

{string} A string representing the zone.

matchZoneFromZoneName(zoneName)

matchZoneFromZoneName(zoneName: string): string | number;

Parse the zone from Zone resource.

Parameter
NameDescription
zoneName string

A fully-qualified path representing Zone resource.

Returns
TypeDescription
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
NameDescription
project string
location string
lake string
zone string
entity string
partition string
Returns
TypeDescription
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
NameDescription
project string
location string
lake string
action string
Returns
TypeDescription
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
NameDescription
project string
location string
lake string
zone string
action string
Returns
TypeDescription
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
NameDescription
project string
location string
lake string
zone string
asset string
action string
Returns
TypeDescription
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
NameDescription
project string
location string
lake string
environment string
session string
Returns
TypeDescription
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
NameDescription
project string
location string
lake string
task string
Returns
TypeDescription
string

{string} Resource name string.

updateEntity(request, options)

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

Update a metadata entity. Only supports full resource update.

Parameters
NameDescription
request IUpdateEntityRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.dataplex.v1.IEntity, protos.google.cloud.dataplex.v1.IUpdateEntityRequest | undefined, {} | undefined ]>

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

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Update description.
   */
  // const entity = {}
  /**
   *  Optional. Only validate the request, but do not perform mutations.
   *  The default is false.
   */
  // const validateOnly = true

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

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

  async function callUpdateEntity() {
    // Construct request
    const request = {
      entity,
    };

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

  callUpdateEntity();

updateEntity(request, options, callback)

updateEntity(request: protos.google.cloud.dataplex.v1.IUpdateEntityRequest, options: CallOptions, callback: Callback<protos.google.cloud.dataplex.v1.IEntity, protos.google.cloud.dataplex.v1.IUpdateEntityRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IUpdateEntityRequest
options CallOptions
callback Callback<protos.google.cloud.dataplex.v1.IEntity, protos.google.cloud.dataplex.v1.IUpdateEntityRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateEntity(request, callback)

updateEntity(request: protos.google.cloud.dataplex.v1.IUpdateEntityRequest, callback: Callback<protos.google.cloud.dataplex.v1.IEntity, protos.google.cloud.dataplex.v1.IUpdateEntityRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IUpdateEntityRequest
callback Callback<protos.google.cloud.dataplex.v1.IEntity, protos.google.cloud.dataplex.v1.IUpdateEntityRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
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
NameDescription
project string
location string
lake string
zone string
Returns
TypeDescription
string

{string} Resource name string.