v2.DlpServiceClient

Parameters

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.

cancelDlpJob(request[, options][, callback]) → Promise

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/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.

const dlp = require('@google-cloud/dlp');

const client = new dlp.v2.DlpServiceClient({
  // optional auth parameters.
});

const formattedName = client.dlpJobPath('[PROJECT]', '[DLP_JOB]');
client.cancelDlpJob({name: formattedName}).catch(err => {
  console.error(err);
});

Returns

Promise 

• The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

createDeidentifyTemplate(request[, options][, callback]) → Promise

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

const dlp = require('@google-cloud/dlp');

const client = new dlp.v2.DlpServiceClient({
  // optional auth parameters.
});

const formattedParent = client.organizationPath('[ORGANIZATION]');
client.createDeidentifyTemplate({parent: formattedParent})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is an object representing DeidentifyTemplate. The promise has a method named "cancel" which cancels the ongoing API call.

createDlpJob(request[, options][, callback]) → Promise

Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/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.

const dlp = require('@google-cloud/dlp');

const client = new dlp.v2.DlpServiceClient({
  // optional auth parameters.
});

const formattedParent = client.projectPath('[PROJECT]');
client.createDlpJob({parent: formattedParent})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is an object representing DlpJob. The promise has a method named "cancel" which cancels the ongoing API call.

createInspectTemplate(request[, options][, callback]) → Promise

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

const dlp = require('@google-cloud/dlp');

const client = new dlp.v2.DlpServiceClient({
  // optional auth parameters.
});

const formattedParent = client.organizationPath('[ORGANIZATION]');
client.createInspectTemplate({parent: formattedParent})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is an object representing InspectTemplate. The promise has a method named "cancel" which cancels the ongoing API call.

createJobTrigger(request[, options][, callback]) → Promise

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

const dlp = require('@google-cloud/dlp');

const client = new dlp.v2.DlpServiceClient({
  // optional auth parameters.
});

const formattedParent = client.projectPath('[PROJECT]');
client.createJobTrigger({parent: formattedParent})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is an object representing JobTrigger. The promise has a method named "cancel" which cancels the ongoing API call.

createStoredInfoType(request[, options][, callback]) → Promise

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

const dlp = require('@google-cloud/dlp');

const client = new dlp.v2.DlpServiceClient({
  // optional auth parameters.
});

const formattedParent = client.organizationPath('[ORGANIZATION]');
client.createStoredInfoType({parent: formattedParent})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is an object representing StoredInfoType. The promise has a method named "cancel" which cancels the ongoing API call.

deidentifyContent(request[, options][, callback]) → Promise

De-identifies potentially sensitive info from a ContentItem. This method has limits on input size and output size. See https://cloud.google.com/dlp/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.

const dlp = require('@google-cloud/dlp');

const client = new dlp.v2.DlpServiceClient({
  // optional auth parameters.
});

const formattedParent = client.projectPath('[PROJECT]');
client.deidentifyContent({parent: formattedParent})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is an object representing DeidentifyContentResponse. The promise has a method named "cancel" which cancels the ongoing API call.

deleteDeidentifyTemplate(request[, options][, callback]) → Promise

Deletes a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.

const dlp = require('@google-cloud/dlp');

const client = new dlp.v2.DlpServiceClient({
  // optional auth parameters.
});

const formattedName = client.organizationDeidentifyTemplatePath('[ORGANIZATION]', '[DEIDENTIFY_TEMPLATE]');
client.deleteDeidentifyTemplate({name: formattedName}).catch(err => {
  console.error(err);
});

Returns

Promise 

• The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

deleteDlpJob(request[, options][, callback]) → Promise

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

const dlp = require('@google-cloud/dlp');

const client = new dlp.v2.DlpServiceClient({
  // optional auth parameters.
});

const formattedName = client.dlpJobPath('[PROJECT]', '[DLP_JOB]');
client.deleteDlpJob({name: formattedName}).catch(err => {
  console.error(err);
});

Returns

Promise 

• The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

deleteInspectTemplate(request[, options][, callback]) → Promise

