Class v2.DlpServiceClient (5.11.0)

The Cloud Data Loss Prevention (DLP) API is a service that allows clients to detect the presence of Personally Identifiable Information (PII) and other privacy-sensitive data in user-supplied, unstructured data streams, like text blocks or images. The service also includes methods for sensitive data redaction and scheduling of data scans on Google Cloud Platform based data sets.

To learn more about concepts and find how-to guides see https://cloud.google.com/sensitive-data-protection/docs/. v2

Package

@google-cloud/dlp

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of DlpServiceClient.

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 DlpServiceClient({fallback: true}, gax); ```

Properties

apiEndpoint

get apiEndpoint(): string;

The DNS address for this API service.

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath.

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

dlpServiceStub

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

innerApiCalls

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

locationsClient

locationsClient: LocationsClient;

pathTemplates

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

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

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

servicePath

static get servicePath(): string;

The DNS address for this API service.

universeDomain

get universeDomain(): string;

warn

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

Methods

activateJobTrigger(request, options)

activateJobTrigger(request?: protos.google.privacy.dlp.v2.IActivateJobTriggerRequest, options?: CallOptions): Promise<[
        protos.google.privacy.dlp.v2.IDlpJob,
        protos.google.privacy.dlp.v2.IActivateJobTriggerRequest | undefined,
        {} | undefined
    ]>;

Activate a job trigger. Causes the immediate execute of a trigger instead of waiting on the trigger event to occur.

Parameters
Name Description
request IActivateJobTriggerRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.privacy.dlp.v2.IDlpJob, protos.google.privacy.dlp.v2.IActivateJobTriggerRequest | 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. Resource name of the trigger to activate, for example
   *  `projects/dlp-test-project/jobTriggers/53234423`.
   */
  // const name = 'abc123'

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

    // Run request
    const response = await dlpClient.activateJobTrigger(request);
    console.log(response);
  }

  callActivateJobTrigger();

activateJobTrigger(request, options, callback)

activateJobTrigger(request: protos.google.privacy.dlp.v2.IActivateJobTriggerRequest, options: CallOptions, callback: Callback<protos.google.privacy.dlp.v2.IDlpJob, protos.google.privacy.dlp.v2.IActivateJobTriggerRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IActivateJobTriggerRequest
options CallOptions
callback Callback<protos.google.privacy.dlp.v2.IDlpJob, protos.google.privacy.dlp.v2.IActivateJobTriggerRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

activateJobTrigger(request, callback)

activateJobTrigger(request: protos.google.privacy.dlp.v2.IActivateJobTriggerRequest, callback: Callback<protos.google.privacy.dlp.v2.IDlpJob, protos.google.privacy.dlp.v2.IActivateJobTriggerRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IActivateJobTriggerRequest
callback Callback<protos.google.privacy.dlp.v2.IDlpJob, protos.google.privacy.dlp.v2.IActivateJobTriggerRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

cancelDlpJob(request, options)

cancelDlpJob(request?: protos.google.privacy.dlp.v2.ICancelDlpJobRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.privacy.dlp.v2.ICancelDlpJobRequest | undefined,
        {} | undefined
    ]>;

Starts asynchronous cancellation on a long-running DlpJob. The server makes a best effort to cancel the DlpJob, but success is not guaranteed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.

Parameters
Name Description
request ICancelDlpJobRequest

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.privacy.dlp.v2.ICancelDlpJobRequest | 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 name of the DlpJob resource to be cancelled.
   */
  // const name = 'abc123'

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

    // Run request
    const response = await dlpClient.cancelDlpJob(request);
    console.log(response);
  }

  callCancelDlpJob();

cancelDlpJob(request, options, callback)

cancelDlpJob(request: protos.google.privacy.dlp.v2.ICancelDlpJobRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.privacy.dlp.v2.ICancelDlpJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICancelDlpJobRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.privacy.dlp.v2.ICancelDlpJobRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

cancelDlpJob(request, callback)

cancelDlpJob(request: protos.google.privacy.dlp.v2.ICancelDlpJobRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.privacy.dlp.v2.ICancelDlpJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICancelDlpJobRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.privacy.dlp.v2.ICancelDlpJobRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

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.

createConnection(request, options)

createConnection(request?: protos.google.privacy.dlp.v2.ICreateConnectionRequest, options?: CallOptions): Promise<[
        protos.google.privacy.dlp.v2.IConnection,
        protos.google.privacy.dlp.v2.ICreateConnectionRequest | undefined,
        {} | undefined
    ]>;

Create a Connection to an external data source.

Parameters
Name Description
request ICreateConnectionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.privacy.dlp.v2.IConnection, protos.google.privacy.dlp.v2.ICreateConnectionRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Connection. 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. Parent resource name.
   *  The format of this value varies depending on the scope of the request
   *  (project or organization):
   *  + Projects scope:
   *    `projects/{project_id}/locations/{location_id}`
   *  + Organizations scope:
   *    `organizations/{org_id}/locations/{location_id}`
   */
  // const parent = 'abc123'
  /**
   *  Required. The connection resource.
   */
  // const connection = {}

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

    // Run request
    const response = await dlpClient.createConnection(request);
    console.log(response);
  }

  callCreateConnection();

createConnection(request, options, callback)

createConnection(request: protos.google.privacy.dlp.v2.ICreateConnectionRequest, options: CallOptions, callback: Callback<protos.google.privacy.dlp.v2.IConnection, protos.google.privacy.dlp.v2.ICreateConnectionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateConnectionRequest
options CallOptions
callback Callback<protos.google.privacy.dlp.v2.IConnection, protos.google.privacy.dlp.v2.ICreateConnectionRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createConnection(request, callback)

createConnection(request: protos.google.privacy.dlp.v2.ICreateConnectionRequest, callback: Callback<protos.google.privacy.dlp.v2.IConnection, protos.google.privacy.dlp.v2.ICreateConnectionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateConnectionRequest
callback Callback<protos.google.privacy.dlp.v2.IConnection, protos.google.privacy.dlp.v2.ICreateConnectionRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createDeidentifyTemplate(request, options)

createDeidentifyTemplate(request?: protos.google.privacy.dlp.v2.ICreateDeidentifyTemplateRequest, options?: CallOptions): Promise<[
        protos.google.privacy.dlp.v2.IDeidentifyTemplate,
        protos.google.privacy.dlp.v2.ICreateDeidentifyTemplateRequest | undefined,
        {} | undefined
    ]>;

Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

Parameters
Name Description
request ICreateDeidentifyTemplateRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.privacy.dlp.v2.IDeidentifyTemplate, protos.google.privacy.dlp.v2.ICreateDeidentifyTemplateRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing DeidentifyTemplate. 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. Parent resource name.
   *  The format of this value varies depending on the scope of the request
   *  (project or organization) and whether you have specified a processing
   *  location (https://cloud.google.com/sensitive-data-protection/docs/specifying-location):
   *  + Projects scope, location specified:
   *    `projects/{project_id}/locations/{location_id}`
   *  + Projects scope, no location specified (defaults to global):
   *    `projects/{project_id}`
   *  + Organizations scope, location specified:
   *    `organizations/{org_id}/locations/{location_id}`
   *  + Organizations scope, no location specified (defaults to global):
   *    `organizations/{org_id}`
   *  The following example `parent` string specifies a parent project with the
   *  identifier `example-project`, and specifies the `europe-west3` location
   *  for processing data:
   *      parent=projects/example-project/locations/europe-west3
   */
  // const parent = 'abc123'
  /**
   *  Required. The DeidentifyTemplate to create.
   */
  // const deidentifyTemplate = {}
  /**
   *  The template id can contain uppercase and lowercase letters,
   *  numbers, and hyphens; that is, it must match the regular
   *  expression: `[a-zA-Z\d-_]+`. The maximum length is 100
   *  characters. Can be empty to allow the system to generate one.
   */
  // const templateId = 'abc123'

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

    // Run request
    const response = await dlpClient.createDeidentifyTemplate(request);
    console.log(response);
  }

  callCreateDeidentifyTemplate();

createDeidentifyTemplate(request, options, callback)

createDeidentifyTemplate(request: protos.google.privacy.dlp.v2.ICreateDeidentifyTemplateRequest, options: CallOptions, callback: Callback<protos.google.privacy.dlp.v2.IDeidentifyTemplate, protos.google.privacy.dlp.v2.ICreateDeidentifyTemplateRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateDeidentifyTemplateRequest
options CallOptions
callback Callback<protos.google.privacy.dlp.v2.IDeidentifyTemplate, protos.google.privacy.dlp.v2.ICreateDeidentifyTemplateRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createDeidentifyTemplate(request, callback)

createDeidentifyTemplate(request: protos.google.privacy.dlp.v2.ICreateDeidentifyTemplateRequest, callback: Callback<protos.google.privacy.dlp.v2.IDeidentifyTemplate, protos.google.privacy.dlp.v2.ICreateDeidentifyTemplateRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateDeidentifyTemplateRequest
callback Callback<protos.google.privacy.dlp.v2.IDeidentifyTemplate, protos.google.privacy.dlp.v2.ICreateDeidentifyTemplateRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createDiscoveryConfig(request, options)

createDiscoveryConfig(request?: protos.google.privacy.dlp.v2.ICreateDiscoveryConfigRequest, options?: CallOptions): Promise<[
        protos.google.privacy.dlp.v2.IDiscoveryConfig,
        protos.google.privacy.dlp.v2.ICreateDiscoveryConfigRequest | undefined,
        {} | undefined
    ]>;

Creates a config for discovery to scan and profile storage.

Parameters
Name Description
request ICreateDiscoveryConfigRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.privacy.dlp.v2.IDiscoveryConfig, protos.google.privacy.dlp.v2.ICreateDiscoveryConfigRequest | 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. Parent resource name.
   *  The format of this value varies depending on the scope of the request
   *  (project or organization):
   *  + Projects scope:
   *    `projects/{project_id}/locations/{location_id}`
   *  + Organizations scope:
   *    `organizations/{org_id}/locations/{location_id}`
   *  The following example `parent` string specifies a parent project with the
   *  identifier `example-project`, and specifies the `europe-west3` location
   *  for processing data:
   *      parent=projects/example-project/locations/europe-west3
   */
  // const parent = 'abc123'
  /**
   *  Required. The DiscoveryConfig to create.
   */
  // const discoveryConfig = {}
  /**
   *  The config ID can contain uppercase and lowercase letters,
   *  numbers, and hyphens; that is, it must match the regular
   *  expression: `[a-zA-Z\d-_]+`. The maximum length is 100
   *  characters. Can be empty to allow the system to generate one.
   */
  // const configId = 'abc123'

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

    // Run request
    const response = await dlpClient.createDiscoveryConfig(request);
    console.log(response);
  }

  callCreateDiscoveryConfig();

createDiscoveryConfig(request, options, callback)

createDiscoveryConfig(request: protos.google.privacy.dlp.v2.ICreateDiscoveryConfigRequest, options: CallOptions, callback: Callback<protos.google.privacy.dlp.v2.IDiscoveryConfig, protos.google.privacy.dlp.v2.ICreateDiscoveryConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateDiscoveryConfigRequest
options CallOptions
callback Callback<protos.google.privacy.dlp.v2.IDiscoveryConfig, protos.google.privacy.dlp.v2.ICreateDiscoveryConfigRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createDiscoveryConfig(request, callback)

createDiscoveryConfig(request: protos.google.privacy.dlp.v2.ICreateDiscoveryConfigRequest, callback: Callback<protos.google.privacy.dlp.v2.IDiscoveryConfig, protos.google.privacy.dlp.v2.ICreateDiscoveryConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateDiscoveryConfigRequest
callback Callback<protos.google.privacy.dlp.v2.IDiscoveryConfig, protos.google.privacy.dlp.v2.ICreateDiscoveryConfigRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createDlpJob(request, options)

createDlpJob(request?: protos.google.privacy.dlp.v2.ICreateDlpJobRequest, options?: CallOptions): Promise<[
        protos.google.privacy.dlp.v2.IDlpJob,
        protos.google.privacy.dlp.v2.ICreateDlpJobRequest | undefined,
        {} | undefined
    ]>;

Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.

When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.

Parameters
Name Description
request ICreateDlpJobRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.privacy.dlp.v2.IDlpJob, protos.google.privacy.dlp.v2.ICreateDlpJobRequest | 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. Parent resource name.
   *  The format of this value varies depending on whether you have specified a
   *  processing
   *  location (https://cloud.google.com/sensitive-data-protection/docs/specifying-location):
   *  + Projects scope, location specified:
   *    `projects/{project_id}/locations/{location_id}`
   *  + Projects scope, no location specified (defaults to global):
   *    `projects/{project_id}`
   *  The following example `parent` string specifies a parent project with the
   *  identifier `example-project`, and specifies the `europe-west3` location
   *  for processing data:
   *      parent=projects/example-project/locations/europe-west3
   */
  // const parent = 'abc123'
  /**
   *  An inspection job scans a storage repository for InfoTypes.
   */
  // const inspectJob = {}
  /**
   *  A risk analysis job calculates re-identification risk metrics for a
   *  BigQuery table.
   */
  // const riskJob = {}
  /**
   *  The job id can contain uppercase and lowercase letters,
   *  numbers, and hyphens; that is, it must match the regular
   *  expression: `[a-zA-Z\d-_]+`. The maximum length is 100
   *  characters. Can be empty to allow the system to generate one.
   */
  // const jobId = 'abc123'

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

    // Run request
    const response = await dlpClient.createDlpJob(request);
    console.log(response);
  }

  callCreateDlpJob();

createDlpJob(request, options, callback)

createDlpJob(request: protos.google.privacy.dlp.v2.ICreateDlpJobRequest, options: CallOptions, callback: Callback<protos.google.privacy.dlp.v2.IDlpJob, protos.google.privacy.dlp.v2.ICreateDlpJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateDlpJobRequest
options CallOptions
callback Callback<protos.google.privacy.dlp.v2.IDlpJob, protos.google.privacy.dlp.v2.ICreateDlpJobRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createDlpJob(request, callback)

createDlpJob(request: protos.google.privacy.dlp.v2.ICreateDlpJobRequest, callback: Callback<protos.google.privacy.dlp.v2.IDlpJob, protos.google.privacy.dlp.v2.ICreateDlpJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateDlpJobRequest
callback Callback<protos.google.privacy.dlp.v2.IDlpJob, protos.google.privacy.dlp.v2.ICreateDlpJobRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createInspectTemplate(request, options)

createInspectTemplate(request?: protos.google.privacy.dlp.v2.ICreateInspectTemplateRequest, options?: CallOptions): Promise<[
        protos.google.privacy.dlp.v2.IInspectTemplate,
        protos.google.privacy.dlp.v2.ICreateInspectTemplateRequest | undefined,
        {} | undefined
    ]>;

Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

Parameters
Name Description
request ICreateInspectTemplateRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.privacy.dlp.v2.IInspectTemplate, protos.google.privacy.dlp.v2.ICreateInspectTemplateRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing InspectTemplate. 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. Parent resource name.
   *  The format of this value varies depending on the scope of the request
   *  (project or organization) and whether you have specified a processing
   *  location (https://cloud.google.com/sensitive-data-protection/docs/specifying-location):
   *  + Projects scope, location specified:
   *    `projects/{project_id}/locations/{location_id}`
   *  + Projects scope, no location specified (defaults to global):
   *    `projects/{project_id}`
   *  + Organizations scope, location specified:
   *    `organizations/{org_id}/locations/{location_id}`
   *  + Organizations scope, no location specified (defaults to global):
   *    `organizations/{org_id}`
   *  The following example `parent` string specifies a parent project with the
   *  identifier `example-project`, and specifies the `europe-west3` location
   *  for processing data:
   *      parent=projects/example-project/locations/europe-west3
   */
  // const parent = 'abc123'
  /**
   *  Required. The InspectTemplate to create.
   */
  // const inspectTemplate = {}
  /**
   *  The template id can contain uppercase and lowercase letters,
   *  numbers, and hyphens; that is, it must match the regular
   *  expression: `[a-zA-Z\d-_]+`. The maximum length is 100
   *  characters. Can be empty to allow the system to generate one.
   */
  // const templateId = 'abc123'

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

    // Run request
    const response = await dlpClient.createInspectTemplate(request);
    console.log(response);
  }

  callCreateInspectTemplate();

createInspectTemplate(request, options, callback)

createInspectTemplate(request: protos.google.privacy.dlp.v2.ICreateInspectTemplateRequest, options: CallOptions, callback: Callback<protos.google.privacy.dlp.v2.IInspectTemplate, protos.google.privacy.dlp.v2.ICreateInspectTemplateRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateInspectTemplateRequest
options CallOptions
callback Callback<protos.google.privacy.dlp.v2.IInspectTemplate, protos.google.privacy.dlp.v2.ICreateInspectTemplateRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createInspectTemplate(request, callback)

createInspectTemplate(request: protos.google.privacy.dlp.v2.ICreateInspectTemplateRequest, callback: Callback<protos.google.privacy.dlp.v2.IInspectTemplate, protos.google.privacy.dlp.v2.ICreateInspectTemplateRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateInspectTemplateRequest
callback Callback<protos.google.privacy.dlp.v2.IInspectTemplate, protos.google.privacy.dlp.v2.ICreateInspectTemplateRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createJobTrigger(request, options)

createJobTrigger(request?: protos.google.privacy.dlp.v2.ICreateJobTriggerRequest, options?: CallOptions): Promise<[
        protos.google.privacy.dlp.v2.IJobTrigger,
        protos.google.privacy.dlp.v2.ICreateJobTriggerRequest | undefined,
        {} | undefined
    ]>;

Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

Parameters
Name Description
request ICreateJobTriggerRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.privacy.dlp.v2.IJobTrigger, protos.google.privacy.dlp.v2.ICreateJobTriggerRequest | 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. Parent resource name.
   *  The format of this value varies depending on whether you have specified a
   *  processing
   *  location (https://cloud.google.com/sensitive-data-protection/docs/specifying-location):
   *  + Projects scope, location specified:
   *    `projects/{project_id}/locations/{location_id}`
   *  + Projects scope, no location specified (defaults to global):
   *    `projects/{project_id}`
   *  The following example `parent` string specifies a parent project with the
   *  identifier `example-project`, and specifies the `europe-west3` location
   *  for processing data:
   *      parent=projects/example-project/locations/europe-west3
   */
  // const parent = 'abc123'
  /**
   *  Required. The JobTrigger to create.
   */
  // const jobTrigger = {}
  /**
   *  The trigger id can contain uppercase and lowercase letters,
   *  numbers, and hyphens; that is, it must match the regular
   *  expression: `[a-zA-Z\d-_]+`. The maximum length is 100
   *  characters. Can be empty to allow the system to generate one.
   */
  // const triggerId = 'abc123'

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

    // Run request
    const response = await dlpClient.createJobTrigger(request);
    console.log(response);
  }

  callCreateJobTrigger();

createJobTrigger(request, options, callback)

createJobTrigger(request: protos.google.privacy.dlp.v2.ICreateJobTriggerRequest, options: CallOptions, callback: Callback<protos.google.privacy.dlp.v2.IJobTrigger, protos.google.privacy.dlp.v2.ICreateJobTriggerRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateJobTriggerRequest
options CallOptions
callback Callback<protos.google.privacy.dlp.v2.IJobTrigger, protos.google.privacy.dlp.v2.ICreateJobTriggerRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createJobTrigger(request, callback)

createJobTrigger(request: protos.google.privacy.dlp.v2.ICreateJobTriggerRequest, callback: Callback<protos.google.privacy.dlp.v2.IJobTrigger, protos.google.privacy.dlp.v2.ICreateJobTriggerRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateJobTriggerRequest
callback Callback<protos.google.privacy.dlp.v2.IJobTrigger, protos.google.privacy.dlp.v2.ICreateJobTriggerRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createStoredInfoType(request, options)

createStoredInfoType(request?: protos.google.privacy.dlp.v2.ICreateStoredInfoTypeRequest, options?: CallOptions): Promise<[
        protos.google.privacy.dlp.v2.IStoredInfoType,
        protos.google.privacy.dlp.v2.ICreateStoredInfoTypeRequest | undefined,
        {} | undefined
    ]>;

Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

Parameters
Name Description
request ICreateStoredInfoTypeRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.privacy.dlp.v2.IStoredInfoType, protos.google.privacy.dlp.v2.ICreateStoredInfoTypeRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing StoredInfoType. 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. Parent resource name.
   *  The format of this value varies depending on the scope of the request
   *  (project or organization) and whether you have specified a processing
   *  location (https://cloud.google.com/sensitive-data-protection/docs/specifying-location):
   *  + Projects scope, location specified:
   *    `projects/{project_id}/locations/{location_id}`
   *  + Projects scope, no location specified (defaults to global):
   *    `projects/{project_id}`
   *  + Organizations scope, location specified:
   *    `organizations/{org_id}/locations/{location_id}`
   *  + Organizations scope, no location specified (defaults to global):
   *    `organizations/{org_id}`
   *  The following example `parent` string specifies a parent project with the
   *  identifier `example-project`, and specifies the `europe-west3` location
   *  for processing data:
   *      parent=projects/example-project/locations/europe-west3
   */
  // const parent = 'abc123'
  /**
   *  Required. Configuration of the storedInfoType to create.
   */
  // const config = {}
  /**
   *  The storedInfoType ID can contain uppercase and lowercase letters,
   *  numbers, and hyphens; that is, it must match the regular
   *  expression: `[a-zA-Z\d-_]+`. The maximum length is 100
   *  characters. Can be empty to allow the system to generate one.
   */
  // const storedInfoTypeId = 'abc123'

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

    // Run request
    const response = await dlpClient.createStoredInfoType(request);
    console.log(response);
  }

  callCreateStoredInfoType();

createStoredInfoType(request, options, callback)

createStoredInfoType(request: protos.google.privacy.dlp.v2.ICreateStoredInfoTypeRequest, options: CallOptions, callback: Callback<protos.google.privacy.dlp.v2.IStoredInfoType, protos.google.privacy.dlp.v2.ICreateStoredInfoTypeRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateStoredInfoTypeRequest
options CallOptions
callback Callback<protos.google.privacy.dlp.v2.IStoredInfoType, protos.google.privacy.dlp.v2.ICreateStoredInfoTypeRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createStoredInfoType(request, callback)

createStoredInfoType(request: protos.google.privacy.dlp.v2.ICreateStoredInfoTypeRequest, callback: Callback<protos.google.privacy.dlp.v2.IStoredInfoType, protos.google.privacy.dlp.v2.ICreateStoredInfoTypeRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateStoredInfoTypeRequest
callback Callback<protos.google.privacy.dlp.v2.IStoredInfoType, protos.google.privacy.dlp.v2.ICreateStoredInfoTypeRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deidentifyContent(request, options)

deidentifyContent(request?: protos.google.privacy.dlp.v2.IDeidentifyContentRequest, options?: CallOptions): Promise<[
        protos.google.privacy.dlp.v2.IDeidentifyContentResponse,
        protos.google.privacy.dlp.v2.IDeidentifyContentRequest | undefined,
        {} | undefined
    ]>;

De-identifies potentially sensitive info from a ContentItem. This method has limits on input size and output size. See https://cloud.google.com/sensitive-data-protection/docs/deidentify-sensitive-data to learn more.

When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.

Parameters
Name Description
request IDeidentifyContentRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.privacy.dlp.v2.IDeidentifyContentResponse, protos.google.privacy.dlp.v2.IDeidentifyContentRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing DeidentifyContentResponse. 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.
   */
  /**
   *  Parent resource name.
   *  The format of this value varies depending on whether you have specified a
   *  processing
   *  location (https://cloud.google.com/sensitive-data-protection/docs/specifying-location):
   *  + Projects scope, location specified:
   *    `projects/{project_id}/locations/{location_id}`
   *  + Projects scope, no location specified (defaults to global):
   *    `projects/{project_id}`
   *  The following example `parent` string specifies a parent project with the
   *  identifier `example-project`, and specifies the `europe-west3` location
   *  for processing data:
   *      parent=projects/example-project/locations/europe-west3
   */
  // const parent = 'abc123'
  /**
   *  Configuration for the de-identification of the content item.
   *  Items specified here will override the template referenced by the
   *  deidentify_template_name argument.
   */
  // const deidentifyConfig = {}
  /**
   *  Configuration for the inspector.
   *  Items specified here will override the template referenced by the
   *  inspect_template_name argument.
   */
  // const inspectConfig = {}
  /**
   *  The item to de-identify. Will be treated as text.
   *  This value must be of type
   *  Table google.privacy.dlp.v2.Table  if your
   *  deidentify_config google.privacy.dlp.v2.DeidentifyContentRequest.deidentify_config 
   *  is a
   *  RecordTransformations google.privacy.dlp.v2.RecordTransformations 
   *  object.
   */
  // const item = {}
  /**
   *  Template to use. Any configuration directly specified in
   *  inspect_config will override those set in the template. Singular fields
   *  that are set in this request will replace their corresponding fields in the
   *  template. Repeated fields are appended. Singular sub-messages and groups
   *  are recursively merged.
   */
  // const inspectTemplateName = 'abc123'
  /**
   *  Template to use. Any configuration directly specified in
   *  deidentify_config will override those set in the template. Singular fields
   *  that are set in this request will replace their corresponding fields in the
   *  template. Repeated fields are appended. Singular sub-messages and groups
   *  are recursively merged.
   */
  // const deidentifyTemplateName = 'abc123'

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

  async function callDeidentifyContent() {
    // Construct request
    const request = {
    };

    // Run request
    const response = await dlpClient.deidentifyContent(request);
    console.log(response);
  }

  callDeidentifyContent();

deidentifyContent(request, options, callback)

deidentifyContent(request: protos.google.privacy.dlp.v2.IDeidentifyContentRequest, options: CallOptions, callback: Callback<protos.google.privacy.dlp.v2.IDeidentifyContentResponse, protos.google.privacy.dlp.v2.IDeidentifyContentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeidentifyContentRequest
options CallOptions
callback Callback<protos.google.privacy.dlp.v2.IDeidentifyContentResponse, protos.google.privacy.dlp.v2.IDeidentifyContentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deidentifyContent(request, callback)

deidentifyContent(request: protos.google.privacy.dlp.v2.IDeidentifyContentRequest, callback: Callback<protos.google.privacy.dlp.v2.IDeidentifyContentResponse, protos.google.privacy.dlp.v2.IDeidentifyContentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeidentifyContentRequest
callback Callback<protos.google.privacy.dlp.v2.IDeidentifyContentResponse, protos.google.privacy.dlp.v2.IDeidentifyContentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteConnection(request, options)

deleteConnection(request?: protos.google.privacy.dlp.v2.IDeleteConnectionRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.privacy.dlp.v2.IDeleteConnectionRequest | undefined,
        {} | undefined
    ]>;

Delete a Connection.

Parameters
Name Description
request IDeleteConnectionRequest

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.privacy.dlp.v2.IDeleteConnectionRequest | 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. Resource name of the Connection to be deleted, in the format:
   *  `projects/{project}/locations/{location}/connections/{connection}`.
   */
  // const name = 'abc123'

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

    // Run request
    const response = await dlpClient.deleteConnection(request);
    console.log(response);
  }

  callDeleteConnection();

deleteConnection(request, options, callback)

deleteConnection(request: protos.google.privacy.dlp.v2.IDeleteConnectionRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.privacy.dlp.v2.IDeleteConnectionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteConnectionRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.privacy.dlp.v2.IDeleteConnectionRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteConnection(request, callback)

deleteConnection(request: protos.google.privacy.dlp.v2.IDeleteConnectionRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.privacy.dlp.v2.IDeleteConnectionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteConnectionRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.privacy.dlp.v2.IDeleteConnectionRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteDeidentifyTemplate(request, options)

deleteDeidentifyTemplate(request?: protos.google.privacy.dlp.v2.IDeleteDeidentifyTemplateRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.privacy.dlp.v2.IDeleteDeidentifyTemplateRequest | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request IDeleteDeidentifyTemplateRequest

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.privacy.dlp.v2.IDeleteDeidentifyTemplateRequest | 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. Resource name of the organization and deidentify template to be
   *  deleted, for example
   *  `organizations/433245324/deidentifyTemplates/432452342` or
   *  projects/project-id/deidentifyTemplates/432452342.
   */
  // const name = 'abc123'

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

    // Run request
    const response = await dlpClient.deleteDeidentifyTemplate(request);
    console.log(response);
  }

  callDeleteDeidentifyTemplate();

deleteDeidentifyTemplate(request, options, callback)

deleteDeidentifyTemplate(request: protos.google.privacy.dlp.v2.IDeleteDeidentifyTemplateRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.privacy.dlp.v2.IDeleteDeidentifyTemplateRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteDeidentifyTemplateRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.privacy.dlp.v2.IDeleteDeidentifyTemplateRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteDeidentifyTemplate(request, callback)

deleteDeidentifyTemplate(request: protos.google.privacy.dlp.v2.IDeleteDeidentifyTemplateRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.privacy.dlp.v2.IDeleteDeidentifyTemplateRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteDeidentifyTemplateRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.privacy.dlp.v2.IDeleteDeidentifyTemplateRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteDiscoveryConfig(request, options)

deleteDiscoveryConfig(request?: protos.google.privacy.dlp.v2.IDeleteDiscoveryConfigRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.privacy.dlp.v2.IDeleteDiscoveryConfigRequest | undefined,
        {} | undefined
    ]>;

Deletes a discovery configuration.

Parameters
Name Description
request IDeleteDiscoveryConfigRequest

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.privacy.dlp.v2.IDeleteDiscoveryConfigRequest | 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. Resource name of the project and the config, for example
   *  `projects/dlp-test-project/discoveryConfigs/53234423`.
   */
  // const name = 'abc123'

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

    // Run request
    const response = await dlpClient.deleteDiscoveryConfig(request);
    console.log(response);
  }

  callDeleteDiscoveryConfig();

deleteDiscoveryConfig(request, options, callback)

deleteDiscoveryConfig(request: protos.google.privacy.dlp.v2.IDeleteDiscoveryConfigRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.privacy.dlp.v2.IDeleteDiscoveryConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteDiscoveryConfigRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.privacy.dlp.v2.IDeleteDiscoveryConfigRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteDiscoveryConfig(request, callback)

deleteDiscoveryConfig(request: protos.google.privacy.dlp.v2.IDeleteDiscoveryConfigRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.privacy.dlp.v2.IDeleteDiscoveryConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteDiscoveryConfigRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.privacy.dlp.v2.IDeleteDiscoveryConfigRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteDlpJob(request, options)

deleteDlpJob(request?: protos.google.privacy.dlp.v2.IDeleteDlpJobRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.privacy.dlp.v2.IDeleteDlpJobRequest | undefined,
        {} | undefined
    ]>;

Deletes a long-running DlpJob. This method indicates that the client is no longer interested in the DlpJob result. The job will be canceled if possible. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.

Parameters
Name Description
request IDeleteDlpJobRequest

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.privacy.dlp.v2.IDeleteDlpJobRequest | 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 name of the DlpJob resource to be deleted.
   */
  // const name = 'abc123'

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

    // Run request
    const response = await dlpClient.deleteDlpJob(request);
    console.log(response);
  }

  callDeleteDlpJob();

deleteDlpJob(request, options, callback)

deleteDlpJob(request: protos.google.privacy.dlp.v2.IDeleteDlpJobRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.privacy.dlp.v2.IDeleteDlpJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteDlpJobRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.privacy.dlp.v2.IDeleteDlpJobRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteDlpJob(request, callback)

deleteDlpJob(request: protos.google.privacy.dlp.v2.IDeleteDlpJobRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.privacy.dlp.v2.IDeleteDlpJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteDlpJobRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.privacy.dlp.v2.IDeleteDlpJobRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteFileStoreDataProfile(request, options)

deleteFileStoreDataProfile(request?: protos.google.privacy.dlp.v2.IDeleteFileStoreDataProfileRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        (protos.google.privacy.dlp.v2.IDeleteFileStoreDataProfileRequest | undefined),
        {} | undefined
    ]>;

Delete a FileStoreDataProfile. Will not prevent the profile from being regenerated if the resource is still included in a discovery configuration.

Parameters
Name Description
request IDeleteFileStoreDataProfileRequest

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.privacy.dlp.v2.IDeleteFileStoreDataProfileRequest | 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. Resource name of the file store data profile.
   */
  // const name = 'abc123'

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

    // Run request
    const response = await dlpClient.deleteFileStoreDataProfile(request);
    console.log(response);
  }

  callDeleteFileStoreDataProfile();

deleteFileStoreDataProfile(request, options, callback)

deleteFileStoreDataProfile(request: protos.google.privacy.dlp.v2.IDeleteFileStoreDataProfileRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.privacy.dlp.v2.IDeleteFileStoreDataProfileRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteFileStoreDataProfileRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.privacy.dlp.v2.IDeleteFileStoreDataProfileRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteFileStoreDataProfile(request, callback)

deleteFileStoreDataProfile(request: protos.google.privacy.dlp.v2.IDeleteFileStoreDataProfileRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.privacy.dlp.v2.IDeleteFileStoreDataProfileRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteFileStoreDataProfileRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.privacy.dlp.v2.IDeleteFileStoreDataProfileRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteInspectTemplate(request, options)

deleteInspectTemplate(request?: protos.google.privacy.dlp.v2.IDeleteInspectTemplateRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.privacy.dlp.v2.IDeleteInspectTemplateRequest | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request IDeleteInspectTemplateRequest

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.privacy.dlp.v2.IDeleteInspectTemplateRequest | 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. Resource name of the organization and inspectTemplate to be
   *  deleted, for example `organizations/433245324/inspectTemplates/432452342`
   *  or projects/project-id/inspectTemplates/432452342.
   */
  // const name = 'abc123'

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

    // Run request
    const response = await dlpClient.deleteInspectTemplate(request);
    console.log(response);
  }

  callDeleteInspectTemplate();

deleteInspectTemplate(request, options, callback)

deleteInspectTemplate(request: protos.google.privacy.dlp.v2.IDeleteInspectTemplateRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.privacy.dlp.v2.IDeleteInspectTemplateRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteInspectTemplateRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.privacy.dlp.v2.IDeleteInspectTemplateRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteInspectTemplate(request, callback)

deleteInspectTemplate(request: protos.google.privacy.dlp.v2.IDeleteInspectTemplateRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.privacy.dlp.v2.IDeleteInspectTemplateRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteInspectTemplateRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.privacy.dlp.v2.IDeleteInspectTemplateRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteJobTrigger(request, options)

deleteJobTrigger(request?: protos.google.privacy.dlp.v2.IDeleteJobTriggerRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.privacy.dlp.v2.IDeleteJobTriggerRequest | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request IDeleteJobTriggerRequest

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.privacy.dlp.v2.IDeleteJobTriggerRequest | 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. Resource name of the project and the triggeredJob, for example
   *  `projects/dlp-test-project/jobTriggers/53234423`.
   */
  // const name = 'abc123'

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

    // Run request
    const response = await dlpClient.deleteJobTrigger(request);
    console.log(response);
  }

  callDeleteJobTrigger();

deleteJobTrigger(request, options, callback)

deleteJobTrigger(request: protos.google.privacy.dlp.v2.IDeleteJobTriggerRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.privacy.dlp.v2.IDeleteJobTriggerRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteJobTriggerRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.privacy.dlp.v2.IDeleteJobTriggerRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteJobTrigger(request, callback)

deleteJobTrigger(request: protos.google.privacy.dlp.v2.IDeleteJobTriggerRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.privacy.dlp.v2.IDeleteJobTriggerRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteJobTriggerRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.privacy.dlp.v2.IDeleteJobTriggerRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteStoredInfoType(request, options)

deleteStoredInfoType(request?: protos.google.privacy.dlp.v2.IDeleteStoredInfoTypeRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.privacy.dlp.v2.IDeleteStoredInfoTypeRequest | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request IDeleteStoredInfoTypeRequest

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.privacy.dlp.v2.IDeleteStoredInfoTypeRequest | 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. Resource name of the organization and storedInfoType to be
   *  deleted, for example `organizations/433245324/storedInfoTypes/432452342` or
   *  projects/project-id/storedInfoTypes/432452342.
   */
  // const name = 'abc123'

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

    // Run request
    const response = await dlpClient.deleteStoredInfoType(request);
    console.log(response);
  }

  callDeleteStoredInfoType();

deleteStoredInfoType(request, options, callback)

deleteStoredInfoType(request: protos.google.privacy.dlp.v2.IDeleteStoredInfoTypeRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.privacy.dlp.v2.IDeleteStoredInfoTypeRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteStoredInfoTypeRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.privacy.dlp.v2.IDeleteStoredInfoTypeRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteStoredInfoType(request, callback)

deleteStoredInfoType(request: protos.google.privacy.dlp.v2.IDeleteStoredInfoTypeRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.privacy.dlp.v2.IDeleteStoredInfoTypeRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteStoredInfoTypeRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.privacy.dlp.v2.IDeleteStoredInfoTypeRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteTableDataProfile(request, options)

deleteTableDataProfile(request?: protos.google.privacy.dlp.v2.IDeleteTableDataProfileRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.privacy.dlp.v2.IDeleteTableDataProfileRequest | undefined,
        {} | undefined
    ]>;

Delete a TableDataProfile. Will not prevent the profile from being regenerated if the table is still included in a discovery configuration.

Parameters
Name Description
request IDeleteTableDataProfileRequest

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.privacy.dlp.v2.IDeleteTableDataProfileRequest | 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. Resource name of the table data profile.
   */
  // const name = 'abc123'

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

    // Run request
    const response = await dlpClient.deleteTableDataProfile(request);
    console.log(response);
  }

  callDeleteTableDataProfile();

deleteTableDataProfile(request, options, callback)

deleteTableDataProfile(request: protos.google.privacy.dlp.v2.IDeleteTableDataProfileRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.privacy.dlp.v2.IDeleteTableDataProfileRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteTableDataProfileRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.privacy.dlp.v2.IDeleteTableDataProfileRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteTableDataProfile(request, callback)

deleteTableDataProfile(request: protos.google.privacy.dlp.v2.IDeleteTableDataProfileRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.privacy.dlp.v2.IDeleteTableDataProfileRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteTableDataProfileRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.privacy.dlp.v2.IDeleteTableDataProfileRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

discoveryConfigPath(project, location, discoveryConfig)

discoveryConfigPath(project: string, location: string, discoveryConfig: string): string;

Return a fully-qualified discoveryConfig resource name string.

Parameters
Name Description
project string
location string
discoveryConfig string
Returns
Type Description
string

{string} Resource name string.

findingPath(project, location, finding)

findingPath(project: string, location: string, finding: string): string;

Return a fully-qualified finding resource name string.

Parameters
Name Description
project string
location string
finding string
Returns
Type Description
string

{string} Resource name string.

finishDlpJob(request, options)

finishDlpJob(request?: protos.google.privacy.dlp.v2.IFinishDlpJobRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.privacy.dlp.v2.IFinishDlpJobRequest | undefined,
        {} | undefined
    ]>;

Finish a running hybrid DlpJob. Triggers the finalization steps and running of any enabled actions that have not yet run.

Parameters
Name Description
request IFinishDlpJobRequest

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.privacy.dlp.v2.IFinishDlpJobRequest | 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 name of the DlpJob resource to be finished.
   */
  // const name = 'abc123'

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

    // Run request
    const response = await dlpClient.finishDlpJob(request);
    console.log(response);
  }

  callFinishDlpJob();

finishDlpJob(request, options, callback)

finishDlpJob(request: protos.google.privacy.dlp.v2.IFinishDlpJobRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.privacy.dlp.v2.IFinishDlpJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IFinishDlpJobRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.privacy.dlp.v2.IFinishDlpJobRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

finishDlpJob(request, callback)

finishDlpJob(request: protos.google.privacy.dlp.v2.IFinishDlpJobRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.privacy.dlp.v2.IFinishDlpJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IFinishDlpJobRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.privacy.dlp.v2.IFinishDlpJobRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getColumnDataProfile(request, options)

getColumnDataProfile(request?: protos.google.privacy.dlp.v2.IGetColumnDataProfileRequest, options?: CallOptions): Promise<[
        protos.google.privacy.dlp.v2.IColumnDataProfile,
        protos.google.privacy.dlp.v2.IGetColumnDataProfileRequest | undefined,
        {} | undefined
    ]>;

Gets a column data profile.

Parameters
Name Description
request IGetColumnDataProfileRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.privacy.dlp.v2.IColumnDataProfile, protos.google.privacy.dlp.v2.IGetColumnDataProfileRequest | 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. Resource name, for example
   *  `organizations/12345/locations/us/columnDataProfiles/53234423`.
   */
  // const name = 'abc123'

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

    // Run request
    const response = await dlpClient.getColumnDataProfile(request);
    console.log(response);
  }

  callGetColumnDataProfile();

getColumnDataProfile(request, options, callback)

getColumnDataProfile(request: protos.google.privacy.dlp.v2.IGetColumnDataProfileRequest, options: CallOptions, callback: Callback<protos.google.privacy.dlp.v2.IColumnDataProfile, protos.google.privacy.dlp.v2.IGetColumnDataProfileRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetColumnDataProfileRequest
options CallOptions
callback Callback<protos.google.privacy.dlp.v2.IColumnDataProfile, protos.google.privacy.dlp.v2.IGetColumnDataProfileRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getColumnDataProfile(request, callback)

getColumnDataProfile(request: protos.google.privacy.dlp.v2.IGetColumnDataProfileRequest, callback: Callback<protos.google.privacy.dlp.v2.IColumnDataProfile, protos.google.privacy.dlp.v2.IGetColumnDataProfileRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetColumnDataProfileRequest
callback Callback<protos.google.privacy.dlp.v2.IColumnDataProfile, protos.google.privacy.dlp.v2.IGetColumnDataProfileRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getConnection(request, options)

getConnection(request?: protos.google.privacy.dlp.v2.IGetConnectionRequest, options?: CallOptions): Promise<[
        protos.google.privacy.dlp.v2.IConnection,
        protos.google.privacy.dlp.v2.IGetConnectionRequest | undefined,
        {} | undefined
    ]>;

Get a Connection by name.

Parameters
Name Description
request IGetConnectionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.privacy.dlp.v2.IConnection, protos.google.privacy.dlp.v2.IGetConnectionRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Connection. 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. Resource name in the format:
   *  `projects/{project}/locations/{location}/connections/{connection}`.
   */
  // const name = 'abc123'

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

    // Run request
    const response = await dlpClient.getConnection(request);
    console.log(response);
  }

  callGetConnection();

getConnection(request, options, callback)

getConnection(request: protos.google.privacy.dlp.v2.IGetConnectionRequest, options: CallOptions, callback: Callback<protos.google.privacy.dlp.v2.IConnection, protos.google.privacy.dlp.v2.IGetConnectionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetConnectionRequest
options CallOptions
callback Callback<protos.google.privacy.dlp.v2.IConnection, protos.google.privacy.dlp.v2.IGetConnectionRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getConnection(request, callback)

getConnection(request: protos.google.privacy.dlp.v2.IGetConnectionRequest, callback: Callback<protos.google.privacy.dlp.v2.IConnection, protos.google.privacy.dlp.v2.IGetConnectionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetConnectionRequest
callback Callback<protos.google.privacy.dlp.v2.IConnection, protos.google.privacy.dlp.v2.IGetConnectionRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getDeidentifyTemplate(request, options)

getDeidentifyTemplate(request?: protos.google.privacy.dlp.v2.IGetDeidentifyTemplateRequest, options?: CallOptions): Promise<[
        protos.google.privacy.dlp.v2.IDeidentifyTemplate,
        protos.google.privacy.dlp.v2.IGetDeidentifyTemplateRequest | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request IGetDeidentifyTemplateRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.privacy.dlp.v2.IDeidentifyTemplate, protos.google.privacy.dlp.v2.IGetDeidentifyTemplateRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing DeidentifyTemplate. 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. Resource name of the organization and deidentify template to be
   *  read, for example `organizations/433245324/deidentifyTemplates/432452342`
   *  or projects/project-id/deidentifyTemplates/432452342.
   */
  // const name = 'abc123'

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

    // Run request
    const response = await dlpClient.getDeidentifyTemplate(request);
    console.log(response);
  }

  callGetDeidentifyTemplate();

getDeidentifyTemplate(request, options, callback)

getDeidentifyTemplate(request: protos.google.privacy.dlp.v2.IGetDeidentifyTemplateRequest, options: CallOptions, callback: Callback<protos.google.privacy.dlp.v2.IDeidentifyTemplate, protos.google.privacy.dlp.v2.IGetDeidentifyTemplateRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetDeidentifyTemplateRequest
options CallOptions
callback Callback<protos.google.privacy.dlp.v2.IDeidentifyTemplate, protos.google.privacy.dlp.v2.IGetDeidentifyTemplateRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getDeidentifyTemplate(request, callback)

getDeidentifyTemplate(request: protos.google.privacy.dlp.v2.IGetDeidentifyTemplateRequest, callback: Callback<protos.google.privacy.dlp.v2.IDeidentifyTemplate, protos.google.privacy.dlp.v2.IGetDeidentifyTemplateRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetDeidentifyTemplateRequest
callback Callback<protos.google.privacy.dlp.v2.IDeidentifyTemplate, protos.google.privacy.dlp.v2.IGetDeidentifyTemplateRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getDiscoveryConfig(request, options)

getDiscoveryConfig(request?: protos.google.privacy.dlp.v2.IGetDiscoveryConfigRequest, options?: CallOptions): Promise<[
        protos.google.privacy.dlp.v2.IDiscoveryConfig,
        protos.google.privacy.dlp.v2.IGetDiscoveryConfigRequest | undefined,
        {} | undefined
    ]>;

Gets a discovery configuration.

Parameters
Name Description
request IGetDiscoveryConfigRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.privacy.dlp.v2.IDiscoveryConfig, protos.google.privacy.dlp.v2.IGetDiscoveryConfigRequest | 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. Resource name of the project and the configuration, for example
   *  `projects/dlp-test-project/discoveryConfigs/53234423`.
   */
  // const name = 'abc123'

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

    // Run request
    const response = await dlpClient.getDiscoveryConfig(request);
    console.log(response);
  }

  callGetDiscoveryConfig();

getDiscoveryConfig(request, options, callback)

getDiscoveryConfig(request: protos.google.privacy.dlp.v2.IGetDiscoveryConfigRequest, options: CallOptions, callback: Callback<protos.google.privacy.dlp.v2.IDiscoveryConfig, protos.google.privacy.dlp.v2.IGetDiscoveryConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetDiscoveryConfigRequest
options CallOptions
callback Callback<protos.google.privacy.dlp.v2.IDiscoveryConfig, protos.google.privacy.dlp.v2.IGetDiscoveryConfigRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getDiscoveryConfig(request, callback)

getDiscoveryConfig(request: protos.google.privacy.dlp.v2.IGetDiscoveryConfigRequest, callback: Callback<protos.google.privacy.dlp.v2.IDiscoveryConfig, protos.google.privacy.dlp.v2.IGetDiscoveryConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetDiscoveryConfigRequest
callback Callback<protos.google.privacy.dlp.v2.IDiscoveryConfig, protos.google.privacy.dlp.v2.IGetDiscoveryConfigRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getDlpJob(request, options)

getDlpJob(request?: protos.google.privacy.dlp.v2.IGetDlpJobRequest, options?: CallOptions): Promise<[
        protos.google.privacy.dlp.v2.IDlpJob,
        protos.google.privacy.dlp.v2.IGetDlpJobRequest | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request IGetDlpJobRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.privacy.dlp.v2.IDlpJob, protos.google.privacy.dlp.v2.IGetDlpJobRequest | 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 name of the DlpJob resource.
   */
  // const name = 'abc123'

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

    // Run request
    const response = await dlpClient.getDlpJob(request);
    console.log(response);
  }

  callGetDlpJob();

getDlpJob(request, options, callback)

getDlpJob(request: protos.google.privacy.dlp.v2.IGetDlpJobRequest, options: CallOptions, callback: Callback<protos.google.privacy.dlp.v2.IDlpJob, protos.google.privacy.dlp.v2.IGetDlpJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetDlpJobRequest
options CallOptions
callback Callback<protos.google.privacy.dlp.v2.IDlpJob, protos.google.privacy.dlp.v2.IGetDlpJobRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getDlpJob(request, callback)

getDlpJob(request: protos.google.privacy.dlp.v2.IGetDlpJobRequest, callback: Callback<protos.google.privacy.dlp.v2.IDlpJob, protos.google.privacy.dlp.v2.IGetDlpJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetDlpJobRequest
callback Callback<protos.google.privacy.dlp.v2.IDlpJob, protos.google.privacy.dlp.v2.IGetDlpJobRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getFileStoreDataProfile(request, options)

getFileStoreDataProfile(request?: protos.google.privacy.dlp.v2.IGetFileStoreDataProfileRequest, options?: CallOptions): Promise<[
        protos.google.privacy.dlp.v2.IFileStoreDataProfile,
        protos.google.privacy.dlp.v2.IGetFileStoreDataProfileRequest | undefined,
        {} | undefined
    ]>;

Gets a file store data profile.

Parameters
Name Description
request IGetFileStoreDataProfileRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.privacy.dlp.v2.IFileStoreDataProfile, protos.google.privacy.dlp.v2.IGetFileStoreDataProfileRequest | 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. Resource name, for example
   *  `organizations/12345/locations/us/fileStoreDataProfiles/53234423`.
   */
  // const name = 'abc123'

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

    // Run request
    const response = await dlpClient.getFileStoreDataProfile(request);
    console.log(response);
  }

  callGetFileStoreDataProfile();

getFileStoreDataProfile(request, options, callback)

getFileStoreDataProfile(request: protos.google.privacy.dlp.v2.IGetFileStoreDataProfileRequest, options: CallOptions, callback: Callback<protos.google.privacy.dlp.v2.IFileStoreDataProfile, protos.google.privacy.dlp.v2.IGetFileStoreDataProfileRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetFileStoreDataProfileRequest
options CallOptions
callback Callback<protos.google.privacy.dlp.v2.IFileStoreDataProfile, protos.google.privacy.dlp.v2.IGetFileStoreDataProfileRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getFileStoreDataProfile(request, callback)

getFileStoreDataProfile(request: protos.google.privacy.dlp.v2.IGetFileStoreDataProfileRequest, callback: Callback<protos.google.privacy.dlp.v2.IFileStoreDataProfile, protos.google.privacy.dlp.v2.IGetFileStoreDataProfileRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetFileStoreDataProfileRequest
callback Callback<protos.google.privacy.dlp.v2.IFileStoreDataProfile, protos.google.privacy.dlp.v2.IGetFileStoreDataProfileRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getInspectTemplate(request, options)

getInspectTemplate(request?: protos.google.privacy.dlp.v2.IGetInspectTemplateRequest, options?: CallOptions): Promise<[
        protos.google.privacy.dlp.v2.IInspectTemplate,
        protos.google.privacy.dlp.v2.IGetInspectTemplateRequest | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request IGetInspectTemplateRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.privacy.dlp.v2.IInspectTemplate, protos.google.privacy.dlp.v2.IGetInspectTemplateRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing InspectTemplate. 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. Resource name of the organization and inspectTemplate to be read,
   *  for example `organizations/433245324/inspectTemplates/432452342` or
   *  projects/project-id/inspectTemplates/432452342.
   */
  // const name = 'abc123'

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

    // Run request
    const response = await dlpClient.getInspectTemplate(request);
    console.log(response);
  }

  callGetInspectTemplate();

getInspectTemplate(request, options, callback)

getInspectTemplate(request: protos.google.privacy.dlp.v2.IGetInspectTemplateRequest, options: CallOptions, callback: Callback<protos.google.privacy.dlp.v2.IInspectTemplate, protos.google.privacy.dlp.v2.IGetInspectTemplateRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetInspectTemplateRequest
options CallOptions
callback Callback<protos.google.privacy.dlp.v2.IInspectTemplate, protos.google.privacy.dlp.v2.IGetInspectTemplateRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getInspectTemplate(request, callback)

getInspectTemplate(request: protos.google.privacy.dlp.v2.IGetInspectTemplateRequest, callback: Callback<protos.google.privacy.dlp.v2.IInspectTemplate, protos.google.privacy.dlp.v2.IGetInspectTemplateRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetInspectTemplateRequest
callback Callback<protos.google.privacy.dlp.v2.IInspectTemplate, protos.google.privacy.dlp.v2.IGetInspectTemplateRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getJobTrigger(request, options)

getJobTrigger(request?: protos.google.privacy.dlp.v2.IGetJobTriggerRequest, options?: CallOptions): Promise<[
        protos.google.privacy.dlp.v2.IJobTrigger,
        protos.google.privacy.dlp.v2.IGetJobTriggerRequest | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request IGetJobTriggerRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.privacy.dlp.v2.IJobTrigger, protos.google.privacy.dlp.v2.IGetJobTriggerRequest | 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. Resource name of the project and the triggeredJob, for example
   *  `projects/dlp-test-project/jobTriggers/53234423`.
   */
  // const name = 'abc123'

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

    // Run request
    const response = await dlpClient.getJobTrigger(request);
    console.log(response);
  }

  callGetJobTrigger();

getJobTrigger(request, options, callback)

getJobTrigger(request: protos.google.privacy.dlp.v2.IGetJobTriggerRequest, options: CallOptions, callback: Callback<protos.google.privacy.dlp.v2.IJobTrigger, protos.google.privacy.dlp.v2.IGetJobTriggerRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetJobTriggerRequest
options CallOptions
callback Callback<protos.google.privacy.dlp.v2.IJobTrigger, protos.google.privacy.dlp.v2.IGetJobTriggerRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getJobTrigger(request, callback)

getJobTrigger(request: protos.google.privacy.dlp.v2.IGetJobTriggerRequest, callback: Callback<protos.google.privacy.dlp.v2.IJobTrigger, protos.google.privacy.dlp.v2.IGetJobTriggerRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetJobTriggerRequest
callback Callback<protos.google.privacy.dlp.v2.IJobTrigger, protos.google.privacy.dlp.v2.IGetJobTriggerRequest | 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);

getProjectDataProfile(request, options)

getProjectDataProfile(request?: protos.google.privacy.dlp.v2.IGetProjectDataProfileRequest, options?: CallOptions): Promise<[
        protos.google.privacy.dlp.v2.IProjectDataProfile,
        protos.google.privacy.dlp.v2.IGetProjectDataProfileRequest | undefined,
        {} | undefined
    ]>;

Gets a project data profile.

Parameters
Name Description
request IGetProjectDataProfileRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.privacy.dlp.v2.IProjectDataProfile, protos.google.privacy.dlp.v2.IGetProjectDataProfileRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing ProjectDataProfile. 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. Resource name, for example
   *  `organizations/12345/locations/us/projectDataProfiles/53234423`.
   */
  // const name = 'abc123'

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

    // Run request
    const response = await dlpClient.getProjectDataProfile(request);
    console.log(response);
  }

  callGetProjectDataProfile();

getProjectDataProfile(request, options, callback)

getProjectDataProfile(request: protos.google.privacy.dlp.v2.IGetProjectDataProfileRequest, options: CallOptions, callback: Callback<protos.google.privacy.dlp.v2.IProjectDataProfile, protos.google.privacy.dlp.v2.IGetProjectDataProfileRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetProjectDataProfileRequest
options CallOptions
callback Callback<protos.google.privacy.dlp.v2.IProjectDataProfile, protos.google.privacy.dlp.v2.IGetProjectDataProfileRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getProjectDataProfile(request, callback)

getProjectDataProfile(request: protos.google.privacy.dlp.v2.IGetProjectDataProfileRequest, callback: Callback<protos.google.privacy.dlp.v2.IProjectDataProfile, protos.google.privacy.dlp.v2.IGetProjectDataProfileRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetProjectDataProfileRequest
callback Callback<protos.google.privacy.dlp.v2.IProjectDataProfile, protos.google.privacy.dlp.v2.IGetProjectDataProfileRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getProjectId()

getProjectId(): Promise<string>;
Returns
Type Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
Name Description
callback Callback<string, undefined, undefined>
Returns
Type Description
void

getStoredInfoType(request, options)

getStoredInfoType(request?: protos.google.privacy.dlp.v2.IGetStoredInfoTypeRequest, options?: CallOptions): Promise<[
        protos.google.privacy.dlp.v2.IStoredInfoType,
        protos.google.privacy.dlp.v2.IGetStoredInfoTypeRequest | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request IGetStoredInfoTypeRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.privacy.dlp.v2.IStoredInfoType, protos.google.privacy.dlp.v2.IGetStoredInfoTypeRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing StoredInfoType. 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. Resource name of the organization and storedInfoType to be read,
   *  for example `organizations/433245324/storedInfoTypes/432452342` or
   *  projects/project-id/storedInfoTypes/432452342.
   */
  // const name = 'abc123'

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

    // Run request
    const response = await dlpClient.getStoredInfoType(request);
    console.log(response);
  }

  callGetStoredInfoType();

getStoredInfoType(request, options, callback)

getStoredInfoType(request: protos.google.privacy.dlp.v2.IGetStoredInfoTypeRequest, options: CallOptions, callback: Callback<protos.google.privacy.dlp.v2.IStoredInfoType, protos.google.privacy.dlp.v2.IGetStoredInfoTypeRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetStoredInfoTypeRequest
options CallOptions
callback Callback<protos.google.privacy.dlp.v2.IStoredInfoType, protos.google.privacy.dlp.v2.IGetStoredInfoTypeRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getStoredInfoType(request, callback)

getStoredInfoType(request: protos.google.privacy.dlp.v2.IGetStoredInfoTypeRequest, callback: Callback<protos.google.privacy.dlp.v2.IStoredInfoType, protos.google.privacy.dlp.v2.IGetStoredInfoTypeRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetStoredInfoTypeRequest
callback Callback<protos.google.privacy.dlp.v2.IStoredInfoType, protos.google.privacy.dlp.v2.IGetStoredInfoTypeRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getTableDataProfile(request, options)

getTableDataProfile(request?: protos.google.privacy.dlp.v2.IGetTableDataProfileRequest, options?: CallOptions): Promise<[
        protos.google.privacy.dlp.v2.ITableDataProfile,
        protos.google.privacy.dlp.v2.IGetTableDataProfileRequest | undefined,
        {} | undefined
    ]>;

Gets a table data profile.

Parameters
Name Description
request IGetTableDataProfileRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.privacy.dlp.v2.ITableDataProfile, protos.google.privacy.dlp.v2.IGetTableDataProfileRequest | 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. Resource name, for example
   *  `organizations/12345/locations/us/tableDataProfiles/53234423`.
   */
  // const name = 'abc123'

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

    // Run request
    const response = await dlpClient.getTableDataProfile(request);
    console.log(response);
  }

  callGetTableDataProfile();

getTableDataProfile(request, options, callback)

getTableDataProfile(request: protos.google.privacy.dlp.v2.IGetTableDataProfileRequest, options: CallOptions, callback: Callback<protos.google.privacy.dlp.v2.ITableDataProfile, protos.google.privacy.dlp.v2.IGetTableDataProfileRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetTableDataProfileRequest
options CallOptions
callback Callback<protos.google.privacy.dlp.v2.ITableDataProfile, protos.google.privacy.dlp.v2.IGetTableDataProfileRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getTableDataProfile(request, callback)

getTableDataProfile(request: protos.google.privacy.dlp.v2.IGetTableDataProfileRequest, callback: Callback<protos.google.privacy.dlp.v2.ITableDataProfile, protos.google.privacy.dlp.v2.IGetTableDataProfileRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetTableDataProfileRequest
callback Callback<protos.google.privacy.dlp.v2.ITableDataProfile, protos.google.privacy.dlp.v2.IGetTableDataProfileRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

hybridInspectDlpJob(request, options)

hybridInspectDlpJob(request?: protos.google.privacy.dlp.v2.IHybridInspectDlpJobRequest, options?: CallOptions): Promise<[
        protos.google.privacy.dlp.v2.IHybridInspectResponse,
        protos.google.privacy.dlp.v2.IHybridInspectDlpJobRequest | undefined,
        {} | undefined
    ]>;

Inspect hybrid content and store findings to a job. To review the findings, inspect the job. Inspection will occur asynchronously.

Parameters
Name Description
request IHybridInspectDlpJobRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.privacy.dlp.v2.IHybridInspectResponse, protos.google.privacy.dlp.v2.IHybridInspectDlpJobRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing HybridInspectResponse. 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. Resource name of the job to execute a hybrid inspect on, for
   *  example `projects/dlp-test-project/dlpJob/53234423`.
   */
  // const name = 'abc123'
  /**
   *  The item to inspect.
   */
  // const hybridItem = {}

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

    // Run request
    const response = await dlpClient.hybridInspectDlpJob(request);
    console.log(response);
  }

  callHybridInspectDlpJob();

hybridInspectDlpJob(request, options, callback)

hybridInspectDlpJob(request: protos.google.privacy.dlp.v2.IHybridInspectDlpJobRequest, options: CallOptions, callback: Callback<protos.google.privacy.dlp.v2.IHybridInspectResponse, protos.google.privacy.dlp.v2.IHybridInspectDlpJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IHybridInspectDlpJobRequest
options CallOptions
callback Callback<protos.google.privacy.dlp.v2.IHybridInspectResponse, protos.google.privacy.dlp.v2.IHybridInspectDlpJobRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

hybridInspectDlpJob(request, callback)

hybridInspectDlpJob(request: protos.google.privacy.dlp.v2.IHybridInspectDlpJobRequest, callback: Callback<protos.google.privacy.dlp.v2.IHybridInspectResponse, protos.google.privacy.dlp.v2.IHybridInspectDlpJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IHybridInspectDlpJobRequest
callback Callback<protos.google.privacy.dlp.v2.IHybridInspectResponse, protos.google.privacy.dlp.v2.IHybridInspectDlpJobRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

hybridInspectJobTrigger(request, options)

hybridInspectJobTrigger(request?: protos.google.privacy.dlp.v2.IHybridInspectJobTriggerRequest, options?: CallOptions): Promise<[
        protos.google.privacy.dlp.v2.IHybridInspectResponse,
        protos.google.privacy.dlp.v2.IHybridInspectJobTriggerRequest | undefined,
        {} | undefined
    ]>;

Inspect hybrid content and store findings to a trigger. The inspection will be processed asynchronously. To review the findings monitor the jobs within the trigger.

Parameters
Name Description
request IHybridInspectJobTriggerRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.privacy.dlp.v2.IHybridInspectResponse, protos.google.privacy.dlp.v2.IHybridInspectJobTriggerRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing HybridInspectResponse. 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. Resource name of the trigger to execute a hybrid inspect on, for
   *  example `projects/dlp-test-project/jobTriggers/53234423`.
   */
  // const name = 'abc123'
  /**
   *  The item to inspect.
   */
  // const hybridItem = {}

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

    // Run request
    const response = await dlpClient.hybridInspectJobTrigger(request);
    console.log(response);
  }

  callHybridInspectJobTrigger();

hybridInspectJobTrigger(request, options, callback)

hybridInspectJobTrigger(request: protos.google.privacy.dlp.v2.IHybridInspectJobTriggerRequest, options: CallOptions, callback: Callback<protos.google.privacy.dlp.v2.IHybridInspectResponse, protos.google.privacy.dlp.v2.IHybridInspectJobTriggerRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IHybridInspectJobTriggerRequest
options CallOptions
callback Callback<protos.google.privacy.dlp.v2.IHybridInspectResponse, protos.google.privacy.dlp.v2.IHybridInspectJobTriggerRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

hybridInspectJobTrigger(request, callback)

hybridInspectJobTrigger(request: protos.google.privacy.dlp.v2.IHybridInspectJobTriggerRequest, callback: Callback<protos.google.privacy.dlp.v2.IHybridInspectResponse, protos.google.privacy.dlp.v2.IHybridInspectJobTriggerRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IHybridInspectJobTriggerRequest
callback Callback<protos.google.privacy.dlp.v2.IHybridInspectResponse, protos.google.privacy.dlp.v2.IHybridInspectJobTriggerRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

initialize()

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

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

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

Returns
Type Description
Promise<{ [name: string]: Function; }>

{Promise} A promise that resolves to an authenticated service stub.

inspectContent(request, options)

inspectContent(request?: protos.google.privacy.dlp.v2.IInspectContentRequest, options?: CallOptions): Promise<[
        protos.google.privacy.dlp.v2.IInspectContentResponse,
        protos.google.privacy.dlp.v2.IInspectContentRequest | undefined,
        {} | undefined
    ]>;

Finds potentially sensitive info in content. This method has limits on input size, processing time, and output size.

When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.

For how to guides, see https://cloud.google.com/sensitive-data-protection/docs/inspecting-images and https://cloud.google.com/sensitive-data-protection/docs/inspecting-text,

Parameters
Name Description
request IInspectContentRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.privacy.dlp.v2.IInspectContentResponse, protos.google.privacy.dlp.v2.IInspectContentRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing InspectContentResponse. 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.
   */
  /**
   *  Parent resource name.
   *  The format of this value varies depending on whether you have specified a
   *  processing
   *  location (https://cloud.google.com/sensitive-data-protection/docs/specifying-location):
   *  + Projects scope, location specified:
   *    `projects/{project_id}/locations/{location_id}`
   *  + Projects scope, no location specified (defaults to global):
   *    `projects/{project_id}`
   *  The following example `parent` string specifies a parent project with the
   *  identifier `example-project`, and specifies the `europe-west3` location
   *  for processing data:
   *      parent=projects/example-project/locations/europe-west3
   */
  // const parent = 'abc123'
  /**
   *  Configuration for the inspector. What specified here will override
   *  the template referenced by the inspect_template_name argument.
   */
  // const inspectConfig = {}
  /**
   *  The item to inspect.
   */
  // const item = {}
  /**
   *  Template to use. Any configuration directly specified in
   *  inspect_config will override those set in the template. Singular fields
   *  that are set in this request will replace their corresponding fields in the
   *  template. Repeated fields are appended. Singular sub-messages and groups
   *  are recursively merged.
   */
  // const inspectTemplateName = 'abc123'

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

  async function callInspectContent() {
    // Construct request
    const request = {
    };

    // Run request
    const response = await dlpClient.inspectContent(request);
    console.log(response);
  }

  callInspectContent();

inspectContent(request, options, callback)

inspectContent(request: protos.google.privacy.dlp.v2.IInspectContentRequest, options: CallOptions, callback: Callback<protos.google.privacy.dlp.v2.IInspectContentResponse, protos.google.privacy.dlp.v2.IInspectContentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IInspectContentRequest
options CallOptions
callback Callback<protos.google.privacy.dlp.v2.IInspectContentResponse, protos.google.privacy.dlp.v2.IInspectContentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

inspectContent(request, callback)

inspectContent(request: protos.google.privacy.dlp.v2.IInspectContentRequest, callback: Callback<protos.google.privacy.dlp.v2.IInspectContentResponse, protos.google.privacy.dlp.v2.IInspectContentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IInspectContentRequest
callback Callback<protos.google.privacy.dlp.v2.IInspectContentResponse, protos.google.privacy.dlp.v2.IInspectContentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

listColumnDataProfiles(request, options)

listColumnDataProfiles(request?: protos.google.privacy.dlp.v2.IListColumnDataProfilesRequest, options?: CallOptions): Promise<[
        protos.google.privacy.dlp.v2.IColumnDataProfile[],
        protos.google.privacy.dlp.v2.IListColumnDataProfilesRequest | null,
        protos.google.privacy.dlp.v2.IListColumnDataProfilesResponse
    ]>;

Lists column data profiles for an organization.

Parameters
Name Description
request IListColumnDataProfilesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.privacy.dlp.v2.IColumnDataProfile[], protos.google.privacy.dlp.v2.IListColumnDataProfilesRequest | null, protos.google.privacy.dlp.v2.IListColumnDataProfilesResponse ]>

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

listColumnDataProfiles(request, options, callback)

listColumnDataProfiles(request: protos.google.privacy.dlp.v2.IListColumnDataProfilesRequest, options: CallOptions, callback: PaginationCallback<protos.google.privacy.dlp.v2.IListColumnDataProfilesRequest, protos.google.privacy.dlp.v2.IListColumnDataProfilesResponse | null | undefined, protos.google.privacy.dlp.v2.IColumnDataProfile>): void;
Parameters
Name Description
request IListColumnDataProfilesRequest
options CallOptions
callback PaginationCallback<protos.google.privacy.dlp.v2.IListColumnDataProfilesRequest, protos.google.privacy.dlp.v2.IListColumnDataProfilesResponse | null | undefined, protos.google.privacy.dlp.v2.IColumnDataProfile>
Returns
Type Description
void

listColumnDataProfiles(request, callback)

listColumnDataProfiles(request: protos.google.privacy.dlp.v2.IListColumnDataProfilesRequest, callback: PaginationCallback<protos.google.privacy.dlp.v2.IListColumnDataProfilesRequest, protos.google.privacy.dlp.v2.IListColumnDataProfilesResponse | null | undefined, protos.google.privacy.dlp.v2.IColumnDataProfile>): void;
Parameters
Name Description
request IListColumnDataProfilesRequest
callback PaginationCallback<protos.google.privacy.dlp.v2.IListColumnDataProfilesRequest, protos.google.privacy.dlp.v2.IListColumnDataProfilesResponse | null | undefined, protos.google.privacy.dlp.v2.IColumnDataProfile>
Returns
Type Description
void

listColumnDataProfilesAsync(request, options)

listColumnDataProfilesAsync(request?: protos.google.privacy.dlp.v2.IListColumnDataProfilesRequest, options?: CallOptions): AsyncIterable<protos.google.privacy.dlp.v2.IColumnDataProfile>;

Equivalent to listColumnDataProfiles, but returns an iterable object.

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

Parameters
Name Description
request IListColumnDataProfilesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.privacy.dlp.v2.IColumnDataProfile>

{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. Resource name of the organization or project, for
   *  example `organizations/433245324/locations/europe` or
   *  `projects/project-id/locations/asia`.
   */
  // const parent = 'abc123'
  /**
   *  Page token to continue retrieval.
   */
  // const pageToken = 'abc123'
  /**
   *  Size of the page. This value can be limited by the server. If zero, server
   *  returns a page of max size 100.
   */
  // const pageSize = 1234
  /**
   *  Comma-separated list of fields to order by, followed by `asc` or `desc`
   *  postfix. This list is case insensitive. The default sorting order is
   *  ascending. Redundant space characters are insignificant. Only one order
   *  field at a time is allowed.
   *  Examples:
   *  * `project_id asc`
   *  * `table_id`
   *  * `sensitivity_level desc`
   *  Supported fields are:
   *  - `project_id`: The Google Cloud project ID.
   *  - `dataset_id`: The ID of a BigQuery dataset.
   *  - `table_id`: The ID of a BigQuery table.
   *  - `sensitivity_level`: How sensitive the data in a column is, at most.
   *  - `data_risk_level`: How much risk is associated with this data.
   *  - `profile_last_generated`: When the profile was last updated in epoch
   *  seconds.
   */
  // const orderBy = 'abc123'
  /**
   *  Allows filtering.
   *  Supported syntax:
   *  * Filter expressions are made up of one or more restrictions.
   *  * Restrictions can be combined by `AND` or `OR` logical operators. A
   *  sequence of restrictions implicitly uses `AND`.
   *  * A restriction has the form of `{field} {operator} {value}`.
   *  * Supported fields/values:
   *      - `table_data_profile_name` - The name of the related table data
   *      profile.
   *      - `project_id` - The Google Cloud project ID. (REQUIRED)
   *      - `dataset_id` - The BigQuery dataset ID. (REQUIRED)
   *      - `table_id` - The BigQuery table ID. (REQUIRED)
   *      - `field_id` - The ID of the BigQuery field.
   *      - `info_type` - The infotype detected in the resource.
   *      - `sensitivity_level` - HIGH|MEDIUM|LOW
   *      - `data_risk_level`: How much risk is associated with this data.
   *      - `status_code` - an RPC status code as defined in
   *      https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto
   *  * The operator must be `=` for project_id, dataset_id, and table_id. Other
   *    filters also support `!=`.
   *  Examples:
   *  * project_id = 12345 AND status_code = 1
   *  * project_id = 12345 AND sensitivity_level = HIGH
   *  * project_id = 12345 AND info_type = STREET_ADDRESS
   *  The length of this field should be no more than 500 characters.
   */
  // const filter = 'abc123'

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

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

  callListColumnDataProfiles();

listColumnDataProfilesStream(request, options)

listColumnDataProfilesStream(request?: protos.google.privacy.dlp.v2.IListColumnDataProfilesRequest, options?: CallOptions): Transform;

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

Parameters
Name Description
request IListColumnDataProfilesRequest

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

listConnections(request, options)

listConnections(request?: protos.google.privacy.dlp.v2.IListConnectionsRequest, options?: CallOptions): Promise<[
        protos.google.privacy.dlp.v2.IConnection[],
        protos.google.privacy.dlp.v2.IListConnectionsRequest | null,
        protos.google.privacy.dlp.v2.IListConnectionsResponse
    ]>;

Lists Connections in a parent. Use SearchConnections to see all connections within an organization.

Parameters
Name Description
request IListConnectionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.privacy.dlp.v2.IConnection[], protos.google.privacy.dlp.v2.IListConnectionsRequest | null, protos.google.privacy.dlp.v2.IListConnectionsResponse ]>

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

listConnections(request, options, callback)

listConnections(request: protos.google.privacy.dlp.v2.IListConnectionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.privacy.dlp.v2.IListConnectionsRequest, protos.google.privacy.dlp.v2.IListConnectionsResponse | null | undefined, protos.google.privacy.dlp.v2.IConnection>): void;
Parameters
Name Description
request IListConnectionsRequest
options CallOptions
callback PaginationCallback<protos.google.privacy.dlp.v2.IListConnectionsRequest, protos.google.privacy.dlp.v2.IListConnectionsResponse | null | undefined, protos.google.privacy.dlp.v2.IConnection>
Returns
Type Description
void

listConnections(request, callback)

listConnections(request: protos.google.privacy.dlp.v2.IListConnectionsRequest, callback: PaginationCallback<protos.google.privacy.dlp.v2.IListConnectionsRequest, protos.google.privacy.dlp.v2.IListConnectionsResponse | null | undefined, protos.google.privacy.dlp.v2.IConnection>): void;
Parameters
Name Description
request IListConnectionsRequest
callback PaginationCallback<protos.google.privacy.dlp.v2.IListConnectionsRequest, protos.google.privacy.dlp.v2.IListConnectionsResponse | null | undefined, protos.google.privacy.dlp.v2.IConnection>
Returns
Type Description
void

listConnectionsAsync(request, options)

listConnectionsAsync(request?: protos.google.privacy.dlp.v2.IListConnectionsRequest, options?: CallOptions): AsyncIterable<protos.google.privacy.dlp.v2.IConnection>;

Equivalent to listConnections, but returns an iterable object.

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

Parameters
Name Description
request IListConnectionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.privacy.dlp.v2.IConnection>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Connection. 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. Resource name of the organization or project, for
   *  example, `organizations/433245324/locations/europe` or
   *  `projects/project-id/locations/asia`.
   */
  // const parent = 'abc123'
  /**
   *  Optional. Number of results per page, max 1000.
   */
  // const pageSize = 1234
  /**
   *  Optional. Page token from a previous page to return the next set of
   *  results. If set, all other request fields must match the original request.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Supported field/value: `state` - MISSING|AVAILABLE|ERROR
   */
  // const filter = 'abc123'

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

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

  callListConnections();

listConnectionsStream(request, options)

listConnectionsStream(request?: protos.google.privacy.dlp.v2.IListConnectionsRequest, options?: CallOptions): Transform;

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

Parameters
Name Description
request IListConnectionsRequest

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

listDeidentifyTemplates(request, options)

listDeidentifyTemplates(request?: protos.google.privacy.dlp.v2.IListDeidentifyTemplatesRequest, options?: CallOptions): Promise<[
        protos.google.privacy.dlp.v2.IDeidentifyTemplate[],
        protos.google.privacy.dlp.v2.IListDeidentifyTemplatesRequest | null,
        protos.google.privacy.dlp.v2.IListDeidentifyTemplatesResponse
    ]>;
Parameters
Name Description
request IListDeidentifyTemplatesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.privacy.dlp.v2.IDeidentifyTemplate[], protos.google.privacy.dlp.v2.IListDeidentifyTemplatesRequest | null, protos.google.privacy.dlp.v2.IListDeidentifyTemplatesResponse ]>

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

listDeidentifyTemplates(request, options, callback)

listDeidentifyTemplates(request: protos.google.privacy.dlp.v2.IListDeidentifyTemplatesRequest, options: CallOptions, callback: PaginationCallback<protos.google.privacy.dlp.v2.IListDeidentifyTemplatesRequest, protos.google.privacy.dlp.v2.IListDeidentifyTemplatesResponse | null | undefined, protos.google.privacy.dlp.v2.IDeidentifyTemplate>): void;
Parameters
Name Description
request IListDeidentifyTemplatesRequest
options CallOptions
callback PaginationCallback<protos.google.privacy.dlp.v2.IListDeidentifyTemplatesRequest, protos.google.privacy.dlp.v2.IListDeidentifyTemplatesResponse | null | undefined, protos.google.privacy.dlp.v2.IDeidentifyTemplate>
Returns
Type Description
void

listDeidentifyTemplates(request, callback)

listDeidentifyTemplates(request: protos.google.privacy.dlp.v2.IListDeidentifyTemplatesRequest, callback: PaginationCallback<protos.google.privacy.dlp.v2.IListDeidentifyTemplatesRequest, protos.google.privacy.dlp.v2.IListDeidentifyTemplatesResponse | null | undefined, protos.google.privacy.dlp.v2.IDeidentifyTemplate>): void;
Parameters
Name Description
request IListDeidentifyTemplatesRequest
callback PaginationCallback<protos.google.privacy.dlp.v2.IListDeidentifyTemplatesRequest, protos.google.privacy.dlp.v2.IListDeidentifyTemplatesResponse | null | undefined, protos.google.privacy.dlp.v2.IDeidentifyTemplate>
Returns
Type Description
void

listDeidentifyTemplatesAsync(request, options)

listDeidentifyTemplatesAsync(request?: protos.google.privacy.dlp.v2.IListDeidentifyTemplatesRequest, options?: CallOptions): AsyncIterable<protos.google.privacy.dlp.v2.IDeidentifyTemplate>;

Equivalent to listDeidentifyTemplates, but returns an iterable object.

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

Parameters
Name Description
request IListDeidentifyTemplatesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.privacy.dlp.v2.IDeidentifyTemplate>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing DeidentifyTemplate. 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. Parent resource name.
   *  The format of this value varies depending on the scope of the request
   *  (project or organization) and whether you have specified a processing
   *  location (https://cloud.google.com/sensitive-data-protection/docs/specifying-location):
   *  + Projects scope, location specified:
   *    `projects/{project_id}/locations/{location_id}`
   *  + Projects scope, no location specified (defaults to global):
   *    `projects/{project_id}`
   *  + Organizations scope, location specified:
   *    `organizations/{org_id}/locations/{location_id}`
   *  + Organizations scope, no location specified (defaults to global):
   *    `organizations/{org_id}`
   *  The following example `parent` string specifies a parent project with the
   *  identifier `example-project`, and specifies the `europe-west3` location
   *  for processing data:
   *      parent=projects/example-project/locations/europe-west3
   */
  // const parent = 'abc123'
  /**
   *  Page token to continue retrieval. Comes from the previous call
   *  to `ListDeidentifyTemplates`.
   */
  // const pageToken = 'abc123'
  /**
   *  Size of the page. This value can be limited by the server. If zero server
   *  returns a page of max size 100.
   */
  // const pageSize = 1234
  /**
   *  Comma-separated list of fields to order by,
   *  followed by `asc` or `desc` postfix. This list is case insensitive. The
   *  default sorting order is ascending. Redundant space characters are
   *  insignificant.
   *  Example: `name asc,update_time, create_time desc`
   *  Supported fields are:
   *  - `create_time`: corresponds to the time the template was created.
   *  - `update_time`: corresponds to the time the template was last updated.
   *  - `name`: corresponds to the template's name.
   *  - `display_name`: corresponds to the template's display name.
   */
  // const orderBy = 'abc123'

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

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

  callListDeidentifyTemplates();

listDeidentifyTemplatesStream(request, options)

listDeidentifyTemplatesStream(request?: protos.google.privacy.dlp.v2.IListDeidentifyTemplatesRequest, options?: CallOptions): Transform;

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

Parameters
Name Description
request IListDeidentifyTemplatesRequest

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

listDiscoveryConfigs(request, options)

listDiscoveryConfigs(request?: protos.google.privacy.dlp.v2.IListDiscoveryConfigsRequest, options?: CallOptions): Promise<[
        protos.google.privacy.dlp.v2.IDiscoveryConfig[],
        protos.google.privacy.dlp.v2.IListDiscoveryConfigsRequest | null,
        protos.google.privacy.dlp.v2.IListDiscoveryConfigsResponse
    ]>;

Lists discovery configurations.

Parameters
Name Description
request IListDiscoveryConfigsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.privacy.dlp.v2.IDiscoveryConfig[], protos.google.privacy.dlp.v2.IListDiscoveryConfigsRequest | null, protos.google.privacy.dlp.v2.IListDiscoveryConfigsResponse ]>

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

listDiscoveryConfigs(request, options, callback)

listDiscoveryConfigs(request: protos.google.privacy.dlp.v2.IListDiscoveryConfigsRequest, options: CallOptions, callback: PaginationCallback<protos.google.privacy.dlp.v2.IListDiscoveryConfigsRequest, protos.google.privacy.dlp.v2.IListDiscoveryConfigsResponse | null | undefined, protos.google.privacy.dlp.v2.IDiscoveryConfig>): void;
Parameters
Name Description
request IListDiscoveryConfigsRequest
options CallOptions
callback PaginationCallback<protos.google.privacy.dlp.v2.IListDiscoveryConfigsRequest, protos.google.privacy.dlp.v2.IListDiscoveryConfigsResponse | null | undefined, protos.google.privacy.dlp.v2.IDiscoveryConfig>
Returns
Type Description
void

listDiscoveryConfigs(request, callback)

listDiscoveryConfigs(request: protos.google.privacy.dlp.v2.IListDiscoveryConfigsRequest, callback: PaginationCallback<protos.google.privacy.dlp.v2.IListDiscoveryConfigsRequest, protos.google.privacy.dlp.v2.IListDiscoveryConfigsResponse | null | undefined, protos.google.privacy.dlp.v2.IDiscoveryConfig>): void;
Parameters
Name Description
request IListDiscoveryConfigsRequest
callback PaginationCallback<protos.google.privacy.dlp.v2.IListDiscoveryConfigsRequest, protos.google.privacy.dlp.v2.IListDiscoveryConfigsResponse | null | undefined, protos.google.privacy.dlp.v2.IDiscoveryConfig>
Returns
Type Description
void

listDiscoveryConfigsAsync(request, options)

listDiscoveryConfigsAsync(request?: protos.google.privacy.dlp.v2.IListDiscoveryConfigsRequest, options?: CallOptions): AsyncIterable<protos.google.privacy.dlp.v2.IDiscoveryConfig>;

Equivalent to listDiscoveryConfigs, but returns an iterable object.

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

Parameters
Name Description
request IListDiscoveryConfigsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.privacy.dlp.v2.IDiscoveryConfig>

{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. Parent resource name.
   *  The format of this value is as follows:
   *  `projects/{project_id}/locations/{location_id}`
   *  The following example `parent` string specifies a parent project with the
   *  identifier `example-project`, and specifies the `europe-west3` location
   *  for processing data:
   *      parent=projects/example-project/locations/europe-west3
   */
  // const parent = 'abc123'
  /**
   *  Page token to continue retrieval. Comes from the previous call
   *  to ListDiscoveryConfigs. `order_by` field must not
   *  change for subsequent calls.
   */
  // const pageToken = 'abc123'
  /**
   *  Size of the page. This value can be limited by a server.
   */
  // const pageSize = 1234
  /**
   *  Comma-separated list of config fields to order by,
   *  followed by `asc` or `desc` postfix. This list is case insensitive. The
   *  default sorting order is ascending. Redundant space characters are
   *  insignificant.
   *  Example: `name asc,update_time, create_time desc`
   *  Supported fields are:
   *  - `last_run_time`: corresponds to the last time the DiscoveryConfig ran.
   *  - `name`: corresponds to the DiscoveryConfig's name.
   *  - `status`: corresponds to DiscoveryConfig's status.
   */
  // const orderBy = 'abc123'

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

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

  callListDiscoveryConfigs();

listDiscoveryConfigsStream(request, options)

listDiscoveryConfigsStream(request?: protos.google.privacy.dlp.v2.IListDiscoveryConfigsRequest, options?: CallOptions): Transform;

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

Parameters
Name Description
request IListDiscoveryConfigsRequest

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

listDlpJobs(request, options)

listDlpJobs(request?: protos.google.privacy.dlp.v2.IListDlpJobsRequest, options?: CallOptions): Promise<[
        protos.google.privacy.dlp.v2.IDlpJob[],
        protos.google.privacy.dlp.v2.IListDlpJobsRequest | null,
        protos.google.privacy.dlp.v2.IListDlpJobsResponse
    ]>;
Parameters
Name Description
request IListDlpJobsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.privacy.dlp.v2.IDlpJob[], protos.google.privacy.dlp.v2.IListDlpJobsRequest | null, protos.google.privacy.dlp.v2.IListDlpJobsResponse ]>

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

listDlpJobs(request, options, callback)

listDlpJobs(request: protos.google.privacy.dlp.v2.IListDlpJobsRequest, options: CallOptions, callback: PaginationCallback<protos.google.privacy.dlp.v2.IListDlpJobsRequest, protos.google.privacy.dlp.v2.IListDlpJobsResponse | null | undefined, protos.google.privacy.dlp.v2.IDlpJob>): void;
Parameters
Name Description
request IListDlpJobsRequest
options CallOptions
callback PaginationCallback<protos.google.privacy.dlp.v2.IListDlpJobsRequest, protos.google.privacy.dlp.v2.IListDlpJobsResponse | null | undefined, protos.google.privacy.dlp.v2.IDlpJob>
Returns
Type Description
void

listDlpJobs(request, callback)

listDlpJobs(request: protos.google.privacy.dlp.v2.IListDlpJobsRequest, callback: PaginationCallback<protos.google.privacy.dlp.v2.IListDlpJobsRequest, protos.google.privacy.dlp.v2.IListDlpJobsResponse | null | undefined, protos.google.privacy.dlp.v2.IDlpJob>): void;
Parameters
Name Description
request IListDlpJobsRequest
callback PaginationCallback<protos.google.privacy.dlp.v2.IListDlpJobsRequest, protos.google.privacy.dlp.v2.IListDlpJobsResponse | null | undefined, protos.google.privacy.dlp.v2.IDlpJob>
Returns
Type Description
void

listDlpJobsAsync(request, options)

listDlpJobsAsync(request?: protos.google.privacy.dlp.v2.IListDlpJobsRequest, options?: CallOptions): AsyncIterable<protos.google.privacy.dlp.v2.IDlpJob>;

Equivalent to listDlpJobs, but returns an iterable object.

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

Parameters
Name Description
request IListDlpJobsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.privacy.dlp.v2.IDlpJob>

{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. Parent resource name.
   *  The format of this value varies depending on whether you have specified a
   *  processing
   *  location (https://cloud.google.com/sensitive-data-protection/docs/specifying-location):
   *  + Projects scope, location specified:
   *    `projects/{project_id}/locations/{location_id}`
   *  + Projects scope, no location specified (defaults to global):
   *    `projects/{project_id}`
   *  The following example `parent` string specifies a parent project with the
   *  identifier `example-project`, and specifies the `europe-west3` location
   *  for processing data:
   *      parent=projects/example-project/locations/europe-west3
   */
  // const parent = 'abc123'
  /**
   *  Allows filtering.
   *  Supported syntax:
   *  * Filter expressions are made up of one or more restrictions.
   *  * Restrictions can be combined by `AND` or `OR` logical operators. A
   *  sequence of restrictions implicitly uses `AND`.
   *  * A restriction has the form of `{field} {operator} {value}`.
   *  * Supported fields/values for inspect jobs:
   *      - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED
   *      - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY
   *      - `trigger_name` - The name of the trigger that created the job.
   *      - 'end_time` - Corresponds to the time the job finished.
   *      - 'start_time` - Corresponds to the time the job finished.
   *  * Supported fields for risk analysis jobs:
   *      - `state` - RUNNING|CANCELED|FINISHED|FAILED
   *      - 'end_time` - Corresponds to the time the job finished.
   *      - 'start_time` - Corresponds to the time the job finished.
   *  * The operator must be `=` or `!=`.
   *  Examples:
   *  * inspected_storage = cloud_storage AND state = done
   *  * inspected_storage = cloud_storage OR inspected_storage = bigquery
   *  * inspected_storage = cloud_storage AND (state = done OR state = canceled)
   *  * end_time > \"2017-12-12T00:00:00+00:00\"
   *  The length of this field should be no more than 500 characters.
   */
  // const filter = 'abc123'
  /**
   *  The standard list page size.
   */
  // const pageSize = 1234
  /**
   *  The standard list page token.
   */
  // const pageToken = 'abc123'
  /**
   *  The type of job. Defaults to `DlpJobType.INSPECT`
   */
  // const type = {}
  /**
   *  Comma-separated list of fields to order by,
   *  followed by `asc` or `desc` postfix. This list is case insensitive. The
   *  default sorting order is ascending. Redundant space characters are
   *  insignificant.
   *  Example: `name asc, end_time asc, create_time desc`
   *  Supported fields are:
   *  - `create_time`: corresponds to the time the job was created.
   *  - `end_time`: corresponds to the time the job ended.
   *  - `name`: corresponds to the job's name.
   *  - `state`: corresponds to `state`
   */
  // const orderBy = 'abc123'

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

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

  callListDlpJobs();

