@datafire/google_dlp v6.0.0
@datafire/google_dlp
Client library for Cloud Data Loss Prevention (DLP) API
Installation and Usage
npm install --save @datafire/google_dlp
let google_dlp = require('@datafire/google_dlp').create({
access_token: "",
refresh_token: "",
client_id: "",
client_secret: "",
redirect_uri: ""
});
.then(data => {
console.log(data);
});
Description
Provides methods for detection, risk analysis, and de-identification of privacy-sensitive fragments in text, images, and Google Cloud Platform storage repositories.
Actions
oauthCallback
Exchange the code passed to your redirect URI for an access_token
google_dlp.oauthCallback({
"code": ""
}, context)
Input
- input
object
- code required
string
- code required
Output
- output
object
- access_token
string
- refresh_token
string
- token_type
string
- scope
string
- expiration
string
- access_token
oauthRefresh
Exchange a refresh_token for an access_token
google_dlp.oauthRefresh(null, context)
Input
This action has no parameters
Output
- output
object
- access_token
string
- refresh_token
string
- token_type
string
- scope
string
- expiration
string
- access_token
dlp.infoTypes.list
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.
google_dlp.dlp.infoTypes.list({}, context)
Input
- input
object
- filter
string
: filter to only return infoTypes supported by certain parts of the API. Defaults to supported_by=INSPECT. - languageCode
string
: BCP-47 language code for localized infoType friendly names. If omitted, or if localized strings are not available, en-US strings will be returned. - locationId
string
: Deprecated. This field has no effect. - parent
string
: The parent resource name. The format of this value is as follows: locations/ LOCATION_ID - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- filter
Output
dlp.projects.storedInfoTypes.delete
Deletes a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.
google_dlp.dlp.projects.storedInfoTypes.delete({
"name": ""
}, context)
Input
- input
object
- name required
string
: Required. Resource name of the organization and storedInfoType to be deleted, for exampleorganizations/433245324/storedInfoTypes/432452342
or projects/project-id/storedInfoTypes/432452342. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- name required
Output
- output GoogleProtobufEmpty
dlp.projects.storedInfoTypes.get
Gets a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.
google_dlp.dlp.projects.storedInfoTypes.get({
"name": ""
}, context)
Input
- input
object
- name required
string
: Required. Resource name of the organization and storedInfoType to be read, for exampleorganizations/433245324/storedInfoTypes/432452342
or projects/project-id/storedInfoTypes/432452342. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- name required
Output
dlp.projects.storedInfoTypes.patch
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.
google_dlp.dlp.projects.storedInfoTypes.patch({
"name": ""
}, context)
Input
- input
object
- name required
string
: Required. Resource name of organization and storedInfoType to be updated, for exampleorganizations/433245324/storedInfoTypes/432452342
or projects/project-id/storedInfoTypes/432452342. - body GooglePrivacyDlpV2UpdateStoredInfoTypeRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- name required
Output
dlp.projects.locations.jobTriggers.activate
Activate a job trigger. Causes the immediate execute of a trigger instead of waiting on the trigger event to occur.
google_dlp.dlp.projects.locations.jobTriggers.activate({
"name": ""
}, context)
Input
- input
object
- name required
string
: Required. Resource name of the trigger to activate, for exampleprojects/dlp-test-project/jobTriggers/53234423
. - body GooglePrivacyDlpV2ActivateJobTriggerRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- name required
Output
- output GooglePrivacyDlpV2DlpJob
dlp.projects.locations.dlpJobs.cancel
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.
google_dlp.dlp.projects.locations.dlpJobs.cancel({
"name": ""
}, context)
Input
- input
object
- name required
string
: Required. The name of the DlpJob resource to be cancelled. - body GooglePrivacyDlpV2CancelDlpJobRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- name required
Output
- output GoogleProtobufEmpty
dlp.projects.locations.dlpJobs.finish
Finish a running hybrid DlpJob. Triggers the finalization steps and running of any enabled actions that have not yet run. Early access feature is in a pre-release state and might change or have limited support. For more information, see https://cloud.google.com/products#product-launch-stages.
google_dlp.dlp.projects.locations.dlpJobs.finish({
"name": ""
}, context)
Input
- input
object
- name required
string
: Required. The name of the DlpJob resource to be cancelled. - body GooglePrivacyDlpV2FinishDlpJobRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- name required
Output
- output GoogleProtobufEmpty
dlp.projects.locations.jobTriggers.hybridInspect
Inspect hybrid content and store findings to a trigger. The inspection will be processed asynchronously. To review the findings monitor the jobs within the trigger. Early access feature is in a pre-release state and might change or have limited support. For more information, see https://cloud.google.com/products#product-launch-stages.
google_dlp.dlp.projects.locations.jobTriggers.hybridInspect({
"name": ""
}, context)
Input
- input
object
- name required
string
: Required. Resource name of the trigger to execute a hybrid inspect on, for exampleprojects/dlp-test-project/jobTriggers/53234423
. - body GooglePrivacyDlpV2HybridInspectJobTriggerRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- name required
Output
dlp.projects.locations.content.deidentify
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.
google_dlp.dlp.projects.locations.content.deidentify({
"parent": ""
}, context)
Input
- input
object
- parent required
string
: 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 exampleparent
string specifies a parent project with the identifierexample-project
, and specifies theeurope-west3
location for processing data: parent=projects/example-project/locations/europe-west3 - body GooglePrivacyDlpV2DeidentifyContentRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- parent required
Output
dlp.projects.locations.content.inspect
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,
google_dlp.dlp.projects.locations.content.inspect({
"parent": ""
}, context)
Input
- input
object
- parent required
string
: 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 exampleparent
string specifies a parent project with the identifierexample-project
, and specifies theeurope-west3
location for processing data: parent=projects/example-project/locations/europe-west3 - body GooglePrivacyDlpV2InspectContentRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- parent required
Output
dlp.projects.locations.content.reidentify
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.
google_dlp.dlp.projects.locations.content.reidentify({
"parent": ""
}, context)
Input
- input
object
- parent required
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 exampleparent
string specifies a parent project with the identifierexample-project
, and specifies theeurope-west3
location for processing data: parent=projects/example-project/locations/europe-west3 - body GooglePrivacyDlpV2ReidentifyContentRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- parent required
Output
dlp.projects.locations.deidentifyTemplates.list
Lists DeidentifyTemplates. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.
google_dlp.dlp.projects.locations.deidentifyTemplates.list({
"parent": ""
}, context)
Input
- input
object
- parent required
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 exampleparent
string specifies a parent project with the identifierexample-project
, and specifies theeurope-west3
location for processing data: parent=projects/example-project/locations/europe-west3 - locationId
string
: Deprecated. This field has no effect. - orderBy
string
: Comma separated list of fields to order by, followed byasc
ordesc
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 time the template was created. -update_time
: corresponds to time the template was last updated. -name
: corresponds to template's name. -display_name
: corresponds to template's display name. - pageSize
integer
: Size of the page, can be limited by server. If zero server returns a page of max size 100. - pageToken
string
: Page token to continue retrieval. Comes from previous call toListDeidentifyTemplates
. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- parent required
Output
dlp.projects.locations.deidentifyTemplates.create
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.
google_dlp.dlp.projects.locations.deidentifyTemplates.create({
"parent": ""
}, context)
Input
- input
object
- parent required
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 exampleparent
string specifies a parent project with the identifierexample-project
, and specifies theeurope-west3
location for processing data: parent=projects/example-project/locations/europe-west3 - body GooglePrivacyDlpV2CreateDeidentifyTemplateRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- parent required
Output
dlp.projects.locations.dlpJobs.list
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.
google_dlp.dlp.projects.locations.dlpJobs.list({
"parent": ""
}, context)
Input
- input
object
- parent required
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 exampleparent
string specifies a parent project with the identifierexample-project
, and specifies theeurope-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 byAND
orOR
logical operators. A sequence of restrictions implicitly usesAND
. 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 resource name of the trigger that created job. - 'end_time- Corresponds to time the job finished. - 'start_time
- Corresponds to time the job finished. Supported fields for risk analysis jobs: -state
- RUNNING|CANCELED|FINISHED|FAILED - 'end_time- Corresponds to time the job finished. - 'start_time
- Corresponds to 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. - locationId
string
: Deprecated. This field has no effect. - orderBy
string
: Comma separated list of fields to order by, followed byasc
ordesc
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 time the job was created. -end_time
: corresponds to time the job ended. -name
: corresponds to job's name. -state
: corresponds tostate
- pageSize
integer
: The standard list page size. - pageToken
string
: The standard list page token. - type
string
(values: DLP_JOB_TYPE_UNSPECIFIED, INSPECT_JOB, RISK_ANALYSIS_JOB): The type of job. Defaults toDlpJobType.INSPECT
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- parent required
Output
dlp.projects.locations.dlpJobs.create
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.
google_dlp.dlp.projects.locations.dlpJobs.create({
"parent": ""
}, context)
Input
- input
object
- parent required
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 exampleparent
string specifies a parent project with the identifierexample-project
, and specifies theeurope-west3
location for processing data: parent=projects/example-project/locations/europe-west3 - body GooglePrivacyDlpV2CreateDlpJobRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- parent required
Output
- output GooglePrivacyDlpV2DlpJob
dlp.projects.locations.image.redact
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.
google_dlp.dlp.projects.locations.image.redact({
"parent": ""
}, context)
Input
- input
object
- parent required
string
: 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 exampleparent
string specifies a parent project with the identifierexample-project
, and specifies theeurope-west3
location for processing data: parent=projects/example-project/locations/europe-west3 - body GooglePrivacyDlpV2RedactImageRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- parent required
Output
dlp.locations.infoTypes.list
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.
google_dlp.dlp.locations.infoTypes.list({
"parent": ""
}, context)
Input
- input
object
- parent required
string
: The parent resource name. The format of this value is as follows: locations/ LOCATION_ID - filter
string
: filter to only return infoTypes supported by certain parts of the API. Defaults to supported_by=INSPECT. - languageCode
string
: BCP-47 language code for localized infoType friendly names. If omitted, or if localized strings are not available, en-US strings will be returned. - locationId
string
: Deprecated. This field has no effect. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- parent required
Output
dlp.projects.locations.inspectTemplates.list
Lists InspectTemplates. See https://cloud.google.com/dlp/docs/creating-templates to learn more.
google_dlp.dlp.projects.locations.inspectTemplates.list({
"parent": ""
}, context)
Input
- input
object
- parent required
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 exampleparent
string specifies a parent project with the identifierexample-project
, and specifies theeurope-west3
location for processing data: parent=projects/example-project/locations/europe-west3 - locationId
string
: Deprecated. This field has no effect. - orderBy
string
: Comma separated list of fields to order by, followed byasc
ordesc
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 time the template was created. -update_time
: corresponds to time the template was last updated. -name
: corresponds to template's name. -display_name
: corresponds to template's display name. - pageSize
integer
: Size of the page, can be limited by server. If zero server returns a page of max size 100. - pageToken
string
: Page token to continue retrieval. Comes from previous call toListInspectTemplates
. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- parent required
Output
dlp.projects.locations.inspectTemplates.create
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.
google_dlp.dlp.projects.locations.inspectTemplates.create({
"parent": ""
}, context)
Input
- input
object
- parent required
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 exampleparent
string specifies a parent project with the identifierexample-project
, and specifies theeurope-west3
location for processing data: parent=projects/example-project/locations/europe-west3 - body GooglePrivacyDlpV2CreateInspectTemplateRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- parent required
Output
dlp.projects.locations.jobTriggers.list
Lists job triggers. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.
google_dlp.dlp.projects.locations.jobTriggers.list({
"parent": ""
}, context)
Input
- input
object
- parent required
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 exampleparent
string specifies a parent project with the identifierexample-project
, and specifies theeurope-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 byAND
orOR
logical operators. A sequence of restrictions implicitly usesAND
. A restriction has the form of{field} {operator} {value}
. Supported fields/values for inspect jobs: -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. - locationId
string
: Deprecated. This field has no effect. - orderBy
string
: Comma separated list of triggeredJob fields to order by, followed byasc
ordesc
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 time the JobTrigger was created. -update_time
: corresponds to time the JobTrigger was last updated. -last_run_time
: corresponds to the last time the JobTrigger ran. -name
: corresponds to JobTrigger's name. -display_name
: corresponds to JobTrigger's display name. -status
: corresponds to JobTrigger's status. - pageSize
integer
: Size of the page, can be limited by a server. - pageToken
string
: Page token to continue retrieval. Comes from previous call to ListJobTriggers.order_by
field must not change for subsequent calls. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- parent required
Output
dlp.projects.locations.jobTriggers.create
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.
google_dlp.dlp.projects.locations.jobTriggers.create({
"parent": ""
}, context)
Input
- input
object
- parent required
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 exampleparent
string specifies a parent project with the identifierexample-project
, and specifies theeurope-west3
location for processing data: parent=projects/example-project/locations/europe-west3 - body GooglePrivacyDlpV2CreateJobTriggerRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- parent required
Output
- output GooglePrivacyDlpV2JobTrigger
dlp.projects.storedInfoTypes.list
Lists stored infoTypes. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.
google_dlp.dlp.projects.storedInfoTypes.list({
"parent": ""
}, context)
Input
- input
object
- parent required
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 exampleparent
string specifies a parent project with the identifierexample-project
, and specifies theeurope-west3
location for processing data: parent=projects/example-project/locations/europe-west3 - locationId
string
: Deprecated. This field has no effect. - orderBy
string
: Comma separated list of fields to order by, followed byasc
ordesc
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 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. - pageSize
integer
: Size of the page, can be limited by server. If zero server returns a page of max size 100. - pageToken
string
: Page token to continue retrieval. Comes from previous call toListStoredInfoTypes
. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- parent required
Output
dlp.projects.storedInfoTypes.create
Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.
google_dlp.dlp.projects.storedInfoTypes.create({
"parent": ""
}, context)
Input
- input
object
- parent required
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 exampleparent
string specifies a parent project with the identifierexample-project
, and specifies theeurope-west3
location for processing data: parent=projects/example-project/locations/europe-west3 - body GooglePrivacyDlpV2CreateStoredInfoTypeRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- parent required
Output
Definitions
GooglePrivacyDlpV2Action
- GooglePrivacyDlpV2Action
object
: A task to execute on the completion of a job. See https://cloud.google.com/dlp/docs/concepts-actions to learn more.- jobNotificationEmails GooglePrivacyDlpV2JobNotificationEmails
- pubSub GooglePrivacyDlpV2PublishToPubSub
- publishFindingsToCloudDataCatalog GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog
- publishSummaryToCscc GooglePrivacyDlpV2PublishSummaryToCscc
- publishToStackdriver GooglePrivacyDlpV2PublishToStackdriver
- saveFindings GooglePrivacyDlpV2SaveFindings
GooglePrivacyDlpV2ActivateJobTriggerRequest
- GooglePrivacyDlpV2ActivateJobTriggerRequest
object
: Request message for ActivateJobTrigger.
GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails
- GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails
object
: Result of a risk analysis operation request.- categoricalStatsResult GooglePrivacyDlpV2CategoricalStatsResult
- deltaPresenceEstimationResult GooglePrivacyDlpV2DeltaPresenceEstimationResult
- kAnonymityResult GooglePrivacyDlpV2KAnonymityResult
- kMapEstimationResult GooglePrivacyDlpV2KMapEstimationResult
- lDiversityResult GooglePrivacyDlpV2LDiversityResult
- numericalStatsResult GooglePrivacyDlpV2NumericalStatsResult
- requestedOptions GooglePrivacyDlpV2RequestedRiskAnalysisOptions
- requestedPrivacyMetric GooglePrivacyDlpV2PrivacyMetric
- requestedSourceTable GooglePrivacyDlpV2BigQueryTable
GooglePrivacyDlpV2AuxiliaryTable
- GooglePrivacyDlpV2AuxiliaryTable
object
: An auxiliary table contains statistical information on the relative frequency of different quasi-identifiers values. It has one or several quasi-identifiers columns, and one column that indicates the relative frequency of each quasi-identifier tuple. If a tuple is present in the data but not in the auxiliary table, the corresponding relative frequency is assumed to be zero (and thus, the tuple is highly reidentifiable).- quasiIds
array
: Required. Quasi-identifier columns. - relativeFrequency GooglePrivacyDlpV2FieldId
- table GooglePrivacyDlpV2BigQueryTable
- quasiIds
GooglePrivacyDlpV2BigQueryField
- GooglePrivacyDlpV2BigQueryField
object
: Message defining a field of a BigQuery table.
GooglePrivacyDlpV2BigQueryKey
- GooglePrivacyDlpV2BigQueryKey
object
: Row key for identifying a record in BigQuery table.- rowNumber
string
: Row number inferred at the time the table was scanned. This value is nondeterministic, cannot be queried, and may be null for inspection jobs. To locate findings within a table, specifyinspect_job.storage_config.big_query_options.identifying_fields
inCreateDlpJobRequest
. - tableReference GooglePrivacyDlpV2BigQueryTable
- rowNumber
GooglePrivacyDlpV2BigQueryOptions
- GooglePrivacyDlpV2BigQueryOptions
object
: Options defining BigQuery table and row identifiers.- excludedFields
array
: References to fields excluded from scanning. This allows you to skip inspection of entire columns which you know have no findings. - identifyingFields
array
: Table fields that may uniquely identify a row within the table. Whenactions.saveFindings.outputConfig.table
is specified, the values of columns specified here are available in the output table underlocation.content_locations.record_location.record_key.id_values
. Nested fields such asperson.birthdate.year
are allowed. - rowsLimit
string
: Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. - rowsLimitPercent
integer
: Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. - sampleMethod
string
(values: SAMPLE_METHOD_UNSPECIFIED, TOP, RANDOM_START) - tableReference GooglePrivacyDlpV2BigQueryTable
- excludedFields
GooglePrivacyDlpV2BigQueryTable
- GooglePrivacyDlpV2BigQueryTable
object
: Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of::.
or..
.- datasetId
string
: Dataset ID of the table. - projectId
string
: The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. - tableId
string
: Name of the table.
- datasetId
GooglePrivacyDlpV2BoundingBox
- GooglePrivacyDlpV2BoundingBox
object
: Bounding box encompassing detected text within an image.- height
integer
: Height of the bounding box in pixels. - left
integer
: Left coordinate of the bounding box. (0,0) is upper left. - top
integer
: Top coordinate of the bounding box. (0,0) is upper left. - width
integer
: Width of the bounding box in pixels.
- height
GooglePrivacyDlpV2Bucket
- GooglePrivacyDlpV2Bucket
object
: Bucket is represented as a range, along with replacement values.- max GooglePrivacyDlpV2Value
- min GooglePrivacyDlpV2Value
- replacementValue GooglePrivacyDlpV2Value
GooglePrivacyDlpV2BucketingConfig
- GooglePrivacyDlpV2BucketingConfig
object
: Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW 31-65 -> MEDIUM 66-100 -> HIGH This can be used on data of type: number, long, string, timestamp. If the boundValue
type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/dlp/docs/concepts-bucketing to learn more.- buckets
array
: Set of buckets. Ranges must be non-overlapping.- items GooglePrivacyDlpV2Bucket
- buckets
GooglePrivacyDlpV2ByteContentItem
- GooglePrivacyDlpV2ByteContentItem
object
: Container for bytes to inspect or redact.- data
string
: Content data to inspect or redact. - type
string
(values: BYTES_TYPE_UNSPECIFIED, IMAGE, IMAGE_JPEG, IMAGE_BMP, IMAGE_PNG, IMAGE_SVG, TEXT_UTF8, WORD_DOCUMENT, PDF, AVRO, CSV, TSV): The type of data stored in the bytes string. Default will be TEXT_UTF8.
- data
GooglePrivacyDlpV2CancelDlpJobRequest
- GooglePrivacyDlpV2CancelDlpJobRequest
object
: The request message for canceling a DLP job.
GooglePrivacyDlpV2CategoricalStatsConfig
- GooglePrivacyDlpV2CategoricalStatsConfig
object
: Compute numerical stats over an individual column, including number of distinct values and value count distribution.
GooglePrivacyDlpV2CategoricalStatsHistogramBucket
- GooglePrivacyDlpV2CategoricalStatsHistogramBucket
object
: Histogram of value frequencies in the column.- bucketSize
string
: Total number of values in this bucket. - bucketValueCount
string
: Total number of distinct values in this bucket. - bucketValues
array
: Sample of value frequencies in this bucket. The total number of values returned per bucket is capped at 20. - valueFrequencyLowerBound
string
: Lower bound on the value frequency of the values in this bucket. - valueFrequencyUpperBound
string
: Upper bound on the value frequency of the values in this bucket.
- bucketSize
GooglePrivacyDlpV2CategoricalStatsResult
- GooglePrivacyDlpV2CategoricalStatsResult
object
: Result of the categorical stats computation.- valueFrequencyHistogramBuckets
array
: Histogram of value frequencies in the column.
- valueFrequencyHistogramBuckets
GooglePrivacyDlpV2CharacterMaskConfig
- GooglePrivacyDlpV2CharacterMaskConfig
object
: Partially mask a string by replacing a given number of characters with a fixed character. Masking can start from the beginning or end of the string. This can be used on data of any type (numbers, longs, and so on) and when de-identifying structured data we'll attempt to preserve the original data's type. (This allows you to take a long like 123 and modify it to a string like **3.- charactersToIgnore
array
: When masking a string, items in this list will be skipped when replacing characters. For example, if the input string is555-555-5555
and you instruct Cloud DLP to skip-
and mask 5 characters with*
, Cloud DLP returns***-**5-5555
. - maskingCharacter
string
: Character to use to mask the sensitive values—for example,*
for an alphabetic string such as a name, or0
for a numeric string such as ZIP code or credit card number. This string must have a length of 1. If not supplied, this value defaults to*
for strings, and0
for digits. - numberToMask
integer
: Number of characters to mask. If not set, all matching chars will be masked. Skipped characters do not count towards this tally. - reverseOrder
boolean
: Mask characters in reverse order. For example, ifmasking_character
is0
,number_to_mask
is14
, andreverse_order
isfalse
, then the input string1234-5678-9012-3456
is masked as00000000000000-3456
. Ifmasking_character
is*
,number_to_mask
is3
, andreverse_order
istrue
, then the string12345
is masked as12***
.
- charactersToIgnore
GooglePrivacyDlpV2CharsToIgnore
- GooglePrivacyDlpV2CharsToIgnore
object
: Characters to skip when doing deidentification of a value. These will be left alone and skipped.- charactersToSkip
string
: Characters to not transform when masking. - commonCharactersToIgnore
string
(values: COMMON_CHARS_TO_IGNORE_UNSPECIFIED, NUMERIC, ALPHA_UPPER_CASE, ALPHA_LOWER_CASE, PUNCTUATION, WHITESPACE): Common characters to not transform when masking. Useful to avoid removing punctuation.
- charactersToSkip
GooglePrivacyDlpV2CloudStorageFileSet
- GooglePrivacyDlpV2CloudStorageFileSet
object
: Message representing a set of files in Cloud Storage.- url
string
: The url, in the formatgs:///
. Trailing wildcard in the path is allowed.
- url
GooglePrivacyDlpV2CloudStorageOptions
- GooglePrivacyDlpV2CloudStorageOptions
object
: Options defining a file or a set of files within a Google Cloud Storage bucket.- bytesLimitPerFile
string
: Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omit
- bytesLimitPerFile