Deletes an InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.

const dlp = require('@google-cloud/dlp');

const client = new dlp.v2.DlpServiceClient({
  // optional auth parameters.
});

const formattedName = client.organizationInspectTemplatePath('[ORGANIZATION]', '[INSPECT_TEMPLATE]');
client.deleteInspectTemplate({name: formattedName}).catch(err => {
  console.error(err);
});

Returns

Promise 

• The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

deleteJobTrigger(request[, options][, callback]) → Promise

Deletes a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.

const dlp = require('@google-cloud/dlp');

const client = new dlp.v2.DlpServiceClient({
  // optional auth parameters.
});

const name = '';
client.deleteJobTrigger({name: name}).catch(err => {
  console.error(err);
});

Returns

Promise 

• The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

deleteStoredInfoType(request[, options][, callback]) → Promise

Deletes a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.

const dlp = require('@google-cloud/dlp');

const client = new dlp.v2.DlpServiceClient({
  // optional auth parameters.
});

const formattedName = client.organizationStoredInfoTypePath('[ORGANIZATION]', '[STORED_INFO_TYPE]');
client.deleteStoredInfoType({name: formattedName}).catch(err => {
  console.error(err);
});

Returns

Promise 

• The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

dlpJobPath(project, dlpJob) → String

Return a fully-qualified dlp_job resource name string.

Returns

String 

getDeidentifyTemplate(request[, options][, callback]) → Promise

Gets a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.

const dlp = require('@google-cloud/dlp');

const client = new dlp.v2.DlpServiceClient({
  // optional auth parameters.
});

const formattedName = client.organizationDeidentifyTemplatePath('[ORGANIZATION]', '[DEIDENTIFY_TEMPLATE]');
client.getDeidentifyTemplate({name: formattedName})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is an object representing DeidentifyTemplate. The promise has a method named "cancel" which cancels the ongoing API call.

getDlpJob(request[, options][, callback]) → Promise

Gets the latest state of a long-running DlpJob. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.

const dlp = require('@google-cloud/dlp');

const client = new dlp.v2.DlpServiceClient({
  // optional auth parameters.
});

const formattedName = client.dlpJobPath('[PROJECT]', '[DLP_JOB]');
client.getDlpJob({name: formattedName})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is an object representing DlpJob. The promise has a method named "cancel" which cancels the ongoing API call.

getInspectTemplate(request[, options][, callback]) → Promise

Gets an InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.

const dlp = require('@google-cloud/dlp');

const client = new dlp.v2.DlpServiceClient({
  // optional auth parameters.
});


client.getInspectTemplate({})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is an object representing InspectTemplate. The promise has a method named "cancel" which cancels the ongoing API call.

getJobTrigger(request[, options][, callback]) → Promise

Gets a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.

const dlp = require('@google-cloud/dlp');

const client = new dlp.v2.DlpServiceClient({
  // optional auth parameters.
});

const formattedName = client.projectJobTriggerPath('[PROJECT]', '[JOB_TRIGGER]');
client.getJobTrigger({name: formattedName})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is an object representing JobTrigger. The promise has a method named "cancel" which cancels the ongoing API call.

getProjectId(callback)

Return the project ID used by this class.

getStoredInfoType(request[, options][, callback]) → Promise

Gets a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.

const dlp = require('@google-cloud/dlp');

const client = new dlp.v2.DlpServiceClient({
  // optional auth parameters.
});

const formattedName = client.organizationStoredInfoTypePath('[ORGANIZATION]', '[STORED_INFO_TYPE]');
client.getStoredInfoType({name: formattedName})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is an object representing StoredInfoType. The promise has a method named "cancel" which cancels the ongoing API call.

inspectContent(request[, options][, callback]) → Promise

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/dlp/docs/inspecting-images and https://cloud.google.com/dlp/docs/inspecting-text,

const dlp = require('@google-cloud/dlp');

const client = new dlp.v2.DlpServiceClient({
  // optional auth parameters.
});