listDlpJobsStream(request, options)

listDlpJobsStream(request?: protos.google.privacy.dlp.v2.IListDlpJobsRequest, options?: CallOptions): Transform;

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

Parameters
Name Description
request IListDlpJobsRequest

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

listFileStoreDataProfiles(request, options)

listFileStoreDataProfiles(request?: protos.google.privacy.dlp.v2.IListFileStoreDataProfilesRequest, options?: CallOptions): Promise<[
        protos.google.privacy.dlp.v2.IFileStoreDataProfile[],
        protos.google.privacy.dlp.v2.IListFileStoreDataProfilesRequest | null,
        protos.google.privacy.dlp.v2.IListFileStoreDataProfilesResponse
    ]>;

Lists file store data profiles for an organization.

Parameters
Name Description
request IListFileStoreDataProfilesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.privacy.dlp.v2.IFileStoreDataProfile[], protos.google.privacy.dlp.v2.IListFileStoreDataProfilesRequest | null, protos.google.privacy.dlp.v2.IListFileStoreDataProfilesResponse ]>

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

listFileStoreDataProfiles(request, options, callback)

listFileStoreDataProfiles(request: protos.google.privacy.dlp.v2.IListFileStoreDataProfilesRequest, options: CallOptions, callback: PaginationCallback<protos.google.privacy.dlp.v2.IListFileStoreDataProfilesRequest, protos.google.privacy.dlp.v2.IListFileStoreDataProfilesResponse | null | undefined, protos.google.privacy.dlp.v2.IFileStoreDataProfile>): void;
Parameters
Name Description
request IListFileStoreDataProfilesRequest
options CallOptions
callback PaginationCallback<protos.google.privacy.dlp.v2.IListFileStoreDataProfilesRequest, protos.google.privacy.dlp.v2.IListFileStoreDataProfilesResponse | null | undefined, protos.google.privacy.dlp.v2.IFileStoreDataProfile>
Returns
Type Description
void

