Class v1.ContentServiceClient (3.5.1)

ContentService manages Notebook and SQL Scripts for Dataplex. v1

Package

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of ContentServiceClient.

Parameters
Name	Description
`opts`	`ClientOptions`
`gaxInstance`	`typeof gax \| typeof fallback` : loaded instance of `google-gax`. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new ContentServiceClient({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;

contentServiceStub

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

descriptors

descriptors: Descriptors;

innerApiCalls

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

locationsClient

locationsClient: LocationsClient;

operationsClient

operationsClient: gax.OperationsClient;

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

static get servicePath(): string;

The DNS address for this API service.

warn

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

Methods

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

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

Return a fully-qualified asset resource name string.

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

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

cancelOperation(request, options, callback)

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

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

Parameters
Name	Description
`request`	`CancelOperationRequest` The request object that will be sent.
`options`	`CallOptions \| Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} \| undefined \| null>` Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
`callback`	`Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} \| undefined \| null>` The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

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

Example


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

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
Type	Description
`Promise<void>`	{Promise} A promise that resolves when the client is closed.

contentPath(project, location, lake, content)

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

Return a fully-qualified content resource name string.

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

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

createContent(request, options)

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

Create a content.

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

Returns
Type	Description
`Promise<[ protos.google.cloud.dataplex.v1.IContent, protos.google.cloud.dataplex.v1.ICreateContentRequest \| 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 lake:
   *  projects/{project_id}/locations/{location_id}/lakes/{lake_id}
   */
  // const parent = 'abc123'
  /**
   *  Required. Content resource.
   */
  // const content = {}
  /**
   *  Optional. Only validate the request, but do not perform mutations.
   *  The default is false.
   */
  // const validateOnly = true

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

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

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

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

  callCreateContent();

createContent(request, options, callback)

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

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

Returns
Type	Description
`void`

createContent(request, callback)

createContent(request: protos.google.cloud.dataplex.v1.ICreateContentRequest, callback: Callback<protos.google.cloud.dataplex.v1.IContent, protos.google.cloud.dataplex.v1.ICreateContentRequest | null | undefined, {} | null | undefined>): void;

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

Returns
Type	Description
`void`

dataAttributeBindingPath(project, location, dataAttributeBindingId)

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

Return a fully-qualified dataAttributeBinding resource name string.

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

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

dataAttributePath(project, location, dataTaxonomy, dataAttributeId)

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

Return a fully-qualified dataAttribute resource name string.

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

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

dataScanJobPath(project, location, dataScan, job)

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

Return a fully-qualified dataScanJob resource name string.

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

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

dataScanPath(project, location, dataScan)

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

Return a fully-qualified dataScan resource name string.

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

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

dataTaxonomyPath(project, location, dataTaxonomyId)

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

Return a fully-qualified dataTaxonomy resource name string.

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

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

deleteContent(request, options)

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

Delete a content.

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

Returns
Type	Description
`Promise<[ protos.google.protobuf.IEmpty, protos.google.cloud.dataplex.v1.IDeleteContentRequest \| 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 content:
   *  projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteContent();

deleteContent(request, options, callback)

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

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

Returns
Type	Description
`void`

deleteContent(request, callback)

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

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

Returns
Type	Description
`void`

deleteOperation(request, options, callback)

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

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

Parameters
Name	Description
`request`	`DeleteOperationRequest` The request object that will be sent.
`options`	`CallOptions \| Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} \| null \| undefined>` Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
`callback`	`Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} \| null \| undefined>` The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

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

Example


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

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

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

Return a fully-qualified entity resource name string.

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

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

environmentPath(project, location, lake, environment)

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

Return a fully-qualified environment resource name string.

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

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

getContent(request, options)

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

Get a content resource.

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

Returns
Type	Description
`Promise<[ protos.google.cloud.dataplex.v1.IContent, protos.google.cloud.dataplex.v1.IGetContentRequest \| 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 content:
   *  projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}
   */
  // const name = 'abc123'
  /**
   *  Optional. Specify content view to make a partial request.
   */
  // const view = {}

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

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

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

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

  callGetContent();

getContent(request, options, callback)

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

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

Returns
Type	Description
`void`

getContent(request, callback)

getContent(request: protos.google.cloud.dataplex.v1.IGetContentRequest, callback: Callback<protos.google.cloud.dataplex.v1.IContent, protos.google.cloud.dataplex.v1.IGetContentRequest | null | undefined, {} | null | undefined>): void;

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

Returns
Type	Description
`void`

getIamPolicy(request, options)

getIamPolicy(request?: protos.google.iam.v1.IGetIamPolicyRequest, options?: CallOptions): Promise<[
        protos.google.iam.v1.IPolicy,
        protos.google.iam.v1.IGetIamPolicyRequest | undefined,
        {} | undefined
    ]>;

Gets the access control policy for a contentitem resource. A NOT_FOUND error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.

Caller must have Google IAM dataplex.content.getIamPolicy permission on the resource.

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

Returns
Type	Description
`Promise<[ protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing Policy. 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 for which the policy is being requested.
   *  See the operation documentation for the appropriate value for this field.
   */
  // const resource = 'abc123'
  /**
   *  OPTIONAL: A `GetPolicyOptions` object for specifying options to
   *  `GetIamPolicy`.
   */
  // const options = {}

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

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

  async function callGetIamPolicy() {
    // Construct request
    const request = {
      resource,
    };

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

  callGetIamPolicy();

getIamPolicy(request, options, callback)

getIamPolicy(request: protos.google.iam.v1.IGetIamPolicyRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetIamPolicyRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getIamPolicy(request, callback)

getIamPolicy(request: protos.google.iam.v1.IGetIamPolicyRequest, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetIamPolicyRequest`
`callback`	`Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getLocation(request, options, callback)

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

Gets information about a location.

Parameters
Name	Description
`request`	`LocationProtos.google.cloud.location.IGetLocationRequest` The request object that will be sent.
`options`	`CallOptions \| Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest \| null \| undefined, {} \| null \| undefined>` Call options. See CallOptions for more details.
`callback`	`Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`Promise<google.cloud.location.ILocation>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example


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

getOperation(request, options, callback)

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

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

Parameters
Name	Description
`request`	`GetOperationRequest` The request object that will be sent.
`options`	`CallOptions \| Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} \| null \| undefined>` Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
`callback`	`Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} \| null \| undefined>` The function which will be called with the result of the API call. The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

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

Example


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

getProjectId()

getProjectId(): Promise<string>;

Returns
Type	Description
`Promise<string>`

getProjectId(callback)

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

Parameter
Name	Description
`callback`	`Callback<string, undefined, undefined>`

Returns
Type	Description
`void`

initialize()

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

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns
Type	Description
`Promise<{ [name: string]: Function; }>`	{Promise} A promise that resolves to an authenticated service stub.

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

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

Return a fully-qualified job resource name string.

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

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

lakePath(project, location, lake)

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

Return a fully-qualified lake resource name string.

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

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

listContent(request, options)

listContent(request?: protos.google.cloud.dataplex.v1.IListContentRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dataplex.v1.IContent[],
        protos.google.cloud.dataplex.v1.IListContentRequest | null,
        protos.google.cloud.dataplex.v1.IListContentResponse
    ]>;

List content.

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

Returns

Type Description

Promise<[
        protos.google.cloud.dataplex.v1.IContent[],
        protos.google.cloud.dataplex.v1.IListContentRequest | null,
        protos.google.cloud.dataplex.v1.IListContentResponse
    ]>

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

listContent(request, options, callback)

listContent(request: protos.google.cloud.dataplex.v1.IListContentRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dataplex.v1.IListContentRequest, protos.google.cloud.dataplex.v1.IListContentResponse | null | undefined, protos.google.cloud.dataplex.v1.IContent>): void;

Parameters
Name	Description
`request`	`IListContentRequest`
`options`	`CallOptions`
`callback`	`PaginationCallback<protos.google.cloud.dataplex.v1.IListContentRequest, protos.google.cloud.dataplex.v1.IListContentResponse \| null \| undefined, protos.google.cloud.dataplex.v1.IContent>`

Returns
Type	Description
`void`

listContent(request, callback)

listContent(request: protos.google.cloud.dataplex.v1.IListContentRequest, callback: PaginationCallback<protos.google.cloud.dataplex.v1.IListContentRequest, protos.google.cloud.dataplex.v1.IListContentResponse | null | undefined, protos.google.cloud.dataplex.v1.IContent>): void;

Parameters
Name	Description
`request`	`IListContentRequest`
`callback`	`PaginationCallback<protos.google.cloud.dataplex.v1.IListContentRequest, protos.google.cloud.dataplex.v1.IListContentResponse \| null \| undefined, protos.google.cloud.dataplex.v1.IContent>`

Returns
Type	Description
`void`

listContentAsync(request, options)

listContentAsync(request?: protos.google.cloud.dataplex.v1.IListContentRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dataplex.v1.IContent>;

Equivalent to listContent, but returns an iterable object.

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

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

Returns
Type	Description
`AsyncIterable<protos.google.cloud.dataplex.v1.IContent>`	{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 lake:
   *  projects/{project_id}/locations/{location_id}/lakes/{lake_id}
   */
  // const parent = 'abc123'
  /**
   *  Optional. Maximum number of content to return. The service may return fewer
   *  than this value. If unspecified, at most 10 content will be returned. The
   *  maximum value is 1000; values above 1000 will be coerced to 1000.
   */
  // const pageSize = 1234
  /**
   *  Optional. Page token received from a previous `ListContent` call. Provide
   *  this to retrieve the subsequent page. When paginating, all other parameters
   *  provided to `ListContent` must match the call that provided the page
   *  token.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Filter request. Filters are case-sensitive.
   *  The following formats are supported:
   *  labels.key1 = "value1"
   *  labels:key1
   *  type = "NOTEBOOK"
   *  type = "SQL_SCRIPT"
   *  These restrictions can be coinjoined with AND, OR and NOT conjunctions.
   */
  // const filter = 'abc123'

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

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

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

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

  callListContent();

listContentStream(request, options)

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

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

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

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

listLocationsAsync(request, options)

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

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

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

Parameters
Name	Description
`request`	`LocationProtos.google.cloud.location.IListLocationsRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

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

Example


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

listOperationsAsync(request, options)

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

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

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

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

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

Example


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

matchActionFromProjectLocationLakeActionName(projectLocationLakeActionName)

matchActionFromProjectLocationLakeActionName(projectLocationLakeActionName: string): string | number;

Parse the action from ProjectLocationLakeAction resource.

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

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

matchActionFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName)

matchActionFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName: string): string | number;

Parse the action from ProjectLocationLakeZoneAction resource.

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

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

matchActionFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName)

matchActionFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName: string): string | number;

Parse the action from ProjectLocationLakeZoneAssetAction resource.

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

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

matchAssetFromAssetName(assetName)

matchAssetFromAssetName(assetName: string): string | number;

Parse the asset from Asset resource.

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

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

matchAssetFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName)

matchAssetFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName: string): string | number;

Parse the asset from ProjectLocationLakeZoneAssetAction resource.

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

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

matchContentFromContentName(contentName)

matchContentFromContentName(contentName: string): string | number;

Parse the content from Content resource.

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

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

matchDataAttributeBindingIdFromDataAttributeBindingName(dataAttributeBindingName)

matchDataAttributeBindingIdFromDataAttributeBindingName(dataAttributeBindingName: string): string | number;

Parse the data_attribute_binding_id from DataAttributeBinding resource.

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

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

matchDataAttributeIdFromDataAttributeName(dataAttributeName)

matchDataAttributeIdFromDataAttributeName(dataAttributeName: string): string | number;

Parse the data_attribute_id from DataAttribute resource.

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

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

matchDataScanFromDataScanJobName(dataScanJobName)

matchDataScanFromDataScanJobName(dataScanJobName: string): string | number;

Parse the dataScan from DataScanJob resource.

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

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

matchDataScanFromDataScanName(dataScanName)

matchDataScanFromDataScanName(dataScanName: string): string | number;

Parse the dataScan from DataScan resource.

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

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

matchDataTaxonomyFromDataAttributeName(dataAttributeName)

matchDataTaxonomyFromDataAttributeName(dataAttributeName: string): string | number;

Parse the dataTaxonomy from DataAttribute resource.

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

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

matchDataTaxonomyIdFromDataTaxonomyName(dataTaxonomyName)

matchDataTaxonomyIdFromDataTaxonomyName(dataTaxonomyName: string): string | number;

Parse the data_taxonomy_id from DataTaxonomy resource.

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

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

matchEntityFromEntityName(entityName)

matchEntityFromEntityName(entityName: string): string | number;

Parse the entity from Entity resource.

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

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

matchEntityFromPartitionName(partitionName)

matchEntityFromPartitionName(partitionName: string): string | number;

Parse the entity from Partition resource.

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

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

matchEnvironmentFromEnvironmentName(environmentName)

matchEnvironmentFromEnvironmentName(environmentName: string): string | number;

Parse the environment from Environment resource.

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

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

matchEnvironmentFromSessionName(sessionName)

matchEnvironmentFromSessionName(sessionName: string): string | number;

Parse the environment from Session resource.

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

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

matchJobFromDataScanJobName(dataScanJobName)

matchJobFromDataScanJobName(dataScanJobName: string): string | number;

Parse the job from DataScanJob resource.

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

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

matchJobFromJobName(jobName)

matchJobFromJobName(jobName: string): string | number;

Parse the job from Job resource.

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

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

matchLakeFromAssetName(assetName)

matchLakeFromAssetName(assetName: string): string | number;

Parse the lake from Asset resource.

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

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

matchLakeFromContentName(contentName)

matchLakeFromContentName(contentName: string): string | number;

Parse the lake from Content resource.

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

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

matchLakeFromEntityName(entityName)

matchLakeFromEntityName(entityName: string): string | number;

Parse the lake from Entity resource.

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

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

matchLakeFromEnvironmentName(environmentName)

matchLakeFromEnvironmentName(environmentName: string): string | number;

Parse the lake from Environment resource.

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

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

matchLakeFromJobName(jobName)

matchLakeFromJobName(jobName: string): string | number;

Parse the lake from Job resource.

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

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

matchLakeFromLakeName(lakeName)

matchLakeFromLakeName(lakeName: string): string | number;

Parse the lake from Lake resource.

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

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

matchLakeFromPartitionName(partitionName)

matchLakeFromPartitionName(partitionName: string): string | number;

Parse the lake from Partition resource.

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

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

matchLakeFromProjectLocationLakeActionName(projectLocationLakeActionName)

matchLakeFromProjectLocationLakeActionName(projectLocationLakeActionName: string): string | number;

Parse the lake from ProjectLocationLakeAction resource.

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

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

matchLakeFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName)

matchLakeFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName: string): string | number;

Parse the lake from ProjectLocationLakeZoneAction resource.

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

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

matchLakeFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName)

matchLakeFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName: string): string | number;

Parse the lake from ProjectLocationLakeZoneAssetAction resource.

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

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

matchLakeFromSessionName(sessionName)

matchLakeFromSessionName(sessionName: string): string | number;

Parse the lake from Session resource.

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

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

matchLakeFromTaskName(taskName)

matchLakeFromTaskName(taskName: string): string | number;

Parse the lake from Task resource.

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

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

matchLakeFromZoneName(zoneName)

matchLakeFromZoneName(zoneName: string): string | number;

Parse the lake from Zone resource.

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

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

matchLocationFromAssetName(assetName)

matchLocationFromAssetName(assetName: string): string | number;

Parse the location from Asset resource.

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

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

matchLocationFromContentName(contentName)

matchLocationFromContentName(contentName: string): string | number;

Parse the location from Content resource.

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

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

matchLocationFromDataAttributeBindingName(dataAttributeBindingName)

matchLocationFromDataAttributeBindingName(dataAttributeBindingName: string): string | number;

Parse the location from DataAttributeBinding resource.

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

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

matchLocationFromDataAttributeName(dataAttributeName)

matchLocationFromDataAttributeName(dataAttributeName: string): string | number;

Parse the location from DataAttribute resource.

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

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

matchLocationFromDataScanJobName(dataScanJobName)

matchLocationFromDataScanJobName(dataScanJobName: string): string | number;

Parse the location from DataScanJob resource.

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

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

matchLocationFromDataScanName(dataScanName)

matchLocationFromDataScanName(dataScanName: string): string | number;

Parse the location from DataScan resource.

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

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

matchLocationFromDataTaxonomyName(dataTaxonomyName)

matchLocationFromDataTaxonomyName(dataTaxonomyName: string): string | number;

Parse the location from DataTaxonomy resource.

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

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

matchLocationFromEntityName(entityName)

matchLocationFromEntityName(entityName: string): string | number;

Parse the location from Entity resource.

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

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

matchLocationFromEnvironmentName(environmentName)

matchLocationFromEnvironmentName(environmentName: string): string | number;

Parse the location from Environment resource.

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

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

matchLocationFromJobName(jobName)

matchLocationFromJobName(jobName: string): string | number;

Parse the location from Job resource.

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

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

matchLocationFromLakeName(lakeName)

matchLocationFromLakeName(lakeName: string): string | number;

Parse the location from Lake resource.

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

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

matchLocationFromPartitionName(partitionName)

matchLocationFromPartitionName(partitionName: string): string | number;

Parse the location from Partition resource.

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

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

matchLocationFromProjectLocationLakeActionName(projectLocationLakeActionName)

matchLocationFromProjectLocationLakeActionName(projectLocationLakeActionName: string): string | number;

Parse the location from ProjectLocationLakeAction resource.

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

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

matchLocationFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName)

matchLocationFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName: string): string | number;

Parse the location from ProjectLocationLakeZoneAction resource.

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

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

matchLocationFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName)

matchLocationFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName: string): string | number;

Parse the location from ProjectLocationLakeZoneAssetAction resource.

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

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

matchLocationFromSessionName(sessionName)

matchLocationFromSessionName(sessionName: string): string | number;

Parse the location from Session resource.

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

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

matchLocationFromTaskName(taskName)

matchLocationFromTaskName(taskName: string): string | number;

Parse the location from Task resource.

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

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

matchLocationFromZoneName(zoneName)

matchLocationFromZoneName(zoneName: string): string | number;

Parse the location from Zone resource.

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

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

matchPartitionFromPartitionName(partitionName)

matchPartitionFromPartitionName(partitionName: string): string | number;

Parse the partition from Partition resource.

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

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

matchProjectFromAssetName(assetName)

matchProjectFromAssetName(assetName: string): string | number;

Parse the project from Asset resource.

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

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

matchProjectFromContentName(contentName)

matchProjectFromContentName(contentName: string): string | number;

Parse the project from Content resource.

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

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

matchProjectFromDataAttributeBindingName(dataAttributeBindingName)

matchProjectFromDataAttributeBindingName(dataAttributeBindingName: string): string | number;

Parse the project from DataAttributeBinding resource.

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

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

matchProjectFromDataAttributeName(dataAttributeName)

matchProjectFromDataAttributeName(dataAttributeName: string): string | number;

Parse the project from DataAttribute resource.

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

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

matchProjectFromDataScanJobName(dataScanJobName)

matchProjectFromDataScanJobName(dataScanJobName: string): string | number;

Parse the project from DataScanJob resource.

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

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

matchProjectFromDataScanName(dataScanName)

matchProjectFromDataScanName(dataScanName: string): string | number;

Parse the project from DataScan resource.

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

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

matchProjectFromDataTaxonomyName(dataTaxonomyName)

matchProjectFromDataTaxonomyName(dataTaxonomyName: string): string | number;

Parse the project from DataTaxonomy resource.

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

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

matchProjectFromEntityName(entityName)

matchProjectFromEntityName(entityName: string): string | number;

Parse the project from Entity resource.

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

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

matchProjectFromEnvironmentName(environmentName)

matchProjectFromEnvironmentName(environmentName: string): string | number;

Parse the project from Environment resource.

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

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

matchProjectFromJobName(jobName)

matchProjectFromJobName(jobName: string): string | number;

Parse the project from Job resource.

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

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

matchProjectFromLakeName(lakeName)

matchProjectFromLakeName(lakeName: string): string | number;

Parse the project from Lake resource.

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

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

matchProjectFromPartitionName(partitionName)

matchProjectFromPartitionName(partitionName: string): string | number;

Parse the project from Partition resource.

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

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

matchProjectFromProjectLocationLakeActionName(projectLocationLakeActionName)

matchProjectFromProjectLocationLakeActionName(projectLocationLakeActionName: string): string | number;

Parse the project from ProjectLocationLakeAction resource.

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

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

matchProjectFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName)

matchProjectFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName: string): string | number;

Parse the project from ProjectLocationLakeZoneAction resource.

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

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

matchProjectFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName)

matchProjectFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName: string): string | number;

Parse the project from ProjectLocationLakeZoneAssetAction resource.

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

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

matchProjectFromSessionName(sessionName)

matchProjectFromSessionName(sessionName: string): string | number;

Parse the project from Session resource.

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

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

matchProjectFromTaskName(taskName)

matchProjectFromTaskName(taskName: string): string | number;

Parse the project from Task resource.

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

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

matchProjectFromZoneName(zoneName)

matchProjectFromZoneName(zoneName: string): string | number;

Parse the project from Zone resource.

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

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

matchSessionFromSessionName(sessionName)

matchSessionFromSessionName(sessionName: string): string | number;

Parse the session from Session resource.

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

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

matchTaskFromJobName(jobName)

matchTaskFromJobName(jobName: string): string | number;

Parse the task from Job resource.

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

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

matchTaskFromTaskName(taskName)

matchTaskFromTaskName(taskName: string): string | number;

Parse the task from Task resource.

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

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

matchZoneFromAssetName(assetName)

matchZoneFromAssetName(assetName: string): string | number;

Parse the zone from Asset resource.

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

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

matchZoneFromEntityName(entityName)

matchZoneFromEntityName(entityName: string): string | number;

Parse the zone from Entity resource.

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

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

matchZoneFromPartitionName(partitionName)

matchZoneFromPartitionName(partitionName: string): string | number;

Parse the zone from Partition resource.

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

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

matchZoneFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName)

matchZoneFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName: string): string | number;

Parse the zone from ProjectLocationLakeZoneAction resource.

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

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

matchZoneFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName)

matchZoneFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName: string): string | number;

Parse the zone from ProjectLocationLakeZoneAssetAction resource.

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

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

matchZoneFromZoneName(zoneName)

matchZoneFromZoneName(zoneName: string): string | number;

Parse the zone from Zone resource.

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

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

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

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

Return a fully-qualified partition resource name string.

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

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

projectLocationLakeActionPath(project, location, lake, action)

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

Return a fully-qualified projectLocationLakeAction resource name string.

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

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

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

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

Return a fully-qualified projectLocationLakeZoneAction resource name string.

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

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

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

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

Return a fully-qualified projectLocationLakeZoneAssetAction resource name string.

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

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

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

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

Return a fully-qualified session resource name string.

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

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

setIamPolicy(request, options)

setIamPolicy(request?: protos.google.iam.v1.ISetIamPolicyRequest, options?: CallOptions): Promise<[
        protos.google.iam.v1.IPolicy,
        protos.google.iam.v1.ISetIamPolicyRequest | undefined,
        {} | undefined
    ]>;

Sets the access control policy on the specified contentitem resource. Replaces any existing policy.

Caller must have Google IAM dataplex.content.setIamPolicy permission on the resource.

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

Returns
Type	Description
`Promise<[ protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing Policy. 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 for which the policy is being specified.
   *  See the operation documentation for the appropriate value for this field.
   */
  // const resource = 'abc123'
  /**
   *  REQUIRED: The complete policy to be applied to the `resource`. The size of
   *  the policy is limited to a few 10s of KB. An empty policy is a
   *  valid policy but certain Cloud Platform services (such as Projects)
   *  might reject them.
   */
  // const policy = {}
  /**
   *  OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
   *  the fields in the mask will be modified. If no mask is provided, the
   *  following default mask is used:
   *  `paths: "bindings, etag"`
   */
  // const updateMask = {}

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

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

  async function callSetIamPolicy() {
    // Construct request
    const request = {
      resource,
      policy,
    };

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

  callSetIamPolicy();

setIamPolicy(request, options, callback)

setIamPolicy(request: protos.google.iam.v1.ISetIamPolicyRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`ISetIamPolicyRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

setIamPolicy(request, callback)

setIamPolicy(request: protos.google.iam.v1.ISetIamPolicyRequest, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`ISetIamPolicyRequest`
`callback`	`Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

taskPath(project, location, lake, task)

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

Return a fully-qualified task resource name string.

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

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

testIamPermissions(request, options)

testIamPermissions(request?: protos.google.iam.v1.ITestIamPermissionsRequest, options?: CallOptions): Promise<[
        protos.google.iam.v1.ITestIamPermissionsResponse,
        protos.google.iam.v1.ITestIamPermissionsRequest | undefined,
        {} | undefined
    ]>;

Returns the caller's permissions on a resource. If the resource does not exist, an empty set of permissions is returned (a NOT_FOUND error is not returned).

A caller is not required to have Google IAM permission to make this request.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

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

Returns
Type	Description
`Promise<[ protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing TestIamPermissionsResponse. 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 for which the policy detail is being requested.
   *  See the operation documentation for the appropriate value for this field.
   */
  // const resource = 'abc123'
  /**
   *  The set of permissions to check for the `resource`. Permissions with
   *  wildcards (such as '*' or 'storage.*') are not allowed. For more
   *  information see
   *  IAM Overview (https://cloud.google.com/iam/docs/overview#permissions).
   */
  // const permissions = ['abc','def']

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

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

  async function callTestIamPermissions() {
    // Construct request
    const request = {
      resource,
      permissions,
    };

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

  callTestIamPermissions();

testIamPermissions(request, options, callback)

testIamPermissions(request: protos.google.iam.v1.ITestIamPermissionsRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`ITestIamPermissionsRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

testIamPermissions(request, callback)

testIamPermissions(request: protos.google.iam.v1.ITestIamPermissionsRequest, callback: Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`ITestIamPermissionsRequest`
`callback`	`Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

updateContent(request, options)

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

Update a content. Only supports full resource update.

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

Returns
Type	Description
`Promise<[ protos.google.cloud.dataplex.v1.IContent, protos.google.cloud.dataplex.v1.IUpdateContentRequest \| 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. Mask of fields to update.
   */
  // const updateMask = {}
  /**
   *  Required. Update description.
   *  Only fields specified in `update_mask` are updated.
   */
  // const content = {}
  /**
   *  Optional. Only validate the request, but do not perform mutations.
   *  The default is false.
   */
  // const validateOnly = true

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

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

  async function callUpdateContent() {
    // Construct request
    const request = {
      updateMask,
      content,
    };

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

  callUpdateContent();

updateContent(request, options, callback)

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

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

Returns
Type	Description
`void`

updateContent(request, callback)

updateContent(request: protos.google.cloud.dataplex.v1.IUpdateContentRequest, callback: Callback<protos.google.cloud.dataplex.v1.IContent, protos.google.cloud.dataplex.v1.IUpdateContentRequest | null | undefined, {} | null | undefined>): void;

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

Returns
Type	Description
`void`

zonePath(project, location, lake, zone)

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

Return a fully-qualified zone resource name string.

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

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