const formattedParent = client.projectPath('[PROJECT]');
client.inspectContent({parent: formattedParent})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is an object representing InspectContentResponse. The promise has a method named "cancel" which cancels the ongoing API call.

listDeidentifyTemplates(request[, options][, callback]) → Promise

Lists DeidentifyTemplates. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.

const dlp = require('@google-cloud/dlp');

const client = new dlp.v2.DlpServiceClient({
  // optional auth parameters.
});

// Iterate over all elements.
const formattedParent = client.organizationPath('[ORGANIZATION]');

client.listDeidentifyTemplates({parent: formattedParent})
  .then(responses => {
    const resources = responses[0];
    for (const resource of resources) {
      // doThingsWith(resource)
    }
  })
  .catch(err => {
    console.error(err);
  });

// Or obtain the paged response.
const formattedParent = client.organizationPath('[ORGANIZATION]');


const options = {autoPaginate: false};
const callback = responses => {
  // The actual resources in a response.
  const resources = responses[0];
  // The next request if the response shows that there are more responses.
  const nextRequest = responses[1];
  // The actual response object, if necessary.
  // const rawResponse = responses[2];
  for (const resource of resources) {
    // doThingsWith(resource);
  }
  if (nextRequest) {
    // Fetch the next page.
    return client.listDeidentifyTemplates(nextRequest, options).then(callback);
  }
}
client.listDeidentifyTemplates({parent: formattedParent}, options)
  .then(callback)
  .catch(err => {
    console.error(err);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is Array of DeidentifyTemplate.

  When autoPaginate: false is specified through options, the array has three elements. The first element is Array of DeidentifyTemplate in a single response. The second element is the next request object if the response indicates the next page exists, or null. The third element is an object representing ListDeidentifyTemplatesResponse.

  The promise has a method named "cancel" which cancels the ongoing API call.

listDeidentifyTemplatesStream(request[, options]) → Stream

Equivalent to listDeidentifyTemplates, but returns a NodeJS Stream object.

This fetches the paged responses for listDeidentifyTemplates continuously and invokes the callback registered for 'data' event for each element in the responses.

The returned object has 'end' method when no more elements are required.

autoPaginate option will be ignored.

const dlp = require('@google-cloud/dlp');

const client = new dlp.v2.DlpServiceClient({
  // optional auth parameters.
});

const formattedParent = client.organizationPath('[ORGANIZATION]');
client.listDeidentifyTemplatesStream({parent: formattedParent})
  .on('data', element => {
    // doThingsWith(element)
  }).on('error', err => {
    console.log(err);
  });

See also

https://nodejs.org/api/stream.html

Returns

Stream 

An object stream which emits an object representing DeidentifyTemplate on 'data' event.

listDlpJobs(request[, options][, callback]) → Promise

Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.

const dlp = require('@google-cloud/dlp');

const client = new dlp.v2.DlpServiceClient({
  // optional auth parameters.
});

// Iterate over all elements.
const formattedParent = client.projectPath('[PROJECT]');

client.listDlpJobs({parent: formattedParent})
  .then(responses => {
    const resources = responses[0];
    for (const resource of resources) {
      // doThingsWith(resource)
    }
  })
  .catch(err => {
    console.error(err);
  });

// Or obtain the paged response.
const formattedParent = client.projectPath('[PROJECT]');


const options = {autoPaginate: false};
const callback = responses => {
  // The actual resources in a response.
  const resources = responses[0];
  // The next request if the response shows that there are more responses.
  const nextRequest = responses[1];
  // The actual response object, if necessary.
  // const rawResponse = responses[2];
  for (const resource of resources) {
    // doThingsWith(resource);
  }
  if (nextRequest) {
    // Fetch the next page.
    return client.listDlpJobs(nextRequest, options).then(callback);
  }
}
client.listDlpJobs({parent: formattedParent}, options)
  .then(callback)
  .catch(err => {
    console.error(err);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is Array of DlpJob.

  When autoPaginate: false is specified through options, the array has three elements. The first element is Array of DlpJob in a single response. The second element is the next request object if the response indicates the next page exists, or null. The third element is an object representing ListDlpJobsResponse.

  The promise has a method named "cancel" which cancels the ongoing API call.

listDlpJobsStream(request[, options]) → Stream

Equivalent to listDlpJobs, but returns a NodeJS Stream object.

This fetches the paged responses for listDlpJobs continuously and invokes the callback registered for 'data' event for each element in the responses.

The returned object has 'end' method when no more elements are required.

autoPaginate option will be ignored.

const dlp = require('@google-cloud/dlp');

const client = new dlp.v2.DlpServiceClient({
  // optional auth parameters.
});

const formattedParent = client.projectPath('[PROJECT]');
client.listDlpJobsStream({parent: formattedParent})
  .on('data', element => {
    // doThingsWith(element)
  }).on('error', err => {
    console.log(err);
  });

See also

https://nodejs.org/api/stream.html

Returns

Stream 

An object stream which emits an object representing DlpJob on 'data' event.

listInfoTypes(request[, options][, callback]) → Promise

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

const dlp = require('@google-cloud/dlp');

const client = new dlp.v2.DlpServiceClient({
  // optional auth parameters.
});


client.listInfoTypes({})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is an object representing ListInfoTypesResponse. The promise has a method named "cancel" which cancels the ongoing API call.

listInspectTemplates(request[, options][, callback]) → Promise

Lists InspectTemplates. See https://cloud.google.com/dlp/docs/creating-templates to learn more.

const dlp = require('@google-cloud/dlp');

const client = new dlp.v2.DlpServiceClient({
  // optional auth parameters.
});

// Iterate over all elements.
const formattedParent = client.organizationPath('[ORGANIZATION]');

client.listInspectTemplates({parent: formattedParent})
  .then(responses => {
    const resources = responses[0];
    for (const resource of resources) {
      // doThingsWith(resource)
    }
  })
  .catch(err => {
    console.error(err);
  });

// Or obtain the paged response.
const formattedParent = client.organizationPath('[ORGANIZATION]');


const options = {autoPaginate: false};
const callback = responses => {
  // The actual resources in a response.
  const resources = responses[0];
  // The next request if the response shows that there are more responses.
  const nextRequest = responses[1];
  // The actual response object, if necessary.
  // const rawResponse = responses[2];
  for (const resource of resources) {
    // doThingsWith(resource);
  }
  if (nextRequest) {
    // Fetch the next page.
    return client.listInspectTemplates(nextRequest, options).then(callback);
  }
}
client.listInspectTemplates({parent: formattedParent}, options)
  .then(callback)
  .catch(err => {
    console.error(err);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is Array of InspectTemplate.

  When autoPaginate: false is specified through options, the array has three elements. The first element is Array of InspectTemplate in a single response. The second element is the next request object if the response indicates the next page exists, or null. The third element is an object representing ListInspectTemplatesResponse.

  The promise has a method named "cancel" which cancels the ongoing API call.

listInspectTemplatesStream(request[, options]) → Stream

Equivalent to listInspectTemplates, but returns a NodeJS Stream object.

This fetches the paged responses for listInspectTemplates continuously and invokes the callback registered for 'data' event for each element in the responses.

The returned object has 'end' method when no more elements are required.

autoPaginate option will be ignored.

const dlp = require('@google-cloud/dlp');

const client = new dlp.v2.DlpServiceClient({
  // optional auth parameters.
});

const formattedParent = client.organizationPath('[ORGANIZATION]');
client.listInspectTemplatesStream({parent: formattedParent})
  .on('data', element => {
    // doThingsWith(element)
  }).on('error', err => {
    console.log(err);
  });

See also

https://nodejs.org/api/stream.html

Returns

Stream 

An object stream which emits an object representing InspectTemplate on 'data' event.

listJobTriggers(request[, options][, callback]) → Promise

Lists job triggers. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.

const dlp = require('@google-cloud/dlp');

const client = new dlp.v2.DlpServiceClient({
  // optional auth parameters.
});

// Iterate over all elements.
const formattedParent = client.projectPath('[PROJECT]');

client.listJobTriggers({parent: formattedParent})
  .then(responses => {
    const resources = responses[0];
    for (const resource of resources) {
      // doThingsWith(resource)
    }
  })
  .catch(err => {
    console.error(err);
  });

// Or obtain the paged response.
const formattedParent = client.projectPath('[PROJECT]');


const options = {autoPaginate: false};
const callback = responses => {
  // The actual resources in a response.
  const resources = responses[0];
  // The next request if the response shows that there are more responses.
  const nextRequest = responses[1];
  // The actual response object, if necessary.
  // const rawResponse = responses[2];
  for (const resource of resources) {
    // doThingsWith(resource);
  }
  if (nextRequest) {
    // Fetch the next page.
    return client.listJobTriggers(nextRequest, options).then(callback);
  }
}
client.listJobTriggers({parent: formattedParent}, options)
  .then(callback)
  .catch(err => {
    console.error(err);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is Array of JobTrigger.

  When autoPaginate: false is specified through options, the array has three elements. The first element is Array of JobTrigger in a single response. The second element is the next request object if the response indicates the next page exists, or null. The third element is an object representing ListJobTriggersResponse.

  The promise has a method named "cancel" which cancels the ongoing API call.

listJobTriggersStream(request[, options]) → Stream

Equivalent to listJobTriggers, but returns a NodeJS Stream object.

This fetches the paged responses for listJobTriggers continuously and invokes the callback registered for 'data' event for each element in the responses.

The returned object has 'end' method when no more elements are required.

autoPaginate option will be ignored.

const dlp = require('@google-cloud/dlp');

const client = new dlp.v2.DlpServiceClient({
  // optional auth parameters.
});

const formattedParent = client.projectPath('[PROJECT]');
client.listJobTriggersStream({parent: formattedParent})
  .on('data', element => {
    // doThingsWith(element)
  }).on('error', err => {
    console.log(err);
  });

See also

https://nodejs.org/api/stream.html

Returns

Stream 

An object stream which emits an object representing JobTrigger on 'data' event.

listStoredInfoTypes(request[, options][, callback]) → Promise

Lists stored infoTypes. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.

const dlp = require('@google-cloud/dlp');

const client = new dlp.v2.DlpServiceClient({
  // optional auth parameters.
});

// Iterate over all elements.
const formattedParent = client.organizationPath('[ORGANIZATION]');

client.listStoredInfoTypes({parent: formattedParent})
  .then(responses => {
    const resources = responses[0];
    for (const resource of resources) {
      // doThingsWith(resource)
    }
  })
  .catch(err => {
    console.error(err);
  });

// Or obtain the paged response.
const formattedParent = client.organizationPath('[ORGANIZATION]');


const options = {autoPaginate: false};
const callback = responses => {
  // The actual resources in a response.
  const resources = responses[0];
  // The next request if the response shows that there are more responses.
  const nextRequest = responses[1];
  // The actual response object, if necessary.
  // const rawResponse = responses[2];
  for (const resource of resources) {
    // doThingsWith(resource);
  }
  if (nextRequest) {
    // Fetch the next page.
    return client.listStoredInfoTypes(nextRequest, options).then(callback);
  }
}
client.listStoredInfoTypes({parent: formattedParent}, options)
  .then(callback)
  .catch(err => {
    console.error(err);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is Array of StoredInfoType.

  When autoPaginate: false is specified through options, the array has three elements. The first element is Array of StoredInfoType in a single response. The second element is the next request object if the response indicates the next page exists, or null. The third element is an object representing ListStoredInfoTypesResponse.

  The promise has a method named "cancel" which cancels the ongoing API call.

listStoredInfoTypesStream(request[, options]) → Stream

Equivalent to listStoredInfoTypes, but returns a NodeJS Stream object.

This fetches the paged responses for listStoredInfoTypes continuously and invokes the callback registered for 'data' event for each element in the responses.

The returned object has 'end' method when no more elements are required.

autoPaginate option will be ignored.

const dlp = require('@google-cloud/dlp');

const client = new dlp.v2.DlpServiceClient({
  // optional auth parameters.
});

const formattedParent = client.organizationPath('[ORGANIZATION]');
client.listStoredInfoTypesStream({parent: formattedParent})
  .on('data', element => {
    // doThingsWith(element)
  }).on('error', err => {
    console.log(err);
  });

See also

https://nodejs.org/api/stream.html

Returns

Stream 

An object stream which emits an object representing StoredInfoType on 'data' event.

matchDeidentifyTemplateFromOrganizationDeidentifyTemplateName(organizationDeidentifyTemplateName) → String

Parse the organizationDeidentifyTemplateName from a organization_deidentify_template resource.

Returns

String 

• A string representing the deidentify_template.

matchDeidentifyTemplateFromProjectDeidentifyTemplateName(projectDeidentifyTemplateName) → String

Parse the projectDeidentifyTemplateName from a project_deidentify_template resource.

Returns

String 

• A string representing the deidentify_template.

matchDlpJobFromDlpJobName(dlpJobName) → String

Parse the dlpJobName from a dlp_job resource.

Returns

String 

• A string representing the dlp_job.

matchInspectTemplateFromOrganizationInspectTemplateName(organizationInspectTemplateName) → String

Parse the organizationInspectTemplateName from a organization_inspect_template resource.

Returns

String 

• A string representing the inspect_template.

matchInspectTemplateFromProjectInspectTemplateName(projectInspectTemplateName) → String

Parse the projectInspectTemplateName from a project_inspect_template resource.

Returns

String 

• A string representing the inspect_template.

matchJobTriggerFromProjectJobTriggerName(projectJobTriggerName) → String

Parse the projectJobTriggerName from a project_job_trigger resource.

Returns

String 

• A string representing the job_trigger.

matchOrganizationFromOrganizationDeidentifyTemplateName(organizationDeidentifyTemplateName) → String

Parse the organizationDeidentifyTemplateName from a organization_deidentify_template resource.

Returns

String 

• A string representing the organization.

matchOrganizationFromOrganizationInspectTemplateName(organizationInspectTemplateName) → String

Parse the organizationInspectTemplateName from a organization_inspect_template resource.

Returns

String 

• A string representing the organization.

matchOrganizationFromOrganizationName(organizationName) → String

Parse the organizationName from a organization resource.

Returns

String 

• A string representing the organization.

matchOrganizationFromOrganizationStoredInfoTypeName(organizationStoredInfoTypeName) → String

Parse the organizationStoredInfoTypeName from a organization_stored_info_type resource.

Returns

String 

• A string representing the organization.

matchProjectFromDlpJobName(dlpJobName) → String

Parse the dlpJobName from a dlp_job resource.

Returns

String 

• A string representing the project.

matchProjectFromProjectDeidentifyTemplateName(projectDeidentifyTemplateName) → String

Parse the projectDeidentifyTemplateName from a project_deidentify_template resource.

Returns

String 

• A string representing the project.

matchProjectFromProjectInspectTemplateName(projectInspectTemplateName) → String

Parse the projectInspectTemplateName from a project_inspect_template resource.

Returns

String 

• A string representing the project.

matchProjectFromProjectJobTriggerName(projectJobTriggerName) → String

Parse the projectJobTriggerName from a project_job_trigger resource.

Returns

String 

• A string representing the project.

matchProjectFromProjectName(projectName) → String

Parse the projectName from a project resource.

Returns

String 

• A string representing the project.

matchProjectFromProjectStoredInfoTypeName(projectStoredInfoTypeName) → String

Parse the projectStoredInfoTypeName from a project_stored_info_type resource.

Returns

String 

• A string representing the project.

matchStoredInfoTypeFromOrganizationStoredInfoTypeName(organizationStoredInfoTypeName) → String

Parse the organizationStoredInfoTypeName from a organization_stored_info_type resource.

Returns

String 

• A string representing the stored_info_type.

matchStoredInfoTypeFromProjectStoredInfoTypeName(projectStoredInfoTypeName) → String

Parse the projectStoredInfoTypeName from a project_stored_info_type resource.

Returns

String 

• A string representing the stored_info_type.

organizationDeidentifyTemplatePath(organization, deidentifyTemplate) → String

Return a fully-qualified organization_deidentify_template resource name string.

Returns

String 

organizationInspectTemplatePath(organization, inspectTemplate) → String

Return a fully-qualified organization_inspect_template resource name string.

Returns

String 

organizationPath(organization) → String

Return a fully-qualified organization resource name string.

Returns

String 

organizationStoredInfoTypePath(organization, storedInfoType) → String

Return a fully-qualified organization_stored_info_type resource name string.

Returns

String 

projectDeidentifyTemplatePath(project, deidentifyTemplate) → String

Return a fully-qualified project_deidentify_template resource name string.

Returns

String 

projectInspectTemplatePath(project, inspectTemplate) → String

Return a fully-qualified project_inspect_template resource name string.

Returns

String 

projectJobTriggerPath(project, jobTrigger) → String

Return a fully-qualified project_job_trigger resource name string.

Returns

String 

projectPath(project) → String

Return a fully-qualified project resource name string.

Returns

String 

projectStoredInfoTypePath(project, storedInfoType) → String

Return a fully-qualified project_stored_info_type resource name string.

Returns

String 

redactImage(request[, options][, callback]) → Promise

Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://cloud.google.com/dlp/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.

const dlp = require('@google-cloud/dlp');

const client = new dlp.v2.DlpServiceClient({
  // optional auth parameters.
});

const formattedParent = client.projectPath('[PROJECT]');
client.redactImage({parent: formattedParent})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is an object representing RedactImageResponse. The promise has a method named "cancel" which cancels the ongoing API call.

reidentifyContent(request[, options][, callback]) → Promise

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

const dlp = require('@google-cloud/dlp');

const client = new dlp.v2.DlpServiceClient({
  // optional auth parameters.
});

const formattedParent = client.projectPath('[PROJECT]');
client.reidentifyContent({parent: formattedParent})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is an object representing ReidentifyContentResponse. The promise has a method named "cancel" which cancels the ongoing API call.

updateDeidentifyTemplate(request[, options][, callback]) → Promise

Updates the DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.

const dlp = require('@google-cloud/dlp');

const client = new dlp.v2.DlpServiceClient({
  // optional auth parameters.
});

const formattedName = client.organizationDeidentifyTemplatePath('[ORGANIZATION]', '[DEIDENTIFY_TEMPLATE]');
client.updateDeidentifyTemplate({name: formattedName})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is an object representing DeidentifyTemplate. The promise has a method named "cancel" which cancels the ongoing API call.

updateInspectTemplate(request[, options][, callback]) → Promise

Updates the InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.

const dlp = require('@google-cloud/dlp');

const client = new dlp.v2.DlpServiceClient({
  // optional auth parameters.
});

const formattedName = client.organizationInspectTemplatePath('[ORGANIZATION]', '[INSPECT_TEMPLATE]');
client.updateInspectTemplate({name: formattedName})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is an object representing InspectTemplate. The promise has a method named "cancel" which cancels the ongoing API call.

updateJobTrigger(request[, options][, callback]) → Promise

Updates a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.

const dlp = require('@google-cloud/dlp');

const client = new dlp.v2.DlpServiceClient({
  // optional auth parameters.
});

const formattedName = client.projectJobTriggerPath('[PROJECT]', '[JOB_TRIGGER]');
client.updateJobTrigger({name: formattedName})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is an object representing JobTrigger. The promise has a method named "cancel" which cancels the ongoing API call.

updateStoredInfoType(request[, options][, callback]) → Promise

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/dlp/docs/creating-stored-infotypes to learn more.

const dlp = require('@google-cloud/dlp');

const client = new dlp.v2.DlpServiceClient({
  // optional auth parameters.
});

const formattedName = client.organizationStoredInfoTypePath('[ORGANIZATION]', '[STORED_INFO_TYPE]');
client.updateStoredInfoType({name: formattedName})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is an object representing StoredInfoType. The promise has a method named "cancel" which cancels the ongoing API call.