listFileStoreDataProfiles(request, callback)

listFileStoreDataProfiles(request: protos.google.privacy.dlp.v2.IListFileStoreDataProfilesRequest, callback: PaginationCallback<protos.google.privacy.dlp.v2.IListFileStoreDataProfilesRequest, protos.google.privacy.dlp.v2.IListFileStoreDataProfilesResponse | null | undefined, protos.google.privacy.dlp.v2.IFileStoreDataProfile>): void;
Parameters
Name Description
request IListFileStoreDataProfilesRequest
callback PaginationCallback<protos.google.privacy.dlp.v2.IListFileStoreDataProfilesRequest, protos.google.privacy.dlp.v2.IListFileStoreDataProfilesResponse | null | undefined, protos.google.privacy.dlp.v2.IFileStoreDataProfile>
Returns
Type Description
void

listFileStoreDataProfilesAsync(request, options)

listFileStoreDataProfilesAsync(request?: protos.google.privacy.dlp.v2.IListFileStoreDataProfilesRequest, options?: CallOptions): AsyncIterable<protos.google.privacy.dlp.v2.IFileStoreDataProfile>;

Equivalent to listFileStoreDataProfiles, but returns an iterable object.

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

Parameters
Name Description
request IListFileStoreDataProfilesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.privacy.dlp.v2.IFileStoreDataProfile>

