DlpServiceClient

DlpServiceClient

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/dlp/docs/.

Constructor

new DlpServiceClient(optionsopt, gaxInstanceopt)

Construct an instance of DlpServiceClient.

Parameters:
Name Type Attributes Description
options object <optional>

The configuration object. The options accepted by the constructor are described in detail in this document. The common options are:

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

Account email address. Required when using a .pem or .p12 keyFilename.
keyFilename string <optional>

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.
port number <optional>

The port on which to connect to the remote host.
projectId string <optional>

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.
apiEndpoint string <optional>

The domain name of the API remote host.
clientConfig gax.ClientConfig <optional>

Client configuration override. Follows the structure of gapicConfig.
fallback boolean | "rest" <optional>

Use HTTP fallback mode. Pass "rest" to use HTTP/1.1 REST API instead of gRPC. For more information, please check the documentation.
gaxInstance gax <optional>

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: 'rest'}, gax);

Members

apiEndpoint

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

port

The port for this API service.

scopes

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

servicePath

The DNS address for this API service.

Methods

close() → {Promise}

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

A promise that resolves when the client is closed.

findingPath(project, location, finding) → {string}

Return a fully-qualified finding resource name string.

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

Resource name string.

getLocation(request, optionsopt) → {Promise}

Gets information about a location.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Resource name for the location.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Location. Please see the documentation for more details and examples.
Example
```
const [response] = await client.getLocation(request);
```

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:
Type Description
Promise

A promise that resolves to string containing the project ID.

initialize() → {Promise}

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

A promise that resolves to an authenticated service stub.

listDeidentifyTemplatesAsync(request, optionsopt) → {Object}

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 Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

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:

  • 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
pageToken string

Page token to continue retrieval. Comes from previous call to ListDeidentifyTemplates.
pageSize number

Size of the page, can be limited by the server. If zero server returns a page of max size 100.
orderBy string

Comma separated list of fields to order by, followed by asc or desc postfix. This list is case-insensitive, 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.
locationId string

