Class v1.MetadataServiceClient (3.7.0)

Package

Constructors

(constructor)(opts, gaxInstance)

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

Properties

apiEndpoint

get apiEndpoint(): string;

apiEndpoint

static get apiEndpoint(): string;

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;

scopes

static get scopes(): string[];

servicePath

static get servicePath(): string;

universeDomain

get universeDomain(): string;

warn

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

Methods

aspectTypePath(project, location, aspectType)

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

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

assetPath(project: string, location: string, lake: string, zone: string, asset: string): 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>;

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

close()

close(): Promise<void>;

contentPath(project, location, lake, content)

contentPath(project: string, location: string, lake: string, content: string): 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
    ]>;

  /**
   * 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;

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;

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
    ]>;

  /**
   * 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;

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;

dataAttributeBindingPath(project, location, dataAttributeBindingId)

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

dataAttributePath(project, location, dataTaxonomy, dataAttributeId)

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

dataScanJobPath(project, location, dataScan, job)

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

dataScanPath(project, location, dataScan)

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

dataTaxonomyPath(project, location, dataTaxonomyId)

dataTaxonomyPath(project: string, location: string, dataTaxonomyId: string): 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
    ]>;

  /**
   * 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;

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;

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

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
    ]>;

  /**
   * 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;

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;

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

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

entryGroupPath(project, location, entryGroup)

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

entryPath(project, location, entryGroup, entry)

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

entryTypePath(project, location, entryType)

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

environmentPath(project, location, lake, environment)

environmentPath(project: string, location: string, lake: string, environment: string): 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
    ]>;

  /**
   * 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;

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;

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

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]>;

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
    ]>;

  /**
   * 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;

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;

getProjectId()

getProjectId(): Promise<string>;

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

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

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

lakePath(project, location, lake)

lakePath(project: string, location: string, lake: string): 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
    ]>;

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;

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;

listEntitiesAsync(request, options)

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

  /**
   * 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 = 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;

listLocationsAsync(request, options)

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

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

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
    ]>;

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;

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;

listPartitionsAsync(request, options)

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

  /**
   * 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="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;

matchActionFromProjectLocationLakeActionName(projectLocationLakeActionName)

matchActionFromProjectLocationLakeActionName(projectLocationLakeActionName: string): string | number;

matchActionFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName)

matchActionFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName: string): string | number;

matchActionFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName)

matchActionFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName: string): string | number;

matchAspectTypeFromAspectTypeName(aspectTypeName)

matchAspectTypeFromAspectTypeName(aspectTypeName: string): string | number;

matchAssetFromAssetName(assetName)

matchAssetFromAssetName(assetName: string): string | number;

matchAssetFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName)

matchAssetFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName: string): string | number;

matchContentFromContentName(contentName)

matchContentFromContentName(contentName: string): string | number;

matchDataAttributeBindingIdFromDataAttributeBindingName(dataAttributeBindingName)

matchDataAttributeBindingIdFromDataAttributeBindingName(dataAttributeBindingName: string): string | number;

matchDataAttributeIdFromDataAttributeName(dataAttributeName)

matchDataAttributeIdFromDataAttributeName(dataAttributeName: string): string | number;

matchDataScanFromDataScanJobName(dataScanJobName)

matchDataScanFromDataScanJobName(dataScanJobName: string): string | number;

matchDataScanFromDataScanName(dataScanName)

matchDataScanFromDataScanName(dataScanName: string): string | number;

matchDataTaxonomyFromDataAttributeName(dataAttributeName)

matchDataTaxonomyFromDataAttributeName(dataAttributeName: string): string | number;

matchDataTaxonomyIdFromDataTaxonomyName(dataTaxonomyName)

matchDataTaxonomyIdFromDataTaxonomyName(dataTaxonomyName: string): string | number;

matchEntityFromEntityName(entityName)

matchEntityFromEntityName(entityName: string): string | number;

matchEntityFromPartitionName(partitionName)

matchEntityFromPartitionName(partitionName: string): string | number;

matchEntryFromEntryName(entryName)

matchEntryFromEntryName(entryName: string): string | number;

matchEntryGroupFromEntryGroupName(entryGroupName)

matchEntryGroupFromEntryGroupName(entryGroupName: string): string | number;

matchEntryGroupFromEntryName(entryName)

matchEntryGroupFromEntryName(entryName: string): string | number;

matchEntryTypeFromEntryTypeName(entryTypeName)

matchEntryTypeFromEntryTypeName(entryTypeName: string): string | number;

matchEnvironmentFromEnvironmentName(environmentName)

matchEnvironmentFromEnvironmentName(environmentName: string): string | number;

matchEnvironmentFromSessionName(sessionName)

matchEnvironmentFromSessionName(sessionName: string): string | number;

matchJobFromDataScanJobName(dataScanJobName)

matchJobFromDataScanJobName(dataScanJobName: string): string | number;

matchJobFromJobName(jobName)

matchJobFromJobName(jobName: string): string | number;

matchLakeFromAssetName(assetName)

matchLakeFromAssetName(assetName: string): string | number;

matchLakeFromContentName(contentName)

matchLakeFromContentName(contentName: string): string | number;

matchLakeFromEntityName(entityName)

matchLakeFromEntityName(entityName: string): string | number;

matchLakeFromEnvironmentName(environmentName)

matchLakeFromEnvironmentName(environmentName: string): string | number;

matchLakeFromJobName(jobName)

matchLakeFromJobName(jobName: string): string | number;

matchLakeFromLakeName(lakeName)

matchLakeFromLakeName(lakeName: string): string | number;

matchLakeFromPartitionName(partitionName)

matchLakeFromPartitionName(partitionName: string): string | number;

matchLakeFromProjectLocationLakeActionName(projectLocationLakeActionName)

matchLakeFromProjectLocationLakeActionName(projectLocationLakeActionName: string): string | number;

matchLakeFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName)

matchLakeFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName: string): string | number;

matchLakeFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName)

matchLakeFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName: string): string | number;

matchLakeFromSessionName(sessionName)

matchLakeFromSessionName(sessionName: string): string | number;

matchLakeFromTaskName(taskName)

matchLakeFromTaskName(taskName: string): string | number;

matchLakeFromZoneName(zoneName)

matchLakeFromZoneName(zoneName: string): string | number;

matchLocationFromAspectTypeName(aspectTypeName)

matchLocationFromAspectTypeName(aspectTypeName: string): string | number;

matchLocationFromAssetName(assetName)

matchLocationFromAssetName(assetName: string): string | number;

matchLocationFromContentName(contentName)

matchLocationFromContentName(contentName: string): string | number;

matchLocationFromDataAttributeBindingName(dataAttributeBindingName)

matchLocationFromDataAttributeBindingName(dataAttributeBindingName: string): string | number;

matchLocationFromDataAttributeName(dataAttributeName)

matchLocationFromDataAttributeName(dataAttributeName: string): string | number;

matchLocationFromDataScanJobName(dataScanJobName)

matchLocationFromDataScanJobName(dataScanJobName: string): string | number;

matchLocationFromDataScanName(dataScanName)

matchLocationFromDataScanName(dataScanName: string): string | number;

matchLocationFromDataTaxonomyName(dataTaxonomyName)

matchLocationFromDataTaxonomyName(dataTaxonomyName: string): string | number;

matchLocationFromEntityName(entityName)

matchLocationFromEntityName(entityName: string): string | number;

matchLocationFromEntryGroupName(entryGroupName)

matchLocationFromEntryGroupName(entryGroupName: string): string | number;

matchLocationFromEntryName(entryName)

matchLocationFromEntryName(entryName: string): string | number;

matchLocationFromEntryTypeName(entryTypeName)

matchLocationFromEntryTypeName(entryTypeName: string): string | number;

matchLocationFromEnvironmentName(environmentName)

matchLocationFromEnvironmentName(environmentName: string): string | number;

matchLocationFromJobName(jobName)

matchLocationFromJobName(jobName: string): string | number;

matchLocationFromLakeName(lakeName)

matchLocationFromLakeName(lakeName: string): string | number;

matchLocationFromPartitionName(partitionName)

matchLocationFromPartitionName(partitionName: string): string | number;

matchLocationFromProjectLocationLakeActionName(projectLocationLakeActionName)

matchLocationFromProjectLocationLakeActionName(projectLocationLakeActionName: string): string | number;

matchLocationFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName)

matchLocationFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName: string): string | number;

matchLocationFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName)

matchLocationFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName: string): string | number;

matchLocationFromSessionName(sessionName)

matchLocationFromSessionName(sessionName: string): string | number;

matchLocationFromTaskName(taskName)

matchLocationFromTaskName(taskName: string): string | number;

matchLocationFromZoneName(zoneName)

matchLocationFromZoneName(zoneName: string): string | number;

matchPartitionFromPartitionName(partitionName)

matchPartitionFromPartitionName(partitionName: string): string | number;

matchProjectFromAspectTypeName(aspectTypeName)

matchProjectFromAspectTypeName(aspectTypeName: string): string | number;

matchProjectFromAssetName(assetName)

matchProjectFromAssetName(assetName: string): string | number;

matchProjectFromContentName(contentName)

matchProjectFromContentName(contentName: string): string | number;

matchProjectFromDataAttributeBindingName(dataAttributeBindingName)

matchProjectFromDataAttributeBindingName(dataAttributeBindingName: string): string | number;

matchProjectFromDataAttributeName(dataAttributeName)

matchProjectFromDataAttributeName(dataAttributeName: string): string | number;

matchProjectFromDataScanJobName(dataScanJobName)

matchProjectFromDataScanJobName(dataScanJobName: string): string | number;

matchProjectFromDataScanName(dataScanName)

matchProjectFromDataScanName(dataScanName: string): string | number;

matchProjectFromDataTaxonomyName(dataTaxonomyName)

matchProjectFromDataTaxonomyName(dataTaxonomyName: string): string | number;

matchProjectFromEntityName(entityName)

matchProjectFromEntityName(entityName: string): string | number;

matchProjectFromEntryGroupName(entryGroupName)

matchProjectFromEntryGroupName(entryGroupName: string): string | number;

matchProjectFromEntryName(entryName)

matchProjectFromEntryName(entryName: string): string | number;

matchProjectFromEntryTypeName(entryTypeName)

matchProjectFromEntryTypeName(entryTypeName: string): string | number;

matchProjectFromEnvironmentName(environmentName)

matchProjectFromEnvironmentName(environmentName: string): string | number;

matchProjectFromJobName(jobName)

matchProjectFromJobName(jobName: string): string | number;

matchProjectFromLakeName(lakeName)

matchProjectFromLakeName(lakeName: string): string | number;

matchProjectFromPartitionName(partitionName)

matchProjectFromPartitionName(partitionName: string): string | number;

matchProjectFromProjectLocationLakeActionName(projectLocationLakeActionName)

matchProjectFromProjectLocationLakeActionName(projectLocationLakeActionName: string): string | number;

matchProjectFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName)

matchProjectFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName: string): string | number;

matchProjectFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName)

matchProjectFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName: string): string | number;

matchProjectFromSessionName(sessionName)

matchProjectFromSessionName(sessionName: string): string | number;

matchProjectFromTaskName(taskName)

matchProjectFromTaskName(taskName: string): string | number;

matchProjectFromZoneName(zoneName)

matchProjectFromZoneName(zoneName: string): string | number;

matchSessionFromSessionName(sessionName)

matchSessionFromSessionName(sessionName: string): string | number;

matchTaskFromJobName(jobName)

matchTaskFromJobName(jobName: string): string | number;

matchTaskFromTaskName(taskName)

matchTaskFromTaskName(taskName: string): string | number;

matchZoneFromAssetName(assetName)

matchZoneFromAssetName(assetName: string): string | number;

matchZoneFromEntityName(entityName)

matchZoneFromEntityName(entityName: string): string | number;

matchZoneFromPartitionName(partitionName)

matchZoneFromPartitionName(partitionName: string): string | number;

matchZoneFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName)

matchZoneFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName: string): string | number;

matchZoneFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName)

matchZoneFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName: string): string | number;

matchZoneFromZoneName(zoneName)

matchZoneFromZoneName(zoneName: string): string | number;

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

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

projectLocationLakeActionPath(project, location, lake, action)

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

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

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

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

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

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

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

taskPath(project, location, lake, task)

taskPath(project: string, location: string, lake: string, task: string): 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
    ]>;

  /**
   * 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;

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;

zonePath(project, location, lake, zone)

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