{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. Resource name of the organization or project, for
   *  example `organizations/433245324/locations/europe` or
   *  `projects/project-id/locations/asia`.
   */
  // const parent = 'abc123'
  /**
   *  Optional. Page token to continue retrieval.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Size of the page. This value can be limited by the server. If
   *  zero, server returns a page of max size 100.
   */
  // const pageSize = 1234
  /**
   *  Optional. Comma-separated list of fields to order by, followed by `asc` or
   *  `desc` postfix. This list is case insensitive. The default sorting order is
   *  ascending. Redundant space characters are insignificant. Only one order
   *  field at a time is allowed.
   *  Examples:
   *  * `project_id asc`
   *  * `name`
   *  * `sensitivity_level desc`
   *  Supported fields are:
   *  - `project_id`: The Google Cloud project ID.
   *  - `sensitivity_level`: How sensitive the data in a table is, at most.
   *  - `data_risk_level`: How much risk is associated with this data.
   *  - `profile_last_generated`: When the profile was last updated in epoch
   *  seconds.
   *  - `last_modified`: The last time the resource was modified.
   *  - `resource_visibility`: Visibility restriction for this resource.
   *  - `name`: The name of the profile.
   *  - `create_time`: The time the file store was first created.
   */
  // const orderBy = 'abc123'
  /**
   *  Optional. Allows filtering.
   *  Supported syntax:
   *  * Filter expressions are made up of one or more restrictions.
   *  * Restrictions can be combined by `AND` or `OR` logical operators. A
   *  sequence of restrictions implicitly uses `AND`.
   *  * A restriction has the form of `{field} {operator} {value}`.
   *  * Supported fields/values:
   *      - `project_id` - The Google Cloud project ID.
   *      - `account_id` - The AWS account ID.
   *      - `file_store_path` - The path like "gs://bucket".
   *      - `data_source_type` - The profile's data source type, like
   *      "google/storage/bucket".
   *      - `data_storage_location` - The location where the file store's data is
   *      stored, like "us-central1".
   *      - `sensitivity_level` - HIGH|MODERATE|LOW
   *      - `data_risk_level` - HIGH|MODERATE|LOW
   *      - `resource_visibility`: PUBLIC|RESTRICTED
   *      - `status_code` - an RPC status code as defined in
   *      https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto
   *  * The operator must be `=` or `!=`.
   *  Examples:
   *  * `project_id = 12345 AND status_code = 1`
   *  * `project_id = 12345 AND sensitivity_level = HIGH`
   *  * `project_id = 12345 AND resource_visibility = PUBLIC`
   *  * `file_store_path = "gs://mybucket"`
   *  The length of this field should be no more than 500 characters.
   */
  // const filter = 'abc123'

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

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

  callListFileStoreDataProfiles();

listFileStoreDataProfilesStream(request, options)

listFileStoreDataProfilesStream(request?: protos.google.privacy.dlp.v2.IListFileStoreDataProfilesRequest, options?: CallOptions): Transform;

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

Parameters
Name Description
request IListFileStoreDataProfilesRequest

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

listInfoTypes(request, options)

listInfoTypes(request?: protos.google.privacy.dlp.v2.IListInfoTypesRequest, options?: CallOptions): Promise<[
        protos.google.privacy.dlp.v2.IListInfoTypesResponse,
        protos.google.privacy.dlp.v2.IListInfoTypesRequest | undefined,
        {} | undefined
    ]>;

Returns a list of the sensitive information types that DLP API supports. See https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference to learn more.

Parameters
Name Description
request IListInfoTypesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.privacy.dlp.v2.IListInfoTypesResponse, protos.google.privacy.dlp.v2.IListInfoTypesRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing ListInfoTypesResponse. 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.
   */
  /**
   *  The parent resource name.
   *  The format of this value is as follows:
   *      `locations/{location_id}`
   */
  // const parent = 'abc123'
  /**
   *  BCP-47 language code for localized infoType friendly
   *  names. If omitted, or if localized strings are not available,
   *  en-US strings will be returned.
   */
  // const languageCode = 'abc123'
  /**
   *  filter to only return infoTypes supported by certain parts of the
   *  API. Defaults to supported_by=INSPECT.
   */
  // const filter = 'abc123'

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

  async function callListInfoTypes() {
    // Construct request
    const request = {
    };

    // Run request
    const response = await dlpClient.listInfoTypes(request);
    console.log(response);
  }

  callListInfoTypes();

listInfoTypes(request, options, callback)

listInfoTypes(request: protos.google.privacy.dlp.v2.IListInfoTypesRequest, options: CallOptions, callback: Callback<protos.google.privacy.dlp.v2.IListInfoTypesResponse, protos.google.privacy.dlp.v2.IListInfoTypesRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IListInfoTypesRequest
options CallOptions
callback Callback<protos.google.privacy.dlp.v2.IListInfoTypesResponse, protos.google.privacy.dlp.v2.IListInfoTypesRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

listInfoTypes(request, callback)

listInfoTypes(request: protos.google.privacy.dlp.v2.IListInfoTypesRequest, callback: Callback<protos.google.privacy.dlp.v2.IListInfoTypesResponse, protos.google.privacy.dlp.v2.IListInfoTypesRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IListInfoTypesRequest
callback Callback<protos.google.privacy.dlp.v2.IListInfoTypesResponse, protos.google.privacy.dlp.v2.IListInfoTypesRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

listInspectTemplates(request, options)

listInspectTemplates(request?: protos.google.privacy.dlp.v2.IListInspectTemplatesRequest, options?: CallOptions): Promise<[
        protos.google.privacy.dlp.v2.IInspectTemplate[],
        protos.google.privacy.dlp.v2.IListInspectTemplatesRequest | null,
        protos.google.privacy.dlp.v2.IListInspectTemplatesResponse
    ]>;
Parameters
Name Description
request IListInspectTemplatesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.privacy.dlp.v2.IInspectTemplate[], protos.google.privacy.dlp.v2.IListInspectTemplatesRequest | null, protos.google.privacy.dlp.v2.IListInspectTemplatesResponse ]>

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

listInspectTemplates(request, options, callback)

listInspectTemplates(request: protos.google.privacy.dlp.v2.IListInspectTemplatesRequest, options: CallOptions, callback: PaginationCallback<protos.google.privacy.dlp.v2.IListInspectTemplatesRequest, protos.google.privacy.dlp.v2.IListInspectTemplatesResponse | null | undefined, protos.google.privacy.dlp.v2.IInspectTemplate>): void;
Parameters
Name Description
request IListInspectTemplatesRequest
options CallOptions
callback PaginationCallback<protos.google.privacy.dlp.v2.IListInspectTemplatesRequest, protos.google.privacy.dlp.v2.IListInspectTemplatesResponse | null | undefined, protos.google.privacy.dlp.v2.IInspectTemplate>
Returns
Type Description
void

listInspectTemplates(request, callback)

listInspectTemplates(request: protos.google.privacy.dlp.v2.IListInspectTemplatesRequest, callback: PaginationCallback<protos.google.privacy.dlp.v2.IListInspectTemplatesRequest, protos.google.privacy.dlp.v2.IListInspectTemplatesResponse | null | undefined, protos.google.privacy.dlp.v2.IInspectTemplate>): void;
Parameters
Name Description
request IListInspectTemplatesRequest
callback PaginationCallback<protos.google.privacy.dlp.v2.IListInspectTemplatesRequest, protos.google.privacy.dlp.v2.IListInspectTemplatesResponse | null | undefined, protos.google.privacy.dlp.v2.IInspectTemplate>
Returns
Type Description
void

listInspectTemplatesAsync(request, options)

listInspectTemplatesAsync(request?: protos.google.privacy.dlp.v2.IListInspectTemplatesRequest, options?: CallOptions): AsyncIterable<protos.google.privacy.dlp.v2.IInspectTemplate>;

Equivalent to listInspectTemplates, but returns an iterable object.

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

Parameters
Name Description
request IListInspectTemplatesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.privacy.dlp.v2.IInspectTemplate>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing InspectTemplate. 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. Parent resource name.
   *  The format of this value varies depending on the scope of the request
   *  (project or organization) and whether you have specified a processing
   *  location (https://cloud.google.com/sensitive-data-protection/docs/specifying-location):
   *  + Projects scope, location specified:
   *    `projects/{project_id}/locations/{location_id}`
   *  + Projects scope, no location specified (defaults to global):
   *    `projects/{project_id}`
   *  + Organizations scope, location specified:
   *    `organizations/{org_id}/locations/{location_id}`
   *  + Organizations scope, no location specified (defaults to global):
   *    `organizations/{org_id}`
   *  The following example `parent` string specifies a parent project with the
   *  identifier `example-project`, and specifies the `europe-west3` location
   *  for processing data:
   *      parent=projects/example-project/locations/europe-west3
   */
  // const parent = 'abc123'
  /**
   *  Page token to continue retrieval. Comes from the previous call
   *  to `ListInspectTemplates`.
   */
  // const pageToken = 'abc123'
  /**
   *  Size of the page. This value can be limited by the server. If zero server
   *  returns a page of max size 100.
   */
  // const pageSize = 1234
  /**
   *  Comma-separated list of fields to order by,
   *  followed by `asc` or `desc` postfix. This list is case insensitive. The
   *  default sorting order is ascending. Redundant space characters are
   *  insignificant.
   *  Example: `name asc,update_time, create_time desc`
   *  Supported fields are:
   *  - `create_time`: corresponds to the time the template was created.
   *  - `update_time`: corresponds to the time the template was last updated.
   *  - `name`: corresponds to the template's name.
   *  - `display_name`: corresponds to the template's display name.
   */
  // const orderBy = 'abc123'

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

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

  callListInspectTemplates();

listInspectTemplatesStream(request, options)

listInspectTemplatesStream(request?: protos.google.privacy.dlp.v2.IListInspectTemplatesRequest, options?: CallOptions): Transform;

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

Parameters
Name Description
request IListInspectTemplatesRequest

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

listJobTriggers(request, options)

listJobTriggers(request?: protos.google.privacy.dlp.v2.IListJobTriggersRequest, options?: CallOptions): Promise<[
        protos.google.privacy.dlp.v2.IJobTrigger[],
        protos.google.privacy.dlp.v2.IListJobTriggersRequest | null,
        protos.google.privacy.dlp.v2.IListJobTriggersResponse
    ]>;
Parameters
Name Description
request IListJobTriggersRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.privacy.dlp.v2.IJobTrigger[], protos.google.privacy.dlp.v2.IListJobTriggersRequest | null, protos.google.privacy.dlp.v2.IListJobTriggersResponse ]>

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

listJobTriggers(request, options, callback)

listJobTriggers(request: protos.google.privacy.dlp.v2.IListJobTriggersRequest, options: CallOptions, callback: PaginationCallback<protos.google.privacy.dlp.v2.IListJobTriggersRequest, protos.google.privacy.dlp.v2.IListJobTriggersResponse | null | undefined, protos.google.privacy.dlp.v2.IJobTrigger>): void;
Parameters
Name Description
request IListJobTriggersRequest
options CallOptions
callback PaginationCallback<protos.google.privacy.dlp.v2.IListJobTriggersRequest, protos.google.privacy.dlp.v2.IListJobTriggersResponse | null | undefined, protos.google.privacy.dlp.v2.IJobTrigger>
Returns
Type Description
void

listJobTriggers(request, callback)

listJobTriggers(request: protos.google.privacy.dlp.v2.IListJobTriggersRequest, callback: PaginationCallback<protos.google.privacy.dlp.v2.IListJobTriggersRequest, protos.google.privacy.dlp.v2.IListJobTriggersResponse | null | undefined, protos.google.privacy.dlp.v2.IJobTrigger>): void;
Parameters
Name Description
request IListJobTriggersRequest
callback PaginationCallback<protos.google.privacy.dlp.v2.IListJobTriggersRequest, protos.google.privacy.dlp.v2.IListJobTriggersResponse | null | undefined, protos.google.privacy.dlp.v2.IJobTrigger>
Returns
Type Description
void

listJobTriggersAsync(request, options)

listJobTriggersAsync(request?: protos.google.privacy.dlp.v2.IListJobTriggersRequest, options?: CallOptions): AsyncIterable<protos.google.privacy.dlp.v2.IJobTrigger>;

Equivalent to listJobTriggers, but returns an iterable object.

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

Parameters
Name Description
request IListJobTriggersRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.privacy.dlp.v2.IJobTrigger>

{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. Parent resource name.
   *  The format of this value varies depending on whether you have specified a
   *  processing
   *  location (https://cloud.google.com/sensitive-data-protection/docs/specifying-location):
   *  + Projects scope, location specified:
   *    `projects/{project_id}/locations/{location_id}`
   *  + Projects scope, no location specified (defaults to global):
   *    `projects/{project_id}`
   *  The following example `parent` string specifies a parent project with the
   *  identifier `example-project`, and specifies the `europe-west3` location
   *  for processing data:
   *      parent=projects/example-project/locations/europe-west3
   */
  // const parent = 'abc123'
  /**
   *  Page token to continue retrieval. Comes from the previous call
   *  to ListJobTriggers. `order_by` field must not
   *  change for subsequent calls.
   */
  // const pageToken = 'abc123'
  /**
   *  Size of the page. This value can be limited by a server.
   */
  // const pageSize = 1234
  /**
   *  Comma-separated list of triggeredJob fields to order by,
   *  followed by `asc` or `desc` postfix. This list is case insensitive. The
   *  default sorting order is ascending. Redundant space characters are
   *  insignificant.
   *  Example: `name asc,update_time, create_time desc`
   *  Supported fields are:
   *  - `create_time`: corresponds to the time the JobTrigger was created.
   *  - `update_time`: corresponds to the time the JobTrigger was last updated.
   *  - `last_run_time`: corresponds to the last time the JobTrigger ran.
   *  - `name`: corresponds to the JobTrigger's name.
   *  - `display_name`: corresponds to the JobTrigger's display name.
   *  - `status`: corresponds to JobTrigger's status.
   */
  // const orderBy = 'abc123'
  /**
   *  Allows filtering.
   *  Supported syntax:
   *  * Filter expressions are made up of one or more restrictions.
   *  * Restrictions can be combined by `AND` or `OR` logical operators. A
   *  sequence of restrictions implicitly uses `AND`.
   *  * A restriction has the form of `{field} {operator} {value}`.
   *  * Supported fields/values for inspect triggers:
   *      - `status` - HEALTHY|PAUSED|CANCELLED
   *      - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY
   *      - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by
   *      quotation marks. Nanoseconds are ignored.
   *      - 'error_count' - Number of errors that have occurred while running.
   *  * The operator must be `=` or `!=` for status and inspected_storage.
   *  Examples:
   *  * inspected_storage = cloud_storage AND status = HEALTHY
   *  * inspected_storage = cloud_storage OR inspected_storage = bigquery
   *  * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY)
   *  * last_run_time > \"2017-12-12T00:00:00+00:00\"
   *  The length of this field should be no more than 500 characters.
   */
  // const filter = 'abc123'
  /**
   *  The type of jobs. Will use `DlpJobType.INSPECT` if not set.
   */
  // const type = {}

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

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

  callListJobTriggers();

listJobTriggersStream(request, options)

listJobTriggersStream(request?: protos.google.privacy.dlp.v2.IListJobTriggersRequest, options?: CallOptions): Transform;

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

Parameters
Name Description
request IListJobTriggersRequest

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 listJobTriggersAsync() 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
}

listProjectDataProfiles(request, options)

listProjectDataProfiles(request?: protos.google.privacy.dlp.v2.IListProjectDataProfilesRequest, options?: CallOptions): Promise<[
        protos.google.privacy.dlp.v2.IProjectDataProfile[],
        protos.google.privacy.dlp.v2.IListProjectDataProfilesRequest | null,
        protos.google.privacy.dlp.v2.IListProjectDataProfilesResponse
    ]>;

Lists project data profiles for an organization.

Parameters
Name Description
request IListProjectDataProfilesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.privacy.dlp.v2.IProjectDataProfile[], protos.google.privacy.dlp.v2.IListProjectDataProfilesRequest | null, protos.google.privacy.dlp.v2.IListProjectDataProfilesResponse ]>

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

listProjectDataProfiles(request, options, callback)

listProjectDataProfiles(request: protos.google.privacy.dlp.v2.IListProjectDataProfilesRequest, options: CallOptions, callback: PaginationCallback<protos.google.privacy.dlp.v2.IListProjectDataProfilesRequest, protos.google.privacy.dlp.v2.IListProjectDataProfilesResponse | null | undefined, protos.google.privacy.dlp.v2.IProjectDataProfile>): void;
Parameters
Name Description
request IListProjectDataProfilesRequest
options CallOptions
callback PaginationCallback<protos.google.privacy.dlp.v2.IListProjectDataProfilesRequest, protos.google.privacy.dlp.v2.IListProjectDataProfilesResponse | null | undefined, protos.google.privacy.dlp.v2.IProjectDataProfile>
Returns
Type Description
void

listProjectDataProfiles(request, callback)

listProjectDataProfiles(request: protos.google.privacy.dlp.v2.IListProjectDataProfilesRequest, callback: PaginationCallback<protos.google.privacy.dlp.v2.IListProjectDataProfilesRequest, protos.google.privacy.dlp.v2.IListProjectDataProfilesResponse | null | undefined, protos.google.privacy.dlp.v2.IProjectDataProfile>): void;
Parameters
Name Description
request IListProjectDataProfilesRequest
callback PaginationCallback<protos.google.privacy.dlp.v2.IListProjectDataProfilesRequest, protos.google.privacy.dlp.v2.IListProjectDataProfilesResponse | null | undefined, protos.google.privacy.dlp.v2.IProjectDataProfile>
Returns
Type Description
void

listProjectDataProfilesAsync(request, options)

listProjectDataProfilesAsync(request?: protos.google.privacy.dlp.v2.IListProjectDataProfilesRequest, options?: CallOptions): AsyncIterable<protos.google.privacy.dlp.v2.IProjectDataProfile>;

Equivalent to listProjectDataProfiles, but returns an iterable object.

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

Parameters
Name Description
request IListProjectDataProfilesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.privacy.dlp.v2.IProjectDataProfile>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing ProjectDataProfile. 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. organizations/{org_id}/locations/{loc_id}
   */
  // const parent = 'abc123'
  /**
   *  Page token to continue retrieval.
   */
  // const pageToken = 'abc123'
  /**
   *  Size of the page. This value can be limited by the server. If zero, server
   *  returns a page of max size 100.
   */
  // const pageSize = 1234
  /**
   *  Comma-separated list of fields to order by, followed by `asc` or `desc`
   *  postfix. This list is case insensitive. The default sorting order is
   *  ascending. Redundant space characters are insignificant. Only one order
   *  field at a time is allowed.
   *  Examples:
   *  * `project_id`
   *  * `sensitivity_level desc`
   *  Supported fields are:
   *  - `project_id`: Google Cloud project ID
   *  - `sensitivity_level`: How sensitive the data in a project is, at most.
   *  - `data_risk_level`: How much risk is associated with this data.
   *  - `profile_last_generated`: When the profile was last updated in epoch
   *  seconds.
   */
  // const orderBy = 'abc123'
  /**
   *  Allows filtering.
   *  Supported syntax:
   *  * Filter expressions are made up of one or more restrictions.
   *  * Restrictions can be combined by `AND` or `OR` logical operators. A
   *  sequence of restrictions implicitly uses `AND`.
   *  * A restriction has the form of `{field} {operator} {value}`.
   *  * Supported fields/values:
   *      - `sensitivity_level` - HIGH|MODERATE|LOW
   *      - `data_risk_level` - HIGH|MODERATE|LOW
   *      - `status_code` - an RPC status code as defined in
   *      https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto
   *  * The operator must be `=` or `!=`.
   *  Examples:
   *  * `project_id = 12345 AND status_code = 1`
   *  * `project_id = 12345 AND sensitivity_level = HIGH`
   *  The length of this field should be no more than 500 characters.
   */
  // const filter = 'abc123'

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

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

  callListProjectDataProfiles();

listProjectDataProfilesStream(request, options)

listProjectDataProfilesStream(request?: protos.google.privacy.dlp.v2.IListProjectDataProfilesRequest, options?: CallOptions): Transform;

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

Parameters
Name Description
request IListProjectDataProfilesRequest

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

listStoredInfoTypes(request, options)

listStoredInfoTypes(request?: protos.google.privacy.dlp.v2.IListStoredInfoTypesRequest, options?: CallOptions): Promise<[
        protos.google.privacy.dlp.v2.IStoredInfoType[],
        protos.google.privacy.dlp.v2.IListStoredInfoTypesRequest | null,
        protos.google.privacy.dlp.v2.IListStoredInfoTypesResponse
    ]>;
Parameters
Name Description
request IListStoredInfoTypesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.privacy.dlp.v2.IStoredInfoType[], protos.google.privacy.dlp.v2.IListStoredInfoTypesRequest | null, protos.google.privacy.dlp.v2.IListStoredInfoTypesResponse ]>

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

listStoredInfoTypes(request, options, callback)

listStoredInfoTypes(request: protos.google.privacy.dlp.v2.IListStoredInfoTypesRequest, options: CallOptions, callback: PaginationCallback<protos.google.privacy.dlp.v2.IListStoredInfoTypesRequest, protos.google.privacy.dlp.v2.IListStoredInfoTypesResponse | null | undefined, protos.google.privacy.dlp.v2.IStoredInfoType>): void;
Parameters
Name Description
request IListStoredInfoTypesRequest
options CallOptions
callback PaginationCallback<protos.google.privacy.dlp.v2.IListStoredInfoTypesRequest, protos.google.privacy.dlp.v2.IListStoredInfoTypesResponse | null | undefined, protos.google.privacy.dlp.v2.IStoredInfoType>
Returns
Type Description
void

listStoredInfoTypes(request, callback)

listStoredInfoTypes(request: protos.google.privacy.dlp.v2.IListStoredInfoTypesRequest, callback: PaginationCallback<protos.google.privacy.dlp.v2.IListStoredInfoTypesRequest, protos.google.privacy.dlp.v2.IListStoredInfoTypesResponse | null | undefined, protos.google.privacy.dlp.v2.IStoredInfoType>): void;
Parameters
Name Description
request IListStoredInfoTypesRequest
callback PaginationCallback<protos.google.privacy.dlp.v2.IListStoredInfoTypesRequest, protos.google.privacy.dlp.v2.IListStoredInfoTypesResponse | null | undefined, protos.google.privacy.dlp.v2.IStoredInfoType>
Returns
Type Description
void

listStoredInfoTypesAsync(request, options)

listStoredInfoTypesAsync(request?: protos.google.privacy.dlp.v2.IListStoredInfoTypesRequest, options?: CallOptions): AsyncIterable<protos.google.privacy.dlp.v2.IStoredInfoType>;

Equivalent to listStoredInfoTypes, but returns an iterable object.

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

Parameters
Name Description
request IListStoredInfoTypesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.privacy.dlp.v2.IStoredInfoType>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing StoredInfoType. 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. Parent resource name.
   *  The format of this value varies depending on the scope of the request
   *  (project or organization) and whether you have specified a processing
   *  location (https://cloud.google.com/sensitive-data-protection/docs/specifying-location):
   *  + Projects scope, location specified:
   *    `projects/{project_id}/locations/{location_id}`
   *  + Projects scope, no location specified (defaults to global):
   *    `projects/{project_id}`
   *  The following example `parent` string specifies a parent project with the
   *  identifier `example-project`, and specifies the `europe-west3` location
   *  for processing data:
   *      parent=projects/example-project/locations/europe-west3
   */
  // const parent = 'abc123'
  /**
   *  Page token to continue retrieval. Comes from the previous call
   *  to `ListStoredInfoTypes`.
   */
  // const pageToken = 'abc123'
  /**
   *  Size of the page. This value can be limited by the server. If zero server
   *  returns a page of max size 100.
   */
  // const pageSize = 1234
  /**
   *  Comma-separated list of fields to order by,
   *  followed by `asc` or `desc` postfix. This list is case insensitive. The
   *  default sorting order is ascending. Redundant space characters are
   *  insignificant.
   *  Example: `name asc, display_name, create_time desc`
   *  Supported fields are:
   *  - `create_time`: corresponds to the time the most recent version of the
   *  resource was created.
   *  - `state`: corresponds to the state of the resource.
   *  - `name`: corresponds to resource name.
   *  - `display_name`: corresponds to info type's display name.
   */
  // const orderBy = 'abc123'

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

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

  callListStoredInfoTypes();

listStoredInfoTypesStream(request, options)

listStoredInfoTypesStream(request?: protos.google.privacy.dlp.v2.IListStoredInfoTypesRequest, options?: CallOptions): Transform;

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

Parameters
Name Description
request IListStoredInfoTypesRequest

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

listTableDataProfiles(request, options)

listTableDataProfiles(request?: protos.google.privacy.dlp.v2.IListTableDataProfilesRequest, options?: CallOptions): Promise<[
        protos.google.privacy.dlp.v2.ITableDataProfile[],
        protos.google.privacy.dlp.v2.IListTableDataProfilesRequest | null,
        protos.google.privacy.dlp.v2.IListTableDataProfilesResponse
    ]>;

Lists table data profiles for an organization.

Parameters
Name Description
request IListTableDataProfilesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.privacy.dlp.v2.ITableDataProfile[], protos.google.privacy.dlp.v2.IListTableDataProfilesRequest | null, protos.google.privacy.dlp.v2.IListTableDataProfilesResponse ]>

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

listTableDataProfiles(request, options, callback)

listTableDataProfiles(request: protos.google.privacy.dlp.v2.IListTableDataProfilesRequest, options: CallOptions, callback: PaginationCallback<protos.google.privacy.dlp.v2.IListTableDataProfilesRequest, protos.google.privacy.dlp.v2.IListTableDataProfilesResponse | null | undefined, protos.google.privacy.dlp.v2.ITableDataProfile>): void;
Parameters
Name Description
request IListTableDataProfilesRequest
options CallOptions
callback PaginationCallback<protos.google.privacy.dlp.v2.IListTableDataProfilesRequest, protos.google.privacy.dlp.v2.IListTableDataProfilesResponse | null | undefined, protos.google.privacy.dlp.v2.ITableDataProfile>
Returns
Type Description
void

listTableDataProfiles(request, callback)

listTableDataProfiles(request: protos.google.privacy.dlp.v2.IListTableDataProfilesRequest, callback: PaginationCallback<protos.google.privacy.dlp.v2.IListTableDataProfilesRequest, protos.google.privacy.dlp.v2.IListTableDataProfilesResponse | null | undefined, protos.google.privacy.dlp.v2.ITableDataProfile>): void;
Parameters
Name Description
request IListTableDataProfilesRequest
callback PaginationCallback<protos.google.privacy.dlp.v2.IListTableDataProfilesRequest, protos.google.privacy.dlp.v2.IListTableDataProfilesResponse | null | undefined, protos.google.privacy.dlp.v2.ITableDataProfile>
Returns
Type Description
void

listTableDataProfilesAsync(request, options)

listTableDataProfilesAsync(request?: protos.google.privacy.dlp.v2.IListTableDataProfilesRequest, options?: CallOptions): AsyncIterable<protos.google.privacy.dlp.v2.ITableDataProfile>;

Equivalent to listTableDataProfiles, but returns an iterable object.

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

Parameters
Name Description
request IListTableDataProfilesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.privacy.dlp.v2.ITableDataProfile>

{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. Resource name of the organization or project, for
   *  example `organizations/433245324/locations/europe` or
   *  `projects/project-id/locations/asia`.
   */
  // const parent = 'abc123'
  /**
   *  Page token to continue retrieval.
   */
  // const pageToken = 'abc123'
  /**
   *  Size of the page. This value can be limited by the server. If zero, server
   *  returns a page of max size 100.
   */
  // const pageSize = 1234
  /**
   *  Comma-separated list of fields to order by, followed by `asc` or `desc`
   *  postfix. This list is case insensitive. The default sorting order is
   *  ascending. Redundant space characters are insignificant. Only one order
   *  field at a time is allowed.
   *  Examples:
   *  * `project_id asc`
   *  * `table_id`
   *  * `sensitivity_level desc`
   *  Supported fields are:
   *  - `project_id`: The Google Cloud project ID.
   *  - `dataset_id`: The ID of a BigQuery dataset.
   *  - `table_id`: The ID of a BigQuery table.
   *  - `sensitivity_level`: How sensitive the data in a table is, at most.
   *  - `data_risk_level`: How much risk is associated with this data.
   *  - `profile_last_generated`: When the profile was last updated in epoch
   *  seconds.
   *  - `last_modified`: The last time the resource was modified.
   *  - `resource_visibility`: Visibility restriction for this resource.
   *  - `row_count`: Number of rows in this resource.
   */
  // const orderBy = 'abc123'
  /**
   *  Allows filtering.
   *  Supported syntax:
   *  * Filter expressions are made up of one or more restrictions.
   *  * Restrictions can be combined by `AND` or `OR` logical operators. A
   *  sequence of restrictions implicitly uses `AND`.
   *  * A restriction has the form of `{field} {operator} {value}`.
   *  * Supported fields/values:
   *      - `project_id` - The Google Cloud project ID.
   *      - `dataset_id` - The BigQuery dataset ID.
   *      - `table_id` - The ID of the BigQuery table.
   *      - `sensitivity_level` - HIGH|MODERATE|LOW
   *      - `data_risk_level` - HIGH|MODERATE|LOW
   *      - `resource_visibility`: PUBLIC|RESTRICTED
   *      - `status_code` - an RPC status code as defined in
   *      https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto
   *  * The operator must be `=` or `!=`.
   *  Examples:
   *  * `project_id = 12345 AND status_code = 1`
   *  * `project_id = 12345 AND sensitivity_level = HIGH`
   *  * `project_id = 12345 AND resource_visibility = PUBLIC`
   *  The length of this field should be no more than 500 characters.
   */
  // const filter = 'abc123'

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

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

  callListTableDataProfiles();

listTableDataProfilesStream(request, options)

listTableDataProfilesStream(request?: protos.google.privacy.dlp.v2.IListTableDataProfilesRequest, options?: CallOptions): Transform;

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

Parameters
Name Description
request IListTableDataProfilesRequest

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

locationPath(project, location)

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

Return a fully-qualified location resource name string.

Parameters
Name Description
project string
location string
Returns
Type Description
string

{string} Resource name string.

matchColumnDataProfileFromOrganizationLocationColumnDataProfileName(organizationLocationColumnDataProfileName)

matchColumnDataProfileFromOrganizationLocationColumnDataProfileName(organizationLocationColumnDataProfileName: string): string | number;

Parse the column_data_profile from OrganizationLocationColumnDataProfile resource.

Parameter
Name Description
organizationLocationColumnDataProfileName string

A fully-qualified path representing organization_location_column_data_profile resource.

Returns
Type Description
string | number

{string} A string representing the column_data_profile.

matchColumnDataProfileFromProjectLocationColumnDataProfileName(projectLocationColumnDataProfileName)

matchColumnDataProfileFromProjectLocationColumnDataProfileName(projectLocationColumnDataProfileName: string): string | number;

Parse the column_data_profile from ProjectLocationColumnDataProfile resource.

Parameter
Name Description
projectLocationColumnDataProfileName string

A fully-qualified path representing project_location_column_data_profile resource.

Returns
Type Description
string | number

{string} A string representing the column_data_profile.

matchConnectionFromOrganizationLocationConnectionName(organizationLocationConnectionName)

matchConnectionFromOrganizationLocationConnectionName(organizationLocationConnectionName: string): string | number;

Parse the connection from OrganizationLocationConnection resource.

Parameter
Name Description
organizationLocationConnectionName string

A fully-qualified path representing organization_location_connection resource.

Returns
Type Description
string | number

{string} A string representing the connection.

matchConnectionFromProjectLocationConnectionName(projectLocationConnectionName)

matchConnectionFromProjectLocationConnectionName(projectLocationConnectionName: string): string | number;

Parse the connection from ProjectLocationConnection resource.

Parameter
Name Description
projectLocationConnectionName string

A fully-qualified path representing project_location_connection resource.

Returns
Type Description
string | number

{string} A string representing the connection.

matchDeidentifyTemplateFromOrganizationDeidentifyTemplateName(organizationDeidentifyTemplateName)

matchDeidentifyTemplateFromOrganizationDeidentifyTemplateName(organizationDeidentifyTemplateName: string): string | number;

Parse the deidentify_template from OrganizationDeidentifyTemplate resource.

Parameter
Name Description
organizationDeidentifyTemplateName string

A fully-qualified path representing organization_deidentify_template resource.

Returns
Type Description
string | number

{string} A string representing the deidentify_template.

matchDeidentifyTemplateFromOrganizationLocationDeidentifyTemplateName(organizationLocationDeidentifyTemplateName)

matchDeidentifyTemplateFromOrganizationLocationDeidentifyTemplateName(organizationLocationDeidentifyTemplateName: string): string | number;

Parse the deidentify_template from OrganizationLocationDeidentifyTemplate resource.

Parameter
Name Description
organizationLocationDeidentifyTemplateName string

A fully-qualified path representing organization_location_deidentify_template resource.

Returns
Type Description
string | number

{string} A string representing the deidentify_template.

matchDeidentifyTemplateFromProjectDeidentifyTemplateName(projectDeidentifyTemplateName)

matchDeidentifyTemplateFromProjectDeidentifyTemplateName(projectDeidentifyTemplateName: string): string | number;

Parse the deidentify_template from ProjectDeidentifyTemplate resource.

Parameter
Name Description
projectDeidentifyTemplateName string

A fully-qualified path representing project_deidentify_template resource.

Returns
Type Description
string | number

{string} A string representing the deidentify_template.

matchDeidentifyTemplateFromProjectLocationDeidentifyTemplateName(projectLocationDeidentifyTemplateName)

matchDeidentifyTemplateFromProjectLocationDeidentifyTemplateName(projectLocationDeidentifyTemplateName: string): string | number;

Parse the deidentify_template from ProjectLocationDeidentifyTemplate resource.

Parameter
Name Description
projectLocationDeidentifyTemplateName string

A fully-qualified path representing project_location_deidentify_template resource.

Returns
Type Description
string | number

{string} A string representing the deidentify_template.

matchDiscoveryConfigFromDiscoveryConfigName(discoveryConfigName)

matchDiscoveryConfigFromDiscoveryConfigName(discoveryConfigName: string): string | number;

Parse the discovery_config from DiscoveryConfig resource.

Parameter
Name Description
discoveryConfigName string

A fully-qualified path representing DiscoveryConfig resource.

Returns
Type Description
string | number

{string} A string representing the discovery_config.

matchDlpJobFromProjectDlpJobName(projectDlpJobName)

matchDlpJobFromProjectDlpJobName(projectDlpJobName: string): string | number;

Parse the dlp_job from ProjectDlpJob resource.

Parameter
Name Description
projectDlpJobName string

A fully-qualified path representing project_dlp_job resource.

Returns
Type Description
string | number

{string} A string representing the dlp_job.

matchDlpJobFromProjectLocationDlpJobName(projectLocationDlpJobName)

matchDlpJobFromProjectLocationDlpJobName(projectLocationDlpJobName: string): string | number;

Parse the dlp_job from ProjectLocationDlpJob resource.

Parameter
Name Description
projectLocationDlpJobName string

A fully-qualified path representing project_location_dlp_job resource.

Returns
Type Description
string | number

{string} A string representing the dlp_job.

matchFileStoreDataProfileFromOrganizationLocationFileStoreDataProfileName(organizationLocationFileStoreDataProfileName)

matchFileStoreDataProfileFromOrganizationLocationFileStoreDataProfileName(organizationLocationFileStoreDataProfileName: string): string | number;

Parse the file_store_data_profile from OrganizationLocationFileStoreDataProfile resource.

Parameter
Name Description
organizationLocationFileStoreDataProfileName string

A fully-qualified path representing organization_location_file_store_data_profile resource.

Returns
Type Description
string | number

{string} A string representing the file_store_data_profile.

matchFileStoreDataProfileFromProjectLocationFileStoreDataProfileName(projectLocationFileStoreDataProfileName)

matchFileStoreDataProfileFromProjectLocationFileStoreDataProfileName(projectLocationFileStoreDataProfileName: string): string | number;

Parse the file_store_data_profile from ProjectLocationFileStoreDataProfile resource.

Parameter
Name Description
projectLocationFileStoreDataProfileName string

A fully-qualified path representing project_location_file_store_data_profile resource.

Returns
Type Description
string | number

{string} A string representing the file_store_data_profile.

matchFindingFromFindingName(findingName)

matchFindingFromFindingName(findingName: string): string | number;

Parse the finding from Finding resource.

Parameter
Name Description
findingName string

A fully-qualified path representing Finding resource.

Returns
Type Description
string | number

{string} A string representing the finding.

matchInspectTemplateFromOrganizationInspectTemplateName(organizationInspectTemplateName)

matchInspectTemplateFromOrganizationInspectTemplateName(organizationInspectTemplateName: string): string | number;

Parse the inspect_template from OrganizationInspectTemplate resource.

Parameter
Name Description
organizationInspectTemplateName string

A fully-qualified path representing organization_inspect_template resource.

Returns
Type Description
string | number

{string} A string representing the inspect_template.

matchInspectTemplateFromOrganizationLocationInspectTemplateName(organizationLocationInspectTemplateName)

matchInspectTemplateFromOrganizationLocationInspectTemplateName(organizationLocationInspectTemplateName: string): string | number;

Parse the inspect_template from OrganizationLocationInspectTemplate resource.

Parameter
Name Description
organizationLocationInspectTemplateName string

A fully-qualified path representing organization_location_inspect_template resource.

Returns
Type Description
string | number

{string} A string representing the inspect_template.

matchInspectTemplateFromProjectInspectTemplateName(projectInspectTemplateName)

matchInspectTemplateFromProjectInspectTemplateName(projectInspectTemplateName: string): string | number;

Parse the inspect_template from ProjectInspectTemplate resource.

Parameter
Name Description
projectInspectTemplateName string

A fully-qualified path representing project_inspect_template resource.

Returns
Type Description
string | number

{string} A string representing the inspect_template.

matchInspectTemplateFromProjectLocationInspectTemplateName(projectLocationInspectTemplateName)

matchInspectTemplateFromProjectLocationInspectTemplateName(projectLocationInspectTemplateName: string): string | number;

Parse the inspect_template from ProjectLocationInspectTemplate resource.

Parameter
Name Description
projectLocationInspectTemplateName string

A fully-qualified path representing project_location_inspect_template resource.

Returns
Type Description
string | number

{string} A string representing the inspect_template.

matchJobTriggerFromProjectJobTriggerName(projectJobTriggerName)

matchJobTriggerFromProjectJobTriggerName(projectJobTriggerName: string): string | number;

Parse the job_trigger from ProjectJobTrigger resource.

Parameter
Name Description
projectJobTriggerName string

A fully-qualified path representing project_job_trigger resource.

Returns
Type Description
string | number

{string} A string representing the job_trigger.

matchJobTriggerFromProjectLocationJobTriggerName(projectLocationJobTriggerName)

matchJobTriggerFromProjectLocationJobTriggerName(projectLocationJobTriggerName: string): string | number;

Parse the job_trigger from ProjectLocationJobTrigger resource.

Parameter
Name Description
projectLocationJobTriggerName string

A fully-qualified path representing project_location_job_trigger resource.

Returns
Type Description
string | number

{string} A string representing the job_trigger.

matchLocationFromDiscoveryConfigName(discoveryConfigName)

matchLocationFromDiscoveryConfigName(discoveryConfigName: string): string | number;

Parse the location from DiscoveryConfig resource.

Parameter
Name Description
discoveryConfigName string

A fully-qualified path representing DiscoveryConfig resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromFindingName(findingName)

matchLocationFromFindingName(findingName: string): string | number;

Parse the location from Finding resource.

Parameter
Name Description
findingName string

A fully-qualified path representing Finding resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter
Name Description
locationName string

A fully-qualified path representing Location resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromOrganizationLocationColumnDataProfileName(organizationLocationColumnDataProfileName)

matchLocationFromOrganizationLocationColumnDataProfileName(organizationLocationColumnDataProfileName: string): string | number;

Parse the location from OrganizationLocationColumnDataProfile resource.

Parameter
Name Description
organizationLocationColumnDataProfileName string

A fully-qualified path representing organization_location_column_data_profile resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromOrganizationLocationConnectionName(organizationLocationConnectionName)

matchLocationFromOrganizationLocationConnectionName(organizationLocationConnectionName: string): string | number;

Parse the location from OrganizationLocationConnection resource.

Parameter
Name Description
organizationLocationConnectionName string

A fully-qualified path representing organization_location_connection resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromOrganizationLocationDeidentifyTemplateName(organizationLocationDeidentifyTemplateName)

matchLocationFromOrganizationLocationDeidentifyTemplateName(organizationLocationDeidentifyTemplateName: string): string | number;

Parse the location from OrganizationLocationDeidentifyTemplate resource.

Parameter
Name Description
organizationLocationDeidentifyTemplateName string

A fully-qualified path representing organization_location_deidentify_template resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromOrganizationLocationFileStoreDataProfileName(organizationLocationFileStoreDataProfileName)

matchLocationFromOrganizationLocationFileStoreDataProfileName(organizationLocationFileStoreDataProfileName: string): string | number;

Parse the location from OrganizationLocationFileStoreDataProfile resource.

Parameter
Name Description
organizationLocationFileStoreDataProfileName string

A fully-qualified path representing organization_location_file_store_data_profile resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromOrganizationLocationInspectTemplateName(organizationLocationInspectTemplateName)

matchLocationFromOrganizationLocationInspectTemplateName(organizationLocationInspectTemplateName: string): string | number;

Parse the location from OrganizationLocationInspectTemplate resource.

Parameter
Name Description
organizationLocationInspectTemplateName string

A fully-qualified path representing organization_location_inspect_template resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromOrganizationLocationName(organizationLocationName)

matchLocationFromOrganizationLocationName(organizationLocationName: string): string | number;

Parse the location from OrganizationLocation resource.

Parameter
Name Description
organizationLocationName string

A fully-qualified path representing OrganizationLocation resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromOrganizationLocationProjectDataProfileName(organizationLocationProjectDataProfileName)

matchLocationFromOrganizationLocationProjectDataProfileName(organizationLocationProjectDataProfileName: string): string | number;

Parse the location from OrganizationLocationProjectDataProfile resource.

Parameter
Name Description
organizationLocationProjectDataProfileName string

A fully-qualified path representing organization_location_project_data_profile resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromOrganizationLocationStoredInfoTypeName(organizationLocationStoredInfoTypeName)

matchLocationFromOrganizationLocationStoredInfoTypeName(organizationLocationStoredInfoTypeName: string): string | number;

Parse the location from OrganizationLocationStoredInfoType resource.

Parameter
Name Description
organizationLocationStoredInfoTypeName string

A fully-qualified path representing organization_location_stored_info_type resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromOrganizationLocationTableDataProfileName(organizationLocationTableDataProfileName)

matchLocationFromOrganizationLocationTableDataProfileName(organizationLocationTableDataProfileName: string): string | number;

Parse the location from OrganizationLocationTableDataProfile resource.

Parameter
Name Description
organizationLocationTableDataProfileName string

A fully-qualified path representing organization_location_table_data_profile resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationColumnDataProfileName(projectLocationColumnDataProfileName)

matchLocationFromProjectLocationColumnDataProfileName(projectLocationColumnDataProfileName: string): string | number;

Parse the location from ProjectLocationColumnDataProfile resource.

Parameter
Name Description
projectLocationColumnDataProfileName string

A fully-qualified path representing project_location_column_data_profile resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationConnectionName(projectLocationConnectionName)

matchLocationFromProjectLocationConnectionName(projectLocationConnectionName: string): string | number;

Parse the location from ProjectLocationConnection resource.

Parameter
Name Description
projectLocationConnectionName string

A fully-qualified path representing project_location_connection resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationDeidentifyTemplateName(projectLocationDeidentifyTemplateName)

matchLocationFromProjectLocationDeidentifyTemplateName(projectLocationDeidentifyTemplateName: string): string | number;

Parse the location from ProjectLocationDeidentifyTemplate resource.

Parameter
Name Description
projectLocationDeidentifyTemplateName string

A fully-qualified path representing project_location_deidentify_template resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationDlpJobName(projectLocationDlpJobName)

matchLocationFromProjectLocationDlpJobName(projectLocationDlpJobName: string): string | number;

Parse the location from ProjectLocationDlpJob resource.

Parameter
Name Description
projectLocationDlpJobName string

A fully-qualified path representing project_location_dlp_job resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationFileStoreDataProfileName(projectLocationFileStoreDataProfileName)

matchLocationFromProjectLocationFileStoreDataProfileName(projectLocationFileStoreDataProfileName: string): string | number;

Parse the location from ProjectLocationFileStoreDataProfile resource.

Parameter
Name Description
projectLocationFileStoreDataProfileName string

A fully-qualified path representing project_location_file_store_data_profile resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationInspectTemplateName(projectLocationInspectTemplateName)

matchLocationFromProjectLocationInspectTemplateName(projectLocationInspectTemplateName: string): string | number;

Parse the location from ProjectLocationInspectTemplate resource.

Parameter
Name Description
projectLocationInspectTemplateName string

A fully-qualified path representing project_location_inspect_template resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationJobTriggerName(projectLocationJobTriggerName)

matchLocationFromProjectLocationJobTriggerName(projectLocationJobTriggerName: string): string | number;

Parse the location from ProjectLocationJobTrigger resource.

Parameter
Name Description
projectLocationJobTriggerName string

A fully-qualified path representing project_location_job_trigger resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationProjectDataProfileName(projectLocationProjectDataProfileName)

matchLocationFromProjectLocationProjectDataProfileName(projectLocationProjectDataProfileName: string): string | number;

Parse the location from ProjectLocationProjectDataProfile resource.

Parameter
Name Description
projectLocationProjectDataProfileName string

A fully-qualified path representing project_location_project_data_profile resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationStoredInfoTypeName(projectLocationStoredInfoTypeName)

matchLocationFromProjectLocationStoredInfoTypeName(projectLocationStoredInfoTypeName: string): string | number;

Parse the location from ProjectLocationStoredInfoType resource.

Parameter
Name Description
projectLocationStoredInfoTypeName string

A fully-qualified path representing project_location_stored_info_type resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationTableDataProfileName(projectLocationTableDataProfileName)

matchLocationFromProjectLocationTableDataProfileName(projectLocationTableDataProfileName: string): string | number;

Parse the location from ProjectLocationTableDataProfile resource.

Parameter
Name Description
projectLocationTableDataProfileName string

A fully-qualified path representing project_location_table_data_profile resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchOrganizationFromOrganizationDeidentifyTemplateName(organizationDeidentifyTemplateName)

matchOrganizationFromOrganizationDeidentifyTemplateName(organizationDeidentifyTemplateName: string): string | number;

Parse the organization from OrganizationDeidentifyTemplate resource.

Parameter
Name Description
organizationDeidentifyTemplateName string

A fully-qualified path representing organization_deidentify_template resource.

Returns
Type Description
string | number

{string} A string representing the organization.

matchOrganizationFromOrganizationInspectTemplateName(organizationInspectTemplateName)

matchOrganizationFromOrganizationInspectTemplateName(organizationInspectTemplateName: string): string | number;

Parse the organization from OrganizationInspectTemplate resource.

Parameter
Name Description
organizationInspectTemplateName string

A fully-qualified path representing organization_inspect_template resource.

Returns
Type Description
string | number

{string} A string representing the organization.

matchOrganizationFromOrganizationLocationColumnDataProfileName(organizationLocationColumnDataProfileName)

matchOrganizationFromOrganizationLocationColumnDataProfileName(organizationLocationColumnDataProfileName: string): string | number;

Parse the organization from OrganizationLocationColumnDataProfile resource.

Parameter
Name Description
organizationLocationColumnDataProfileName string

A fully-qualified path representing organization_location_column_data_profile resource.

Returns
Type Description
string | number

{string} A string representing the organization.

matchOrganizationFromOrganizationLocationConnectionName(organizationLocationConnectionName)

matchOrganizationFromOrganizationLocationConnectionName(organizationLocationConnectionName: string): string | number;

Parse the organization from OrganizationLocationConnection resource.

Parameter
Name Description
organizationLocationConnectionName string

A fully-qualified path representing organization_location_connection resource.

Returns
Type Description
string | number

{string} A string representing the organization.

matchOrganizationFromOrganizationLocationDeidentifyTemplateName(organizationLocationDeidentifyTemplateName)

matchOrganizationFromOrganizationLocationDeidentifyTemplateName(organizationLocationDeidentifyTemplateName: string): string | number;

Parse the organization from OrganizationLocationDeidentifyTemplate resource.

Parameter
Name Description
organizationLocationDeidentifyTemplateName string

A fully-qualified path representing organization_location_deidentify_template resource.

Returns
Type Description
string | number

{string} A string representing the organization.

matchOrganizationFromOrganizationLocationFileStoreDataProfileName(organizationLocationFileStoreDataProfileName)

matchOrganizationFromOrganizationLocationFileStoreDataProfileName(organizationLocationFileStoreDataProfileName: string): string | number;

Parse the organization from OrganizationLocationFileStoreDataProfile resource.

Parameter
Name Description
organizationLocationFileStoreDataProfileName string

A fully-qualified path representing organization_location_file_store_data_profile resource.

Returns
Type Description
string | number

{string} A string representing the organization.

matchOrganizationFromOrganizationLocationInspectTemplateName(organizationLocationInspectTemplateName)

matchOrganizationFromOrganizationLocationInspectTemplateName(organizationLocationInspectTemplateName: string): string | number;

Parse the organization from OrganizationLocationInspectTemplate resource.

Parameter
Name Description
organizationLocationInspectTemplateName string

A fully-qualified path representing organization_location_inspect_template resource.

Returns
Type Description
string | number

{string} A string representing the organization.

matchOrganizationFromOrganizationLocationName(organizationLocationName)

matchOrganizationFromOrganizationLocationName(organizationLocationName: string): string | number;

Parse the organization from OrganizationLocation resource.

Parameter
Name Description
organizationLocationName string

A fully-qualified path representing OrganizationLocation resource.

Returns
Type Description
string | number

{string} A string representing the organization.

matchOrganizationFromOrganizationLocationProjectDataProfileName(organizationLocationProjectDataProfileName)

matchOrganizationFromOrganizationLocationProjectDataProfileName(organizationLocationProjectDataProfileName: string): string | number;

Parse the organization from OrganizationLocationProjectDataProfile resource.

Parameter
Name Description
organizationLocationProjectDataProfileName string

A fully-qualified path representing organization_location_project_data_profile resource.

Returns
Type Description
string | number

{string} A string representing the organization.

matchOrganizationFromOrganizationLocationStoredInfoTypeName(organizationLocationStoredInfoTypeName)

matchOrganizationFromOrganizationLocationStoredInfoTypeName(organizationLocationStoredInfoTypeName: string): string | number;

Parse the organization from OrganizationLocationStoredInfoType resource.

Parameter
Name Description
organizationLocationStoredInfoTypeName string

A fully-qualified path representing organization_location_stored_info_type resource.

Returns
Type Description
string | number

{string} A string representing the organization.

matchOrganizationFromOrganizationLocationTableDataProfileName(organizationLocationTableDataProfileName)

matchOrganizationFromOrganizationLocationTableDataProfileName(organizationLocationTableDataProfileName: string): string | number;

Parse the organization from OrganizationLocationTableDataProfile resource.

Parameter
Name Description
organizationLocationTableDataProfileName string

A fully-qualified path representing organization_location_table_data_profile resource.

Returns
Type Description
string | number

{string} A string representing the organization.

matchOrganizationFromOrganizationName(organizationName)

matchOrganizationFromOrganizationName(organizationName: string): string | number;

Parse the organization from Organization resource.

Parameter
Name Description
organizationName string

A fully-qualified path representing Organization resource.

Returns
Type Description
string | number

{string} A string representing the organization.

matchOrganizationFromOrganizationStoredInfoTypeName(organizationStoredInfoTypeName)

matchOrganizationFromOrganizationStoredInfoTypeName(organizationStoredInfoTypeName: string): string | number;

Parse the organization from OrganizationStoredInfoType resource.

Parameter
Name Description
organizationStoredInfoTypeName string

A fully-qualified path representing organization_stored_info_type resource.

Returns
Type Description
string | number

{string} A string representing the organization.

matchProjectDataProfileFromOrganizationLocationProjectDataProfileName(organizationLocationProjectDataProfileName)

matchProjectDataProfileFromOrganizationLocationProjectDataProfileName(organizationLocationProjectDataProfileName: string): string | number;

Parse the project_data_profile from OrganizationLocationProjectDataProfile resource.

Parameter
Name Description
organizationLocationProjectDataProfileName string

A fully-qualified path representing organization_location_project_data_profile resource.

Returns
Type Description
string | number

{string} A string representing the project_data_profile.

matchProjectDataProfileFromProjectLocationProjectDataProfileName(projectLocationProjectDataProfileName)

matchProjectDataProfileFromProjectLocationProjectDataProfileName(projectLocationProjectDataProfileName: string): string | number;

Parse the project_data_profile from ProjectLocationProjectDataProfile resource.

Parameter
Name Description
projectLocationProjectDataProfileName string

A fully-qualified path representing project_location_project_data_profile resource.

Returns
Type Description
string | number

{string} A string representing the project_data_profile.

matchProjectFromDiscoveryConfigName(discoveryConfigName)

matchProjectFromDiscoveryConfigName(discoveryConfigName: string): string | number;

Parse the project from DiscoveryConfig resource.

Parameter
Name Description
discoveryConfigName string

A fully-qualified path representing DiscoveryConfig resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromFindingName(findingName)

matchProjectFromFindingName(findingName: string): string | number;

Parse the project from Finding resource.

Parameter
Name Description
findingName string

A fully-qualified path representing Finding resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter
Name Description
locationName string

A fully-qualified path representing Location resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectDeidentifyTemplateName(projectDeidentifyTemplateName)

matchProjectFromProjectDeidentifyTemplateName(projectDeidentifyTemplateName: string): string | number;

Parse the project from ProjectDeidentifyTemplate resource.

Parameter
Name Description
projectDeidentifyTemplateName string

A fully-qualified path representing project_deidentify_template resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectDlpContentName(projectDlpContentName)

matchProjectFromProjectDlpContentName(projectDlpContentName: string): string | number;

Parse the project from ProjectDlpContent resource.

Parameter
Name Description
projectDlpContentName string

A fully-qualified path representing project_dlpContent resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectDlpJobName(projectDlpJobName)

matchProjectFromProjectDlpJobName(projectDlpJobName: string): string | number;

Parse the project from ProjectDlpJob resource.

Parameter
Name Description
projectDlpJobName string

A fully-qualified path representing project_dlp_job resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectInspectTemplateName(projectInspectTemplateName)

matchProjectFromProjectInspectTemplateName(projectInspectTemplateName: string): string | number;

Parse the project from ProjectInspectTemplate resource.

Parameter
Name Description
projectInspectTemplateName string

A fully-qualified path representing project_inspect_template resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectJobTriggerName(projectJobTriggerName)

matchProjectFromProjectJobTriggerName(projectJobTriggerName: string): string | number;

Parse the project from ProjectJobTrigger resource.

Parameter
Name Description
projectJobTriggerName string

A fully-qualified path representing project_job_trigger resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationColumnDataProfileName(projectLocationColumnDataProfileName)

matchProjectFromProjectLocationColumnDataProfileName(projectLocationColumnDataProfileName: string): string | number;

Parse the project from ProjectLocationColumnDataProfile resource.

Parameter
Name Description
projectLocationColumnDataProfileName string

A fully-qualified path representing project_location_column_data_profile resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationConnectionName(projectLocationConnectionName)

matchProjectFromProjectLocationConnectionName(projectLocationConnectionName: string): string | number;

Parse the project from ProjectLocationConnection resource.

Parameter
Name Description
projectLocationConnectionName string

A fully-qualified path representing project_location_connection resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationDeidentifyTemplateName(projectLocationDeidentifyTemplateName)

matchProjectFromProjectLocationDeidentifyTemplateName(projectLocationDeidentifyTemplateName: string): string | number;

Parse the project from ProjectLocationDeidentifyTemplate resource.

Parameter
Name Description
projectLocationDeidentifyTemplateName string

A fully-qualified path representing project_location_deidentify_template resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationDlpJobName(projectLocationDlpJobName)

matchProjectFromProjectLocationDlpJobName(projectLocationDlpJobName: string): string | number;

Parse the project from ProjectLocationDlpJob resource.

Parameter
Name Description
projectLocationDlpJobName string

A fully-qualified path representing project_location_dlp_job resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationFileStoreDataProfileName(projectLocationFileStoreDataProfileName)

matchProjectFromProjectLocationFileStoreDataProfileName(projectLocationFileStoreDataProfileName: string): string | number;

Parse the project from ProjectLocationFileStoreDataProfile resource.

Parameter
Name Description
projectLocationFileStoreDataProfileName string

A fully-qualified path representing project_location_file_store_data_profile resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationInspectTemplateName(projectLocationInspectTemplateName)

matchProjectFromProjectLocationInspectTemplateName(projectLocationInspectTemplateName: string): string | number;

Parse the project from ProjectLocationInspectTemplate resource.

Parameter
Name Description
projectLocationInspectTemplateName string

A fully-qualified path representing project_location_inspect_template resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationJobTriggerName(projectLocationJobTriggerName)

matchProjectFromProjectLocationJobTriggerName(projectLocationJobTriggerName: string): string | number;

Parse the project from ProjectLocationJobTrigger resource.

Parameter
Name Description
projectLocationJobTriggerName string

A fully-qualified path representing project_location_job_trigger resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationProjectDataProfileName(projectLocationProjectDataProfileName)

matchProjectFromProjectLocationProjectDataProfileName(projectLocationProjectDataProfileName: string): string | number;

Parse the project from ProjectLocationProjectDataProfile resource.

Parameter
Name Description
projectLocationProjectDataProfileName string

A fully-qualified path representing project_location_project_data_profile resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationStoredInfoTypeName(projectLocationStoredInfoTypeName)

matchProjectFromProjectLocationStoredInfoTypeName(projectLocationStoredInfoTypeName: string): string | number;

Parse the project from ProjectLocationStoredInfoType resource.

Parameter
Name Description
projectLocationStoredInfoTypeName string

A fully-qualified path representing project_location_stored_info_type resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationTableDataProfileName(projectLocationTableDataProfileName)

matchProjectFromProjectLocationTableDataProfileName(projectLocationTableDataProfileName: string): string | number;

Parse the project from ProjectLocationTableDataProfile resource.

Parameter
Name Description
projectLocationTableDataProfileName string

A fully-qualified path representing project_location_table_data_profile resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter
Name Description
projectName string

A fully-qualified path representing Project resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectStoredInfoTypeName(projectStoredInfoTypeName)

matchProjectFromProjectStoredInfoTypeName(projectStoredInfoTypeName: string): string | number;

Parse the project from ProjectStoredInfoType resource.

Parameter
Name Description
projectStoredInfoTypeName string

A fully-qualified path representing project_stored_info_type resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchStoredInfoTypeFromOrganizationLocationStoredInfoTypeName(organizationLocationStoredInfoTypeName)

matchStoredInfoTypeFromOrganizationLocationStoredInfoTypeName(organizationLocationStoredInfoTypeName: string): string | number;

Parse the stored_info_type from OrganizationLocationStoredInfoType resource.

Parameter
Name Description
organizationLocationStoredInfoTypeName string

A fully-qualified path representing organization_location_stored_info_type resource.

Returns
Type Description
string | number

{string} A string representing the stored_info_type.

matchStoredInfoTypeFromOrganizationStoredInfoTypeName(organizationStoredInfoTypeName)

matchStoredInfoTypeFromOrganizationStoredInfoTypeName(organizationStoredInfoTypeName: string): string | number;

Parse the stored_info_type from OrganizationStoredInfoType resource.

Parameter
Name Description
organizationStoredInfoTypeName string

A fully-qualified path representing organization_stored_info_type resource.

Returns
Type Description
string | number

{string} A string representing the stored_info_type.

matchStoredInfoTypeFromProjectLocationStoredInfoTypeName(projectLocationStoredInfoTypeName)

matchStoredInfoTypeFromProjectLocationStoredInfoTypeName(projectLocationStoredInfoTypeName: string): string | number;

Parse the stored_info_type from ProjectLocationStoredInfoType resource.

Parameter
Name Description
projectLocationStoredInfoTypeName string

A fully-qualified path representing project_location_stored_info_type resource.

Returns
Type Description
string | number

{string} A string representing the stored_info_type.

matchStoredInfoTypeFromProjectStoredInfoTypeName(projectStoredInfoTypeName)

matchStoredInfoTypeFromProjectStoredInfoTypeName(projectStoredInfoTypeName: string): string | number;

Parse the stored_info_type from ProjectStoredInfoType resource.

Parameter
Name Description
projectStoredInfoTypeName string

A fully-qualified path representing project_stored_info_type resource.

Returns
Type Description
string | number

{string} A string representing the stored_info_type.

matchTableDataProfileFromOrganizationLocationTableDataProfileName(organizationLocationTableDataProfileName)

matchTableDataProfileFromOrganizationLocationTableDataProfileName(organizationLocationTableDataProfileName: string): string | number;

Parse the table_data_profile from OrganizationLocationTableDataProfile resource.

Parameter
Name Description
organizationLocationTableDataProfileName string

A fully-qualified path representing organization_location_table_data_profile resource.

Returns
Type Description
string | number

{string} A string representing the table_data_profile.

matchTableDataProfileFromProjectLocationTableDataProfileName(projectLocationTableDataProfileName)

matchTableDataProfileFromProjectLocationTableDataProfileName(projectLocationTableDataProfileName: string): string | number;

Parse the table_data_profile from ProjectLocationTableDataProfile resource.

Parameter
Name Description
projectLocationTableDataProfileName string

A fully-qualified path representing project_location_table_data_profile resource.

Returns
Type Description
string | number

{string} A string representing the table_data_profile.

organizationDeidentifyTemplatePath(organization, deidentifyTemplate)

organizationDeidentifyTemplatePath(organization: string, deidentifyTemplate: string): string;

Return a fully-qualified organizationDeidentifyTemplate resource name string.

Parameters
Name Description
organization string
deidentifyTemplate string
Returns
Type Description
string

{string} Resource name string.

organizationInspectTemplatePath(organization, inspectTemplate)

organizationInspectTemplatePath(organization: string, inspectTemplate: string): string;

Return a fully-qualified organizationInspectTemplate resource name string.

Parameters
Name Description
organization string
inspectTemplate string
Returns
Type Description
string

{string} Resource name string.

organizationLocationColumnDataProfilePath(organization, location, columnDataProfile)

organizationLocationColumnDataProfilePath(organization: string, location: string, columnDataProfile: string): string;

Return a fully-qualified organizationLocationColumnDataProfile resource name string.

Parameters
Name Description
organization string
location string
columnDataProfile string
Returns
Type Description
string

{string} Resource name string.

organizationLocationConnectionPath(organization, location, connection)

organizationLocationConnectionPath(organization: string, location: string, connection: string): string;

Return a fully-qualified organizationLocationConnection resource name string.

Parameters
Name Description
organization string
location string
connection string
Returns
Type Description
string

{string} Resource name string.

organizationLocationDeidentifyTemplatePath(organization, location, deidentifyTemplate)

organizationLocationDeidentifyTemplatePath(organization: string, location: string, deidentifyTemplate: string): string;

Return a fully-qualified organizationLocationDeidentifyTemplate resource name string.

Parameters
Name Description
organization string
location string
deidentifyTemplate string
Returns
Type Description
string

{string} Resource name string.

organizationLocationFileStoreDataProfilePath(organization, location, fileStoreDataProfile)

organizationLocationFileStoreDataProfilePath(organization: string, location: string, fileStoreDataProfile: string): string;

Return a fully-qualified organizationLocationFileStoreDataProfile resource name string.

Parameters
Name Description
organization string
location string
fileStoreDataProfile string
Returns
Type Description
string

{string} Resource name string.

organizationLocationInspectTemplatePath(organization, location, inspectTemplate)

organizationLocationInspectTemplatePath(organization: string, location: string, inspectTemplate: string): string;

Return a fully-qualified organizationLocationInspectTemplate resource name string.

Parameters
Name Description
organization string
location string
inspectTemplate string
Returns
Type Description
string

{string} Resource name string.

organizationLocationPath(organization, location)

organizationLocationPath(organization: string, location: string): string;

Return a fully-qualified organizationLocation resource name string.

Parameters
Name Description
organization string
location string
Returns
Type Description
string

{string} Resource name string.

organizationLocationProjectDataProfilePath(organization, location, projectDataProfile)

organizationLocationProjectDataProfilePath(organization: string, location: string, projectDataProfile: string): string;

Return a fully-qualified organizationLocationProjectDataProfile resource name string.

Parameters
Name Description
organization string
location string
projectDataProfile string
Returns
Type Description
string

{string} Resource name string.

organizationLocationStoredInfoTypePath(organization, location, storedInfoType)

organizationLocationStoredInfoTypePath(organization: string, location: string, storedInfoType: string): string;

Return a fully-qualified organizationLocationStoredInfoType resource name string.

Parameters
Name Description
organization string
location string
storedInfoType string
Returns
Type Description
string

{string} Resource name string.

organizationLocationTableDataProfilePath(organization, location, tableDataProfile)

organizationLocationTableDataProfilePath(organization: string, location: string, tableDataProfile: string): string;

Return a fully-qualified organizationLocationTableDataProfile resource name string.

Parameters
Name Description
organization string
location string
tableDataProfile string
Returns
Type Description
string

{string} Resource name string.

organizationPath(organization)

organizationPath(organization: string): string;

Return a fully-qualified organization resource name string.

Parameter
Name Description
organization string
Returns
Type Description
string

{string} Resource name string.

organizationStoredInfoTypePath(organization, storedInfoType)

organizationStoredInfoTypePath(organization: string, storedInfoType: string): string;

Return a fully-qualified organizationStoredInfoType resource name string.

Parameters
Name Description
organization string
storedInfoType string
Returns
Type Description
string

{string} Resource name string.

projectDeidentifyTemplatePath(project, deidentifyTemplate)

projectDeidentifyTemplatePath(project: string, deidentifyTemplate: string): string;

Return a fully-qualified projectDeidentifyTemplate resource name string.

Parameters
Name Description
project string
deidentifyTemplate string
Returns
Type Description
string

{string} Resource name string.

projectDlpContentPath(project)

projectDlpContentPath(project: string): string;

Return a fully-qualified projectDlpContent resource name string.

Parameter
Name Description
project string
Returns
Type Description
string

{string} Resource name string.

projectDlpJobPath(project, dlpJob)

projectDlpJobPath(project: string, dlpJob: string): string;

Return a fully-qualified projectDlpJob resource name string.

Parameters
Name Description
project string
dlpJob string
Returns
Type Description
string

{string} Resource name string.

projectInspectTemplatePath(project, inspectTemplate)

projectInspectTemplatePath(project: string, inspectTemplate: string): string;

Return a fully-qualified projectInspectTemplate resource name string.

Parameters
Name Description
project string
inspectTemplate string
Returns
Type Description
string

{string} Resource name string.

projectJobTriggerPath(project, jobTrigger)

projectJobTriggerPath(project: string, jobTrigger: string): string;

Return a fully-qualified projectJobTrigger resource name string.

Parameters
Name Description
project string
jobTrigger string
Returns
Type Description
string

{string} Resource name string.

projectLocationColumnDataProfilePath(project, location, columnDataProfile)

projectLocationColumnDataProfilePath(project: string, location: string, columnDataProfile: string): string;

Return a fully-qualified projectLocationColumnDataProfile resource name string.

Parameters
Name Description
project string
location string
columnDataProfile string
Returns
Type Description
string

{string} Resource name string.

projectLocationConnectionPath(project, location, connection)

projectLocationConnectionPath(project: string, location: string, connection: string): string;

Return a fully-qualified projectLocationConnection resource name string.

Parameters
Name Description
project string
location string
connection string
Returns
Type Description
string

{string} Resource name string.

projectLocationDeidentifyTemplatePath(project, location, deidentifyTemplate)

projectLocationDeidentifyTemplatePath(project: string, location: string, deidentifyTemplate: string): string;

Return a fully-qualified projectLocationDeidentifyTemplate resource name string.

Parameters
Name Description
project string
location string
deidentifyTemplate string
Returns
Type Description
string

{string} Resource name string.

projectLocationDlpJobPath(project, location, dlpJob)

projectLocationDlpJobPath(project: string, location: string, dlpJob: string): string;

Return a fully-qualified projectLocationDlpJob resource name string.

Parameters
Name Description
project string
location string
dlpJob string
Returns
Type Description
string

{string} Resource name string.

projectLocationFileStoreDataProfilePath(project, location, fileStoreDataProfile)

projectLocationFileStoreDataProfilePath(project: string, location: string, fileStoreDataProfile: string): string;

Return a fully-qualified projectLocationFileStoreDataProfile resource name string.

Parameters
Name Description
project string
location string
fileStoreDataProfile string
Returns
Type Description
string

{string} Resource name string.

projectLocationInspectTemplatePath(project, location, inspectTemplate)

projectLocationInspectTemplatePath(project: string, location: string, inspectTemplate: string): string;

Return a fully-qualified projectLocationInspectTemplate resource name string.

Parameters
Name Description
project string
location string
inspectTemplate string
Returns
Type Description
string

{string} Resource name string.

projectLocationJobTriggerPath(project, location, jobTrigger)

projectLocationJobTriggerPath(project: string, location: string, jobTrigger: string): string;

Return a fully-qualified projectLocationJobTrigger resource name string.

Parameters
Name Description
project string
location string
jobTrigger string
Returns
Type Description
string

{string} Resource name string.

projectLocationProjectDataProfilePath(project, location, projectDataProfile)

projectLocationProjectDataProfilePath(project: string, location: string, projectDataProfile: string): string;

Return a fully-qualified projectLocationProjectDataProfile resource name string.

Parameters
Name Description
project string
location string
projectDataProfile string
Returns
Type Description
string

{string} Resource name string.

projectLocationStoredInfoTypePath(project, location, storedInfoType)

projectLocationStoredInfoTypePath(project: string, location: string, storedInfoType: string): string;

Return a fully-qualified projectLocationStoredInfoType resource name string.

Parameters
Name Description
project string
location string
storedInfoType string
Returns
Type Description
string

{string} Resource name string.

projectLocationTableDataProfilePath(project, location, tableDataProfile)

projectLocationTableDataProfilePath(project: string, location: string, tableDataProfile: string): string;

Return a fully-qualified projectLocationTableDataProfile resource name string.

Parameters
Name Description
project string
location string
tableDataProfile string
Returns
Type Description
string

{string} Resource name string.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter
Name Description
project string
Returns
Type Description
string

{string} Resource name string.

projectStoredInfoTypePath(project, storedInfoType)

projectStoredInfoTypePath(project: string, storedInfoType: string): string;

Return a fully-qualified projectStoredInfoType resource name string.

Parameters
Name Description
project string
storedInfoType string
Returns
Type Description
string

{string} Resource name string.

redactImage(request, options)

redactImage(request?: protos.google.privacy.dlp.v2.IRedactImageRequest, options?: CallOptions): Promise<[
        protos.google.privacy.dlp.v2.IRedactImageResponse,
        protos.google.privacy.dlp.v2.IRedactImageRequest | undefined,
        {} | undefined
    ]>;

Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images to learn more.

When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.

Parameters
Name Description
request IRedactImageRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.privacy.dlp.v2.IRedactImageResponse, protos.google.privacy.dlp.v2.IRedactImageRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing RedactImageResponse. 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.
   */
  /**
   *  Parent resource name.
   *  The format of this value varies depending on whether you have specified a
   *  processing
   *  location (https://cloud.google.com/sensitive-data-protection/docs/specifying-location):
   *  + Projects scope, location specified:
   *    `projects/{project_id}/locations/{location_id}`
   *  + Projects scope, no location specified (defaults to global):
   *    `projects/{project_id}`
   *  The following example `parent` string specifies a parent project with the
   *  identifier `example-project`, and specifies the `europe-west3` location
   *  for processing data:
   *      parent=projects/example-project/locations/europe-west3
   */
  // const parent = 'abc123'
  /**
   *  Configuration for the inspector.
   */
  // const inspectConfig = {}
  /**
   *  The configuration for specifying what content to redact from images.
   */
  // const imageRedactionConfigs = [1,2,3,4]
  /**
   *  Whether the response should include findings along with the redacted
   *  image.
   */
  // const includeFindings = true
  /**
   *  The content must be PNG, JPEG, SVG or BMP.
   */
  // const byteItem = {}

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

  async function callRedactImage() {
    // Construct request
    const request = {
    };

    // Run request
    const response = await dlpClient.redactImage(request);
    console.log(response);
  }

  callRedactImage();

redactImage(request, options, callback)

redactImage(request: protos.google.privacy.dlp.v2.IRedactImageRequest, options: CallOptions, callback: Callback<protos.google.privacy.dlp.v2.IRedactImageResponse, protos.google.privacy.dlp.v2.IRedactImageRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IRedactImageRequest
options CallOptions
callback Callback<protos.google.privacy.dlp.v2.IRedactImageResponse, protos.google.privacy.dlp.v2.IRedactImageRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

redactImage(request, callback)

redactImage(request: protos.google.privacy.dlp.v2.IRedactImageRequest, callback: Callback<protos.google.privacy.dlp.v2.IRedactImageResponse, protos.google.privacy.dlp.v2.IRedactImageRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IRedactImageRequest
callback Callback<protos.google.privacy.dlp.v2.IRedactImageResponse, protos.google.privacy.dlp.v2.IRedactImageRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

reidentifyContent(request, options)

reidentifyContent(request?: protos.google.privacy.dlp.v2.IReidentifyContentRequest, options?: CallOptions): Promise<[
        protos.google.privacy.dlp.v2.IReidentifyContentResponse,
        protos.google.privacy.dlp.v2.IReidentifyContentRequest | undefined,
        {} | undefined
    ]>;

Re-identifies content that has been de-identified. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization#re-identification_in_free_text_code_example to learn more.

Parameters
Name Description
request IReidentifyContentRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.privacy.dlp.v2.IReidentifyContentResponse, protos.google.privacy.dlp.v2.IReidentifyContentRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing ReidentifyContentResponse. 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. Parent resource name.
   *  The format of this value varies depending on whether you have specified a
   *  processing
   *  location (https://cloud.google.com/sensitive-data-protection/docs/specifying-location):
   *  + Projects scope, location specified:
   *    `projects/{project_id}/locations/{location_id}`
   *  + Projects scope, no location specified (defaults to global):
   *    `projects/{project_id}`
   *  The following example `parent` string specifies a parent project with the
   *  identifier `example-project`, and specifies the `europe-west3` location
   *  for processing data:
   *      parent=projects/example-project/locations/europe-west3
   */
  // const parent = 'abc123'
  /**
   *  Configuration for the re-identification of the content item.
   *  This field shares the same proto message type that is used for
   *  de-identification, however its usage here is for the reversal of the
   *  previous de-identification. Re-identification is performed by examining
   *  the transformations used to de-identify the items and executing the
   *  reverse. This requires that only reversible transformations
   *  be provided here. The reversible transformations are:
   *   - `CryptoDeterministicConfig`
   *   - `CryptoReplaceFfxFpeConfig`
   */
  // const reidentifyConfig = {}
  /**
   *  Configuration for the inspector.
   */
  // const inspectConfig = {}
  /**
   *  The item to re-identify. Will be treated as text.
   */
  // const item = {}
  /**
   *  Template to use. Any configuration directly specified in
   *  `inspect_config` will override those set in the template. Singular fields
   *  that are set in this request will replace their corresponding fields in the
   *  template. Repeated fields are appended. Singular sub-messages and groups
   *  are recursively merged.
   */
  // const inspectTemplateName = 'abc123'
  /**
   *  Template to use. References an instance of `DeidentifyTemplate`.
   *  Any configuration directly specified in `reidentify_config` or
   *  `inspect_config` will override those set in the template. The
   *  `DeidentifyTemplate` used must include only reversible transformations.
   *  Singular fields that are set in this request will replace their
   *  corresponding fields in the template. Repeated fields are appended.
   *  Singular sub-messages and groups are recursively merged.
   */
  // const reidentifyTemplateName = 'abc123'

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

    // Run request
    const response = await dlpClient.reidentifyContent(request);
    console.log(response);
  }

  callReidentifyContent();

reidentifyContent(request, options, callback)

reidentifyContent(request: protos.google.privacy.dlp.v2.IReidentifyContentRequest, options: CallOptions, callback: Callback<protos.google.privacy.dlp.v2.IReidentifyContentResponse, protos.google.privacy.dlp.v2.IReidentifyContentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IReidentifyContentRequest
options CallOptions
callback Callback<protos.google.privacy.dlp.v2.IReidentifyContentResponse, protos.google.privacy.dlp.v2.IReidentifyContentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

reidentifyContent(request, callback)

reidentifyContent(request: protos.google.privacy.dlp.v2.IReidentifyContentRequest, callback: Callback<protos.google.privacy.dlp.v2.IReidentifyContentResponse, protos.google.privacy.dlp.v2.IReidentifyContentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IReidentifyContentRequest
callback Callback<protos.google.privacy.dlp.v2.IReidentifyContentResponse, protos.google.privacy.dlp.v2.IReidentifyContentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

searchConnections(request, options)

searchConnections(request?: protos.google.privacy.dlp.v2.ISearchConnectionsRequest, options?: CallOptions): Promise<[
        protos.google.privacy.dlp.v2.IConnection[],
        protos.google.privacy.dlp.v2.ISearchConnectionsRequest | null,
        protos.google.privacy.dlp.v2.ISearchConnectionsResponse
    ]>;

Searches for Connections in a parent.

Parameters
Name Description
request ISearchConnectionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.privacy.dlp.v2.IConnection[], protos.google.privacy.dlp.v2.ISearchConnectionsRequest | null, protos.google.privacy.dlp.v2.ISearchConnectionsResponse ]>

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

searchConnections(request, options, callback)

searchConnections(request: protos.google.privacy.dlp.v2.ISearchConnectionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.privacy.dlp.v2.ISearchConnectionsRequest, protos.google.privacy.dlp.v2.ISearchConnectionsResponse | null | undefined, protos.google.privacy.dlp.v2.IConnection>): void;
Parameters
Name Description
request ISearchConnectionsRequest
options CallOptions
callback PaginationCallback<protos.google.privacy.dlp.v2.ISearchConnectionsRequest, protos.google.privacy.dlp.v2.ISearchConnectionsResponse | null | undefined, protos.google.privacy.dlp.v2.IConnection>
Returns
Type Description
void

searchConnections(request, callback)

searchConnections(request: protos.google.privacy.dlp.v2.ISearchConnectionsRequest, callback: PaginationCallback<protos.google.privacy.dlp.v2.ISearchConnectionsRequest, protos.google.privacy.dlp.v2.ISearchConnectionsResponse | null | undefined, protos.google.privacy.dlp.v2.IConnection>): void;
Parameters
Name Description
request ISearchConnectionsRequest
callback PaginationCallback<protos.google.privacy.dlp.v2.ISearchConnectionsRequest, protos.google.privacy.dlp.v2.ISearchConnectionsResponse | null | undefined, protos.google.privacy.dlp.v2.IConnection>
Returns
Type Description
void

searchConnectionsAsync(request, options)

searchConnectionsAsync(request?: protos.google.privacy.dlp.v2.ISearchConnectionsRequest, options?: CallOptions): AsyncIterable<protos.google.privacy.dlp.v2.IConnection>;

Equivalent to searchConnections, but returns an iterable object.

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

Parameters
Name Description
request ISearchConnectionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.privacy.dlp.v2.IConnection>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Connection. 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. Resource name of the organization or project with a wildcard
   *  location, for example, `organizations/433245324/locations/-` or
   *  `projects/project-id/locations/-`.
   */
  // const parent = 'abc123'
  /**
   *  Optional. Number of results per page, max 1000.
   */
  // const pageSize = 1234
  /**
   *  Optional. Page token from a previous page to return the next set of
   *  results. If set, all other request fields must match the original request.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Supported field/value: - `state` - MISSING|AVAILABLE|ERROR
   */
  // const filter = 'abc123'

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

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

  callSearchConnections();

searchConnectionsStream(request, options)

searchConnectionsStream(request?: protos.google.privacy.dlp.v2.ISearchConnectionsRequest, options?: CallOptions): Transform;

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

Parameters
Name Description
request ISearchConnectionsRequest

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

updateConnection(request, options)

updateConnection(request?: protos.google.privacy.dlp.v2.IUpdateConnectionRequest, options?: CallOptions): Promise<[
        protos.google.privacy.dlp.v2.IConnection,
        protos.google.privacy.dlp.v2.IUpdateConnectionRequest | undefined,
        {} | undefined
    ]>;

Update a Connection.

Parameters
Name Description
request IUpdateConnectionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.privacy.dlp.v2.IConnection, protos.google.privacy.dlp.v2.IUpdateConnectionRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Connection. 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. Resource name in the format:
   *  `projects/{project}/locations/{location}/connections/{connection}`.
   */
  // const name = 'abc123'
  /**
   *  Required. The connection with new values for the relevant fields.
   */
  // const connection = {}
  /**
   *  Optional. Mask to control which fields get updated.
   */
  // const updateMask = {}

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

    // Run request
    const response = await dlpClient.updateConnection(request);
    console.log(response);
  }

  callUpdateConnection();

updateConnection(request, options, callback)

updateConnection(request: protos.google.privacy.dlp.v2.IUpdateConnectionRequest, options: CallOptions, callback: Callback<protos.google.privacy.dlp.v2.IConnection, protos.google.privacy.dlp.v2.IUpdateConnectionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateConnectionRequest
options CallOptions
callback Callback<protos.google.privacy.dlp.v2.IConnection, protos.google.privacy.dlp.v2.IUpdateConnectionRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateConnection(request, callback)

updateConnection(request: protos.google.privacy.dlp.v2.IUpdateConnectionRequest, callback: Callback<protos.google.privacy.dlp.v2.IConnection, protos.google.privacy.dlp.v2.IUpdateConnectionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateConnectionRequest
callback Callback<protos.google.privacy.dlp.v2.IConnection, protos.google.privacy.dlp.v2.IUpdateConnectionRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateDeidentifyTemplate(request, options)

updateDeidentifyTemplate(request?: protos.google.privacy.dlp.v2.IUpdateDeidentifyTemplateRequest, options?: CallOptions): Promise<[
        protos.google.privacy.dlp.v2.IDeidentifyTemplate,
        protos.google.privacy.dlp.v2.IUpdateDeidentifyTemplateRequest | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request IUpdateDeidentifyTemplateRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.privacy.dlp.v2.IDeidentifyTemplate, protos.google.privacy.dlp.v2.IUpdateDeidentifyTemplateRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing DeidentifyTemplate. 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. Resource name of organization and deidentify template to be
   *  updated, for example
   *  `organizations/433245324/deidentifyTemplates/432452342` or
   *  projects/project-id/deidentifyTemplates/432452342.
   */
  // const name = 'abc123'
  /**
   *  New DeidentifyTemplate value.
   */
  // const deidentifyTemplate = {}
  /**
   *  Mask to control which fields get updated.
   */
  // const updateMask = {}

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

    // Run request
    const response = await dlpClient.updateDeidentifyTemplate(request);
    console.log(response);
  }

  callUpdateDeidentifyTemplate();

updateDeidentifyTemplate(request, options, callback)

updateDeidentifyTemplate(request: protos.google.privacy.dlp.v2.IUpdateDeidentifyTemplateRequest, options: CallOptions, callback: Callback<protos.google.privacy.dlp.v2.IDeidentifyTemplate, protos.google.privacy.dlp.v2.IUpdateDeidentifyTemplateRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateDeidentifyTemplateRequest
options CallOptions
callback Callback<protos.google.privacy.dlp.v2.IDeidentifyTemplate, protos.google.privacy.dlp.v2.IUpdateDeidentifyTemplateRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateDeidentifyTemplate(request, callback)

updateDeidentifyTemplate(request: protos.google.privacy.dlp.v2.IUpdateDeidentifyTemplateRequest, callback: Callback<protos.google.privacy.dlp.v2.IDeidentifyTemplate, protos.google.privacy.dlp.v2.IUpdateDeidentifyTemplateRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateDeidentifyTemplateRequest
callback Callback<protos.google.privacy.dlp.v2.IDeidentifyTemplate, protos.google.privacy.dlp.v2.IUpdateDeidentifyTemplateRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateDiscoveryConfig(request, options)

updateDiscoveryConfig(request?: protos.google.privacy.dlp.v2.IUpdateDiscoveryConfigRequest, options?: CallOptions): Promise<[
        protos.google.privacy.dlp.v2.IDiscoveryConfig,
        protos.google.privacy.dlp.v2.IUpdateDiscoveryConfigRequest | undefined,
        {} | undefined
    ]>;

Updates a discovery configuration.

Parameters
Name Description
request IUpdateDiscoveryConfigRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.privacy.dlp.v2.IDiscoveryConfig, protos.google.privacy.dlp.v2.IUpdateDiscoveryConfigRequest | 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. Resource name of the project and the configuration, for example
   *  `projects/dlp-test-project/discoveryConfigs/53234423`.
   */
  // const name = 'abc123'
  /**
   *  Required. New DiscoveryConfig value.
   */
  // const discoveryConfig = {}
  /**
   *  Mask to control which fields get updated.
   */
  // const updateMask = {}

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

    // Run request
    const response = await dlpClient.updateDiscoveryConfig(request);
    console.log(response);
  }

  callUpdateDiscoveryConfig();

updateDiscoveryConfig(request, options, callback)

updateDiscoveryConfig(request: protos.google.privacy.dlp.v2.IUpdateDiscoveryConfigRequest, options: CallOptions, callback: Callback<protos.google.privacy.dlp.v2.IDiscoveryConfig, protos.google.privacy.dlp.v2.IUpdateDiscoveryConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateDiscoveryConfigRequest
options CallOptions
callback Callback<protos.google.privacy.dlp.v2.IDiscoveryConfig, protos.google.privacy.dlp.v2.IUpdateDiscoveryConfigRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateDiscoveryConfig(request, callback)

updateDiscoveryConfig(request: protos.google.privacy.dlp.v2.IUpdateDiscoveryConfigRequest, callback: Callback<protos.google.privacy.dlp.v2.IDiscoveryConfig, protos.google.privacy.dlp.v2.IUpdateDiscoveryConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateDiscoveryConfigRequest
callback Callback<protos.google.privacy.dlp.v2.IDiscoveryConfig, protos.google.privacy.dlp.v2.IUpdateDiscoveryConfigRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateInspectTemplate(request, options)

updateInspectTemplate(request?: protos.google.privacy.dlp.v2.IUpdateInspectTemplateRequest, options?: CallOptions): Promise<[
        protos.google.privacy.dlp.v2.IInspectTemplate,
        protos.google.privacy.dlp.v2.IUpdateInspectTemplateRequest | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request IUpdateInspectTemplateRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.privacy.dlp.v2.IInspectTemplate, protos.google.privacy.dlp.v2.IUpdateInspectTemplateRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing InspectTemplate. 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. Resource name of organization and inspectTemplate to be updated,
   *  for example `organizations/433245324/inspectTemplates/432452342` or
   *  projects/project-id/inspectTemplates/432452342.
   */
  // const name = 'abc123'
  /**
   *  New InspectTemplate value.
   */
  // const inspectTemplate = {}
  /**
   *  Mask to control which fields get updated.
   */
  // const updateMask = {}

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

    // Run request
    const response = await dlpClient.updateInspectTemplate(request);
    console.log(response);
  }

  callUpdateInspectTemplate();

updateInspectTemplate(request, options, callback)

updateInspectTemplate(request: protos.google.privacy.dlp.v2.IUpdateInspectTemplateRequest, options: CallOptions, callback: Callback<protos.google.privacy.dlp.v2.IInspectTemplate, protos.google.privacy.dlp.v2.IUpdateInspectTemplateRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateInspectTemplateRequest
options CallOptions
callback Callback<protos.google.privacy.dlp.v2.IInspectTemplate, protos.google.privacy.dlp.v2.IUpdateInspectTemplateRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateInspectTemplate(request, callback)

updateInspectTemplate(request: protos.google.privacy.dlp.v2.IUpdateInspectTemplateRequest, callback: Callback<protos.google.privacy.dlp.v2.IInspectTemplate, protos.google.privacy.dlp.v2.IUpdateInspectTemplateRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateInspectTemplateRequest
callback Callback<protos.google.privacy.dlp.v2.IInspectTemplate, protos.google.privacy.dlp.v2.IUpdateInspectTemplateRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateJobTrigger(request, options)

updateJobTrigger(request?: protos.google.privacy.dlp.v2.IUpdateJobTriggerRequest, options?: CallOptions): Promise<[
        protos.google.privacy.dlp.v2.IJobTrigger,
        protos.google.privacy.dlp.v2.IUpdateJobTriggerRequest | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request IUpdateJobTriggerRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.privacy.dlp.v2.IJobTrigger, protos.google.privacy.dlp.v2.IUpdateJobTriggerRequest | 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. Resource name of the project and the triggeredJob, for example
   *  `projects/dlp-test-project/jobTriggers/53234423`.
   */
  // const name = 'abc123'
  /**
   *  New JobTrigger value.
   */
  // const jobTrigger = {}
  /**
   *  Mask to control which fields get updated.
   */
  // const updateMask = {}

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

    // Run request
    const response = await dlpClient.updateJobTrigger(request);
    console.log(response);
  }

  callUpdateJobTrigger();

updateJobTrigger(request, options, callback)

updateJobTrigger(request: protos.google.privacy.dlp.v2.IUpdateJobTriggerRequest, options: CallOptions, callback: Callback<protos.google.privacy.dlp.v2.IJobTrigger, protos.google.privacy.dlp.v2.IUpdateJobTriggerRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateJobTriggerRequest
options CallOptions
callback Callback<protos.google.privacy.dlp.v2.IJobTrigger, protos.google.privacy.dlp.v2.IUpdateJobTriggerRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateJobTrigger(request, callback)

updateJobTrigger(request: protos.google.privacy.dlp.v2.IUpdateJobTriggerRequest, callback: Callback<protos.google.privacy.dlp.v2.IJobTrigger, protos.google.privacy.dlp.v2.IUpdateJobTriggerRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateJobTriggerRequest
callback Callback<protos.google.privacy.dlp.v2.IJobTrigger, protos.google.privacy.dlp.v2.IUpdateJobTriggerRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateStoredInfoType(request, options)

updateStoredInfoType(request?: protos.google.privacy.dlp.v2.IUpdateStoredInfoTypeRequest, options?: CallOptions): Promise<[
        protos.google.privacy.dlp.v2.IStoredInfoType,
        protos.google.privacy.dlp.v2.IUpdateStoredInfoTypeRequest | undefined,
        {} | undefined
    ]>;

Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

Parameters
Name Description
request IUpdateStoredInfoTypeRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.privacy.dlp.v2.IStoredInfoType, protos.google.privacy.dlp.v2.IUpdateStoredInfoTypeRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing StoredInfoType. 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. Resource name of organization and storedInfoType to be updated,
   *  for example `organizations/433245324/storedInfoTypes/432452342` or
   *  projects/project-id/storedInfoTypes/432452342.
   */
  // const name = 'abc123'
  /**
   *  Updated configuration for the storedInfoType. If not provided, a new
   *  version of the storedInfoType will be created with the existing
   *  configuration.
   */
  // const config = {}
  /**
   *  Mask to control which fields get updated.
   */
  // const updateMask = {}

  // Imports the Dlp library
  const {DlpServiceClient} = require('@google-cloud/dlp').v2;

  // Instantiates a client
  const dlpClient = new DlpServiceClient();

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

    // Run request
    const response = await dlpClient.updateStoredInfoType(request);
    console.log(response);
  }

  callUpdateStoredInfoType();

updateStoredInfoType(request, options, callback)

updateStoredInfoType(request: protos.google.privacy.dlp.v2.IUpdateStoredInfoTypeRequest, options: CallOptions, callback: Callback<protos.google.privacy.dlp.v2.IStoredInfoType, protos.google.privacy.dlp.v2.IUpdateStoredInfoTypeRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateStoredInfoTypeRequest
options CallOptions
callback Callback<protos.google.privacy.dlp.v2.IStoredInfoType, protos.google.privacy.dlp.v2.IUpdateStoredInfoTypeRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateStoredInfoType(request, callback)

updateStoredInfoType(request: protos.google.privacy.dlp.v2.IUpdateStoredInfoTypeRequest, callback: Callback<protos.google.privacy.dlp.v2.IStoredInfoType, protos.google.privacy.dlp.v2.IUpdateStoredInfoTypeRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateStoredInfoTypeRequest
callback Callback<protos.google.privacy.dlp.v2.IStoredInfoType, protos.google.privacy.dlp.v2.IUpdateStoredInfoTypeRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void