Deprecated. This field has no effect.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
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/dlp/docs/specifying-location):
   *  + Projects scope, location specified:<br/>
   *    `projects/`<var>PROJECT_ID</var>`/locations/`<var>LOCATION_ID</var>
   *  + Projects scope, no location specified (defaults to global):<br/>
   *    `projects/`<var>PROJECT_ID</var>
   *  + Organizations scope, location specified:<br/>
   *    `organizations/`<var>ORG_ID</var>`/locations/`<var>LOCATION_ID</var>
   *  + Organizations scope, no location specified (defaults to global):<br/>
   *    `organizations/`<var>ORG_ID</var>
   *  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 previous call
   *  to `ListDeidentifyTemplates`.
   */
  // const pageToken = 'abc123'
  /**
   *  Size of the page, 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,
   *  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 = await dlpClient.listDeidentifyTemplatesAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListDeidentifyTemplates();

listDeidentifyTemplatesStream(request, optionsopt) → {Stream}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

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:

  • 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
pageToken string

Page token to continue retrieval. Comes from previous call to ListDeidentifyTemplates.
pageSize number

Size of the page, can be limited by the server. If zero server returns a page of max size 100.
orderBy string

Comma separated list of fields to order by, followed by asc or desc postfix. This list is case-insensitive, 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.
locationId string

Deprecated. This field has no effect.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
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.

listDlpJobsAsync(request, optionsopt) → {Object}

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 Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. Parent resource name.

The format of this value varies depending on whether you have specified a processing 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
filter string

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.
pageSize number

The standard list page size.
pageToken string

The standard list page token.
type google.privacy.dlp.v2.DlpJobType

The type of job. Defaults to DlpJobType.INSPECT
orderBy string

Comma separated list of fields to order by, followed by asc or desc postfix. This list is case-insensitive, 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
locationId string

Deprecated. This field has no effect.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing DlpJob. 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/dlp/docs/specifying-location):
   *  + Projects scope, location specified:<br/>
   *    `projects/`<var>PROJECT_ID</var>`/locations/`<var>LOCATION_ID</var>
   *  + Projects scope, no location specified (defaults to global):<br/>
   *    `projects/`<var>PROJECT_ID</var>
   *  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,
   *  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 = await dlpClient.listDlpJobsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListDlpJobs();

listDlpJobsStream(request, optionsopt) → {Stream}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. Parent resource name.

The format of this value varies depending on whether you have specified a processing 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
filter string

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.
pageSize number

The standard list page size.
pageToken string

The standard list page token.
type google.privacy.dlp.v2.DlpJobType

The type of job. Defaults to DlpJobType.INSPECT
orderBy string

Comma separated list of fields to order by, followed by asc or desc postfix. This list is case-insensitive, 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
locationId string

Deprecated. This field has no effect.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing DlpJob 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.

listInspectTemplatesAsync(request, optionsopt) → {Object}

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 Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

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:

  • 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
pageToken string

Page token to continue retrieval. Comes from previous call to ListInspectTemplates.
pageSize number

Size of the page, can be limited by the server. If zero server returns a page of max size 100.
orderBy string

Comma separated list of fields to order by, followed by asc or desc postfix. This list is case-insensitive, 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.
locationId string

Deprecated. This field has no effect.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
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/dlp/docs/specifying-location):
   *  + Projects scope, location specified:<br/>
   *    `projects/`<var>PROJECT_ID</var>`/locations/`<var>LOCATION_ID</var>
   *  + Projects scope, no location specified (defaults to global):<br/>
   *    `projects/`<var>PROJECT_ID</var>
   *  + Organizations scope, location specified:<br/>
   *    `organizations/`<var>ORG_ID</var>`/locations/`<var>LOCATION_ID</var>
   *  + Organizations scope, no location specified (defaults to global):<br/>
   *    `organizations/`<var>ORG_ID</var>
   *  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 previous call
   *  to `ListInspectTemplates`.
   */
  // const pageToken = 'abc123'
  /**
   *  Size of the page, 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,
   *  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 = await dlpClient.listInspectTemplatesAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListInspectTemplates();

listInspectTemplatesStream(request, optionsopt) → {Stream}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

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:

  • 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
pageToken string

Page token to continue retrieval. Comes from previous call to ListInspectTemplates.
pageSize number

Size of the page, can be limited by the server. If zero server returns a page of max size 100.
orderBy string

Comma separated list of fields to order by, followed by asc or desc postfix. This list is case-insensitive, 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.
locationId string

Deprecated. This field has no effect.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
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.

listJobTriggersAsync(request, optionsopt) → {Object}

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 Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. Parent resource name.

The format of this value varies depending on whether you have specified a processing 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
pageToken string

Page token to continue retrieval. Comes from previous call to ListJobTriggers. order_by field must not change for subsequent calls.
pageSize number

Size of the page, can be limited by a server.
orderBy string

Comma separated list of triggeredJob fields to order by, followed by asc or desc postfix. This list is case-insensitive, 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.
filter string

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.
type google.privacy.dlp.v2.DlpJobType

The type of jobs. Will use DlpJobType.INSPECT if not set.
locationId string

Deprecated. This field has no effect.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing JobTrigger. 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/dlp/docs/specifying-location):
   *  + Projects scope, location specified:<br/>
   *    `projects/`<var>PROJECT_ID</var>`/locations/`<var>LOCATION_ID</var>
   *  + Projects scope, no location specified (defaults to global):<br/>
   *    `projects/`<var>PROJECT_ID</var>
   *  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 previous call
   *  to ListJobTriggers. `order_by` field must not
   *  change for subsequent calls.
   */
  // const pageToken = 'abc123'
  /**
   *  Size of the page, 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,
   *  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 = await dlpClient.listJobTriggersAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListJobTriggers();

listJobTriggersStream(request, optionsopt) → {Stream}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. Parent resource name.

The format of this value varies depending on whether you have specified a processing 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
pageToken string

Page token to continue retrieval. Comes from previous call to ListJobTriggers. order_by field must not change for subsequent calls.
pageSize number

Size of the page, can be limited by a server.
orderBy string

Comma separated list of triggeredJob fields to order by, followed by asc or desc postfix. This list is case-insensitive, 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.
filter string

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.
type google.privacy.dlp.v2.DlpJobType

The type of jobs. Will use DlpJobType.INSPECT if not set.
locationId string

Deprecated. This field has no effect.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing JobTrigger 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, optionsopt) → {Object}

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 Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The resource that owns the locations collection, if applicable.
filter string

The standard list filter.
pageSize number

The standard list page size.
pageToken string

The standard list page token.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Location. 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
}
```

listStoredInfoTypesAsync(request, optionsopt) → {Object}

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 Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

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:

  • 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
pageToken string

Page token to continue retrieval. Comes from previous call to ListStoredInfoTypes.
pageSize number

Size of the page, can be limited by the server. If zero server returns a page of max size 100.
orderBy string

Comma separated list of fields to order by, followed by asc or desc postfix. This list is case-insensitive, 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.
locationId string

Deprecated. This field has no effect.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
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/dlp/docs/specifying-location):
   *  + Projects scope, location specified:<br/>
   *    `projects/`<var>PROJECT_ID</var>`/locations/`<var>LOCATION_ID</var>
   *  + Projects scope, no location specified (defaults to global):<br/>
   *    `projects/`<var>PROJECT_ID</var>
   *  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 previous call
   *  to `ListStoredInfoTypes`.
   */
  // const pageToken = 'abc123'
  /**
   *  Size of the page, 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,
   *  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 = await dlpClient.listStoredInfoTypesAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListStoredInfoTypes();

listStoredInfoTypesStream(request, optionsopt) → {Stream}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

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:

  • 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
pageToken string

Page token to continue retrieval. Comes from previous call to ListStoredInfoTypes.
pageSize number

Size of the page, can be limited by the server. If zero server returns a page of max size 100.
orderBy string

Comma separated list of fields to order by, followed by asc or desc postfix. This list is case-insensitive, 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.
locationId string

Deprecated. This field has no effect.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
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.

matchDeidentifyTemplateFromOrganizationDeidentifyTemplateName(organizationDeidentifyTemplateName) → {string}

Parse the deidentify_template from OrganizationDeidentifyTemplate resource.

Parameters:
Name Type Description
organizationDeidentifyTemplateName string

A fully-qualified path representing organization_deidentify_template resource.
Returns:
Type Description
string

A string representing the deidentify_template.

matchDeidentifyTemplateFromOrganizationLocationDeidentifyTemplateName(organizationLocationDeidentifyTemplateName) → {string}

Parse the deidentify_template from OrganizationLocationDeidentifyTemplate resource.

Parameters:
Name Type Description
organizationLocationDeidentifyTemplateName string

A fully-qualified path representing organization_location_deidentify_template resource.
Returns:
Type Description
string

A string representing the deidentify_template.

matchDeidentifyTemplateFromProjectDeidentifyTemplateName(projectDeidentifyTemplateName) → {string}

Parse the deidentify_template from ProjectDeidentifyTemplate resource.

Parameters:
Name Type Description
projectDeidentifyTemplateName string

A fully-qualified path representing project_deidentify_template resource.
Returns:
Type Description
string

A string representing the deidentify_template.

matchDeidentifyTemplateFromProjectLocationDeidentifyTemplateName(projectLocationDeidentifyTemplateName) → {string}

Parse the deidentify_template from ProjectLocationDeidentifyTemplate resource.

Parameters:
Name Type Description
projectLocationDeidentifyTemplateName string

A fully-qualified path representing project_location_deidentify_template resource.
Returns:
Type Description
string

A string representing the deidentify_template.

matchDlpJobFromProjectDlpJobName(projectDlpJobName) → {string}

Parse the dlp_job from ProjectDlpJob resource.

Parameters:
Name Type Description
projectDlpJobName string

A fully-qualified path representing project_dlp_job resource.
Returns:
Type Description
string

A string representing the dlp_job.

matchDlpJobFromProjectLocationDlpJobName(projectLocationDlpJobName) → {string}

Parse the dlp_job from ProjectLocationDlpJob resource.

Parameters:
Name Type Description
projectLocationDlpJobName string

A fully-qualified path representing project_location_dlp_job resource.
Returns:
Type Description
string

A string representing the dlp_job.

matchFindingFromFindingName(findingName) → {string}

Parse the finding from Finding resource.

Parameters:
Name Type Description
findingName string

A fully-qualified path representing Finding resource.
Returns:
Type Description
string

A string representing the finding.

matchInspectTemplateFromOrganizationInspectTemplateName(organizationInspectTemplateName) → {string}

Parse the inspect_template from OrganizationInspectTemplate resource.

Parameters:
Name Type Description
organizationInspectTemplateName string

A fully-qualified path representing organization_inspect_template resource.
Returns:
Type Description
string

A string representing the inspect_template.

matchInspectTemplateFromOrganizationLocationInspectTemplateName(organizationLocationInspectTemplateName) → {string}

Parse the inspect_template from OrganizationLocationInspectTemplate resource.

Parameters:
Name Type Description
organizationLocationInspectTemplateName string

A fully-qualified path representing organization_location_inspect_template resource.
Returns:
Type Description
string

A string representing the inspect_template.

matchInspectTemplateFromProjectInspectTemplateName(projectInspectTemplateName) → {string}

Parse the inspect_template from ProjectInspectTemplate resource.

Parameters:
Name Type Description
projectInspectTemplateName string

A fully-qualified path representing project_inspect_template resource.
Returns:
Type Description
string

A string representing the inspect_template.

matchInspectTemplateFromProjectLocationInspectTemplateName(projectLocationInspectTemplateName) → {string}

Parse the inspect_template from ProjectLocationInspectTemplate resource.

Parameters:
Name Type Description
projectLocationInspectTemplateName string

A fully-qualified path representing project_location_inspect_template resource.
Returns:
Type Description
string

A string representing the inspect_template.

matchJobTriggerFromProjectJobTriggerName(projectJobTriggerName) → {string}

Parse the job_trigger from ProjectJobTrigger resource.

Parameters:
Name Type Description
projectJobTriggerName string

A fully-qualified path representing project_job_trigger resource.
Returns:
Type Description
string

A string representing the job_trigger.

matchJobTriggerFromProjectLocationJobTriggerName(projectLocationJobTriggerName) → {string}

Parse the job_trigger from ProjectLocationJobTrigger resource.

Parameters:
Name Type Description
projectLocationJobTriggerName string

A fully-qualified path representing project_location_job_trigger resource.
Returns:
Type Description
string

A string representing the job_trigger.

matchLocationFromFindingName(findingName) → {string}

Parse the location from Finding resource.

Parameters:
Name Type Description
findingName string

A fully-qualified path representing Finding resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromOrganizationLocationDeidentifyTemplateName(organizationLocationDeidentifyTemplateName) → {string}

Parse the location from OrganizationLocationDeidentifyTemplate resource.

Parameters:
Name Type Description
organizationLocationDeidentifyTemplateName string

A fully-qualified path representing organization_location_deidentify_template resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromOrganizationLocationInspectTemplateName(organizationLocationInspectTemplateName) → {string}

Parse the location from OrganizationLocationInspectTemplate resource.

Parameters:
Name Type Description
organizationLocationInspectTemplateName string

A fully-qualified path representing organization_location_inspect_template resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromOrganizationLocationStoredInfoTypeName(organizationLocationStoredInfoTypeName) → {string}

Parse the location from OrganizationLocationStoredInfoType resource.

Parameters:
Name Type Description
organizationLocationStoredInfoTypeName string

A fully-qualified path representing organization_location_stored_info_type resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromProjectLocationDeidentifyTemplateName(projectLocationDeidentifyTemplateName) → {string}

Parse the location from ProjectLocationDeidentifyTemplate resource.

Parameters:
Name Type Description
projectLocationDeidentifyTemplateName string

A fully-qualified path representing project_location_deidentify_template resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromProjectLocationDlpJobName(projectLocationDlpJobName) → {string}

Parse the location from ProjectLocationDlpJob resource.

Parameters:
Name Type Description
projectLocationDlpJobName string

A fully-qualified path representing project_location_dlp_job resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromProjectLocationInspectTemplateName(projectLocationInspectTemplateName) → {string}

Parse the location from ProjectLocationInspectTemplate resource.

Parameters:
Name Type Description
projectLocationInspectTemplateName string

A fully-qualified path representing project_location_inspect_template resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromProjectLocationJobTriggerName(projectLocationJobTriggerName) → {string}

Parse the location from ProjectLocationJobTrigger resource.

Parameters:
Name Type Description
projectLocationJobTriggerName string

A fully-qualified path representing project_location_job_trigger resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromProjectLocationStoredInfoTypeName(projectLocationStoredInfoTypeName) → {string}

Parse the location from ProjectLocationStoredInfoType resource.

Parameters:
Name Type Description
projectLocationStoredInfoTypeName string

A fully-qualified path representing project_location_stored_info_type resource.
Returns:
Type Description
string

A string representing the location.

matchOrganizationFromOrganizationDeidentifyTemplateName(organizationDeidentifyTemplateName) → {string}

Parse the organization from OrganizationDeidentifyTemplate resource.

Parameters:
Name Type Description
organizationDeidentifyTemplateName string

A fully-qualified path representing organization_deidentify_template resource.
Returns:
Type Description
string

A string representing the organization.

matchOrganizationFromOrganizationInspectTemplateName(organizationInspectTemplateName) → {string}

Parse the organization from OrganizationInspectTemplate resource.

Parameters:
Name Type Description
organizationInspectTemplateName string

A fully-qualified path representing organization_inspect_template resource.
Returns:
Type Description
string

A string representing the organization.

matchOrganizationFromOrganizationLocationDeidentifyTemplateName(organizationLocationDeidentifyTemplateName) → {string}

Parse the organization from OrganizationLocationDeidentifyTemplate resource.

Parameters:
Name Type Description
organizationLocationDeidentifyTemplateName string

A fully-qualified path representing organization_location_deidentify_template resource.
Returns:
Type Description
string

A string representing the organization.

matchOrganizationFromOrganizationLocationInspectTemplateName(organizationLocationInspectTemplateName) → {string}

Parse the organization from OrganizationLocationInspectTemplate resource.

Parameters:
Name Type Description
organizationLocationInspectTemplateName string

A fully-qualified path representing organization_location_inspect_template resource.
Returns:
Type Description
string

A string representing the organization.

matchOrganizationFromOrganizationLocationStoredInfoTypeName(organizationLocationStoredInfoTypeName) → {string}

Parse the organization from OrganizationLocationStoredInfoType resource.

Parameters:
Name Type Description
organizationLocationStoredInfoTypeName string

A fully-qualified path representing organization_location_stored_info_type resource.
Returns:
Type Description
string

A string representing the organization.

matchOrganizationFromOrganizationName(organizationName) → {string}

Parse the organization from Organization resource.

Parameters:
Name Type Description
organizationName string

A fully-qualified path representing Organization resource.
Returns:
Type Description
string

A string representing the organization.

matchOrganizationFromOrganizationStoredInfoTypeName(organizationStoredInfoTypeName) → {string}

Parse the organization from OrganizationStoredInfoType resource.

Parameters:
Name Type Description
organizationStoredInfoTypeName string

A fully-qualified path representing organization_stored_info_type resource.
Returns:
Type Description
string

A string representing the organization.

matchProjectFromFindingName(findingName) → {string}

Parse the project from Finding resource.

Parameters:
Name Type Description
findingName string

A fully-qualified path representing Finding resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectDeidentifyTemplateName(projectDeidentifyTemplateName) → {string}

Parse the project from ProjectDeidentifyTemplate resource.

Parameters:
Name Type Description
projectDeidentifyTemplateName string

A fully-qualified path representing project_deidentify_template resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectDlpContentName(projectDlpContentName) → {string}

Parse the project from ProjectDlpContent resource.

Parameters:
Name Type Description
projectDlpContentName string

A fully-qualified path representing project_dlpContent resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectDlpJobName(projectDlpJobName) → {string}

Parse the project from ProjectDlpJob resource.

Parameters:
Name Type Description
projectDlpJobName string

A fully-qualified path representing project_dlp_job resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectInspectTemplateName(projectInspectTemplateName) → {string}

Parse the project from ProjectInspectTemplate resource.

Parameters:
Name Type Description
projectInspectTemplateName string

A fully-qualified path representing project_inspect_template resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectJobTriggerName(projectJobTriggerName) → {string}

Parse the project from ProjectJobTrigger resource.

Parameters:
Name Type Description
projectJobTriggerName string

A fully-qualified path representing project_job_trigger resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectLocationDeidentifyTemplateName(projectLocationDeidentifyTemplateName) → {string}

Parse the project from ProjectLocationDeidentifyTemplate resource.

Parameters:
Name Type Description
projectLocationDeidentifyTemplateName string

A fully-qualified path representing project_location_deidentify_template resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectLocationDlpJobName(projectLocationDlpJobName) → {string}

Parse the project from ProjectLocationDlpJob resource.

Parameters:
Name Type Description
projectLocationDlpJobName string

A fully-qualified path representing project_location_dlp_job resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectLocationInspectTemplateName(projectLocationInspectTemplateName) → {string}

Parse the project from ProjectLocationInspectTemplate resource.

Parameters:
Name Type Description
projectLocationInspectTemplateName string

A fully-qualified path representing project_location_inspect_template resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectLocationJobTriggerName(projectLocationJobTriggerName) → {string}

Parse the project from ProjectLocationJobTrigger resource.

Parameters:
Name Type Description
projectLocationJobTriggerName string

A fully-qualified path representing project_location_job_trigger resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectLocationStoredInfoTypeName(projectLocationStoredInfoTypeName) → {string}

Parse the project from ProjectLocationStoredInfoType resource.

Parameters:
Name Type Description
projectLocationStoredInfoTypeName string

A fully-qualified path representing project_location_stored_info_type resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectName(projectName) → {string}

Parse the project from Project resource.

Parameters:
Name Type Description
projectName string

A fully-qualified path representing Project resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectStoredInfoTypeName(projectStoredInfoTypeName) → {string}

Parse the project from ProjectStoredInfoType resource.

Parameters:
Name Type Description
projectStoredInfoTypeName string

A fully-qualified path representing project_stored_info_type resource.
Returns:
Type Description
string

A string representing the project.

matchStoredInfoTypeFromOrganizationLocationStoredInfoTypeName(organizationLocationStoredInfoTypeName) → {string}

Parse the stored_info_type from OrganizationLocationStoredInfoType resource.

Parameters:
Name Type Description
organizationLocationStoredInfoTypeName string

A fully-qualified path representing organization_location_stored_info_type resource.
Returns:
Type Description
string

A string representing the stored_info_type.

matchStoredInfoTypeFromOrganizationStoredInfoTypeName(organizationStoredInfoTypeName) → {string}

Parse the stored_info_type from OrganizationStoredInfoType resource.

Parameters:
Name Type Description
organizationStoredInfoTypeName string

A fully-qualified path representing organization_stored_info_type resource.
Returns:
Type Description
string

A string representing the stored_info_type.

matchStoredInfoTypeFromProjectLocationStoredInfoTypeName(projectLocationStoredInfoTypeName) → {string}

Parse the stored_info_type from ProjectLocationStoredInfoType resource.

Parameters:
Name Type Description
projectLocationStoredInfoTypeName string

A fully-qualified path representing project_location_stored_info_type resource.
Returns:
Type Description
string

A string representing the stored_info_type.

matchStoredInfoTypeFromProjectStoredInfoTypeName(projectStoredInfoTypeName) → {string}

Parse the stored_info_type from ProjectStoredInfoType resource.

Parameters:
Name Type Description
projectStoredInfoTypeName string

A fully-qualified path representing project_stored_info_type resource.
Returns:
Type Description
string

A string representing the stored_info_type.

organizationDeidentifyTemplatePath(organization, deidentify_template) → {string}

Return a fully-qualified organizationDeidentifyTemplate resource name string.

Parameters:
Name Type Description
organization string
deidentify_template string
Returns:
Type Description
string

Resource name string.

organizationInspectTemplatePath(organization, inspect_template) → {string}

Return a fully-qualified organizationInspectTemplate resource name string.

Parameters:
Name Type Description
organization string
inspect_template string
Returns:
Type Description
string

Resource name string.

organizationLocationDeidentifyTemplatePath(organization, location, deidentify_template) → {string}

Return a fully-qualified organizationLocationDeidentifyTemplate resource name string.

Parameters:
Name Type Description
organization string
location string
deidentify_template string
Returns:
Type Description
string

Resource name string.

organizationLocationInspectTemplatePath(organization, location, inspect_template) → {string}

Return a fully-qualified organizationLocationInspectTemplate resource name string.

Parameters:
Name Type Description
organization string
location string
inspect_template string
Returns:
Type Description
string

Resource name string.

organizationLocationStoredInfoTypePath(organization, location, stored_info_type) → {string}

Return a fully-qualified organizationLocationStoredInfoType resource name string.

Parameters:
Name Type Description
organization string
location string
stored_info_type string
Returns:
Type Description
string

Resource name string.

organizationPath(organization) → {string}

Return a fully-qualified organization resource name string.

Parameters:
Name Type Description
organization string
Returns:
Type Description
string

Resource name string.

organizationStoredInfoTypePath(organization, stored_info_type) → {string}

Return a fully-qualified organizationStoredInfoType resource name string.

Parameters:
Name Type Description
organization string
stored_info_type string
Returns:
Type Description
string

Resource name string.

projectDeidentifyTemplatePath(project, deidentify_template) → {string}

Return a fully-qualified projectDeidentifyTemplate resource name string.

Parameters:
Name Type Description
project string
deidentify_template string
Returns:
Type Description
string

Resource name string.

projectDlpContentPath(project) → {string}

Return a fully-qualified projectDlpContent resource name string.

Parameters:
Name Type Description
project string
Returns:
Type Description
string

Resource name string.

projectDlpJobPath(project, dlp_job) → {string}

Return a fully-qualified projectDlpJob resource name string.

Parameters:
Name Type Description
project string
dlp_job string
Returns:
Type Description
string

Resource name string.

projectInspectTemplatePath(project, inspect_template) → {string}

Return a fully-qualified projectInspectTemplate resource name string.

Parameters:
Name Type Description
project string
inspect_template string
Returns:
Type Description
string

Resource name string.

projectJobTriggerPath(project, job_trigger) → {string}

Return a fully-qualified projectJobTrigger resource name string.

Parameters:
Name Type Description
project string
job_trigger string
Returns:
Type Description
string

Resource name string.

projectLocationDeidentifyTemplatePath(project, location, deidentify_template) → {string}

Return a fully-qualified projectLocationDeidentifyTemplate resource name string.

Parameters:
Name Type Description
project string
location string
deidentify_template string
Returns:
Type Description
string

Resource name string.

projectLocationDlpJobPath(project, location, dlp_job) → {string}

Return a fully-qualified projectLocationDlpJob resource name string.

Parameters:
Name Type Description
project string
location string
dlp_job string
Returns:
Type Description
string

Resource name string.

projectLocationInspectTemplatePath(project, location, inspect_template) → {string}

Return a fully-qualified projectLocationInspectTemplate resource name string.

Parameters:
Name Type Description
project string
location string
inspect_template string
Returns:
Type Description
string

Resource name string.

projectLocationJobTriggerPath(project, location, job_trigger) → {string}

Return a fully-qualified projectLocationJobTrigger resource name string.

Parameters:
Name Type Description
project string
location string
job_trigger string
Returns:
Type Description
string

Resource name string.

projectLocationStoredInfoTypePath(project, location, stored_info_type) → {string}

Return a fully-qualified projectLocationStoredInfoType resource name string.

Parameters:
Name Type Description
project string
location string
stored_info_type string
Returns:
Type Description
string

Resource name string.

projectPath(project) → {string}

Return a fully-qualified project resource name string.

Parameters:
Name Type Description
project string
Returns:
Type Description
string

Resource name string.

projectStoredInfoTypePath(project, stored_info_type) → {string}

Return a fully-qualified projectStoredInfoType resource name string.

Parameters:
Name Type Description
project string
stored_info_type string
Returns:
Type Description
string

Resource name string.