package google.privacy.dlp.v2
Get desktop application:
View/edit binary Protocol Buffers messages
service DlpService
dlp.proto:44The Cloud Data Loss Prevention (DLP) API is a service that allows clients to detect the presence of Personally Identifiable Information (PII) and other privacy-sensitive data in user-supplied, unstructured data streams, like text blocks or images. The service also includes methods for sensitive data redaction and scheduling of data scans on Google Cloud Platform based data sets.
rpc CancelDlpJob (, )
dlp.proto:276Starts asynchronous cancellation on a long-running DlpJob. The server makes a best effort to cancel the DlpJob, but success is not guaranteed.
message
dlp.proto:2291The request message for canceling a DLP job.
string name = 1
The name of the DlpJob resource to be cancelled.
Creates a DeidentifyTemplate for re-using frequently used configuration for de-identifying content, images, and storage.
message
dlp.proto:2303Request message for CreateDeidentifyTemplate.
string parent = 1
The parent resource name, for example projects/my-project-id or organizations/my-org-id.
optional deidentify_template = 2
The DeidentifyTemplate to create.
string template_id = 3
The template id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `[a-zA-Z\\d-]+`. The maximum length is 100 characters. Can be empty to allow the system to generate one.
rpc CreateDlpJob (, )
dlp.proto:243Creates a new job to inspect storage or calculate risk metrics. [How-to guide](/dlp/docs/compute-risk-analysis).
message
dlp.proto:2099Request message for CreateDlpJobRequest. Used to initiate long running jobs such as calculating risk metrics or inspecting Google Cloud Storage.
string parent = 1
The parent resource name, for example projects/my-project-id.
oneof job
The configuration details for the specific type of job to run.
inspect_job = 2
risk_job = 3
string job_id = 4
The job id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `[a-zA-Z\\d-]+`. The maximum length is 100 characters. Can be empty to allow the system to generate one.
rpc CreateInspectTemplate (, )
dlp.proto:95Creates an InspectTemplate for re-using frequently used configuration for inspecting content, images, and storage.
message
dlp.proto:1991Request message for CreateInspectTemplate.
string parent = 1
The parent resource name, for example projects/my-project-id or organizations/my-org-id.
optional inspect_template = 2
The InspectTemplate to create.
string template_id = 3
The template id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `[a-zA-Z\\d-]+`. The maximum length is 100 characters. Can be empty to allow the system to generate one.
rpc CreateJobTrigger (, )
dlp.proto:205Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule.
message
dlp.proto:2062Request message for CreateJobTrigger.
string parent = 1
The parent resource name, for example projects/my-project-id.
optional job_trigger = 2
The JobTrigger to create.
string trigger_id = 3
The trigger id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `[a-zA-Z\\d-]+`. The maximum length is 100 characters. Can be empty to allow the system to generate one.
rpc DeidentifyContent (, )
dlp.proto:69De-identifies potentially sensitive info from a ContentItem. This method has limits on input size and output size. [How-to guide](/dlp/docs/deidentify-sensitive-data)
message
dlp.proto:600Request to de-identify a list of items.
string parent = 1
The parent resource name, for example projects/my-project-id.
optional deidentify_config = 2
Configuration for the de-identification of the content item. Items specified here will override the template referenced by the deidentify_template_name argument.
optional inspect_config = 3
Configuration for the inspector. Items specified here will override the template referenced by the inspect_template_name argument.
optional item = 4
The item to de-identify. Will be treated as text.
string inspect_template_name = 5
Optional template to use. Any configuration directly specified in inspect_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.
string deidentify_template_name = 6
Optional template to use. Any configuration directly specified in deidentify_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.
message
dlp.proto:633Results of de-identifying a ContentItem.
optional item = 1
The de-identified item.
optional overview = 2
An overview of the changes that were made on the `item`.
Deletes a DeidentifyTemplate.
message
dlp.proto:2367Request message for DeleteDeidentifyTemplate.
string name = 1
Resource name of the organization and deidentify template to be deleted, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342.
rpc DeleteDlpJob (, )
dlp.proto:267Deletes 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.
message
dlp.proto:2297The request message for deleting a DLP job.
string name = 1
The name of the DlpJob resource to be deleted.
rpc DeleteInspectTemplate (, )
dlp.proto:139Deletes an InspectTemplate.
message
dlp.proto:2054Request message for DeleteInspectTemplate.
string name = 1
Resource name of the organization and inspectTemplate to be deleted, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342.
rpc DeleteJobTrigger (, )
dlp.proto:235Deletes a job trigger.
message
dlp.proto:2157Request message for DeleteJobTrigger.
string name = 1
Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`.
rpc GetDeidentifyTemplate (, )
dlp.proto:174Gets a DeidentifyTemplate.
message
dlp.proto:2333Request message for GetDeidentifyTemplate.
string name = 1
Resource name of the organization and deidentify template to be read, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342.
rpc GetDlpJob (, )
dlp.proto:258Gets the latest state of a long-running DlpJob.
message
dlp.proto:2236The request message for [DlpJobs.GetDlpJob][].
string name = 1
The name of the DlpJob resource.
rpc GetInspectTemplate (, )
dlp.proto:119Gets an InspectTemplate.
message
dlp.proto:2021Request message for GetInspectTemplate.
string name = 1
Resource name of the organization and inspectTemplate to be read, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342.
rpc GetJobTrigger (, )
dlp.proto:221Gets a job trigger.
message
dlp.proto:2090Request message for GetJobTrigger.
string name = 1
Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`.
rpc InspectContent (, )
dlp.proto:49Finds potentially sensitive info in content. This method has limits on input size, processing time, and output size. [How-to guide for text](/dlp/docs/inspecting-text), [How-to guide for images](/dlp/docs/inspecting-images)
message
dlp.proto:689Request to search for potentially sensitive info in a ContentItem.
string parent = 1
The parent resource name, for example projects/my-project-id.
optional inspect_config = 2
Configuration for the inspector. What specified here will override the template referenced by the inspect_template_name argument.
optional item = 3
The item to inspect.
string inspect_template_name = 4
Optional template to use. Any configuration directly specified in inspect_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.
message
dlp.proto:709Results of inspecting an item.
optional result = 1
The findings.
rpc ListDeidentifyTemplates (, )
dlp.proto:184Lists DeidentifyTemplates.
message
dlp.proto:2341Request message for ListDeidentifyTemplates.
string parent = 1
The parent resource name, for example projects/my-project-id or organizations/my-org-id.
string page_token = 2
Optional page token to continue retrieval. Comes from previous call to `ListDeidentifyTemplates`.
int32 page_size = 3
Optional size of the page, can be limited by server. If zero server returns a page of max size 100.
message
dlp.proto:2356Response message for ListDeidentifyTemplates.
repeated deidentify_templates = 1
List of deidentify templates, up to page_size in ListDeidentifyTemplatesRequest.
string next_page_token = 2
If the next page is available then the next page token to be used in following ListDeidentifyTemplates request.
rpc ListDlpJobs (, )
dlp.proto:251Lists DlpJobs that match the specified filter in the request.
message
dlp.proto:2242The request message for listing DLP jobs.
string parent = 4
The parent resource name, for example projects/my-project-id.
string filter = 1
Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `<field> <operator> <value>`. * Supported fields/values 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. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED * 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) The length of this field should be no more than 500 characters.
int32 page_size = 2
The standard list page size.
string page_token = 3
The standard list page token.
DlpJobType type = 5
The type of job. Defaults to `DlpJobType.INSPECT`
message
dlp.proto:2282The response message for listing DLP jobs.
repeated jobs = 1
A list of DlpJobs that matches the specified filter in the request.
string next_page_token = 2
The standard List next-page token.
rpc ListInfoTypes (, )
dlp.proto:87Returns a list of the sensitive information types that the DLP API supports. For more information, see [Listing supported predefined infoTypes](/dlp/docs/listing-infotypes).
message
dlp.proto:808Request for the list of infoTypes.
string language_code = 1
Optional BCP-47 language code for localized infoType friendly names. If omitted, or if localized strings are not available, en-US strings will be returned.
string filter = 2
Optional filter to only return infoTypes supported by certain parts of the API. Defaults to supported_by=INSPECT.
message
dlp.proto:820Response to the ListInfoTypes request.
repeated info_types = 1
Set of sensitive infoTypes.
rpc ListInspectTemplates (, )
dlp.proto:129Lists InspectTemplates.
message
dlp.proto:2029Request message for ListInspectTemplates.
string parent = 1
The parent resource name, for example projects/my-project-id or organizations/my-org-id.
string page_token = 2
Optional page token to continue retrieval. Comes from previous call to `ListInspectTemplates`.
int32 page_size = 3
Optional size of the page, can be limited by server. If zero server returns a page of max size 100.
message
dlp.proto:2044Response message for ListInspectTemplates.
repeated inspect_templates = 1
List of inspectTemplates, up to page_size in ListInspectTemplatesRequest.
string next_page_token = 2
If the next page is available then the next page token to be used in following ListInspectTemplates request.
rpc ListJobTriggers (, )
dlp.proto:228Lists job triggers.
message
dlp.proto:2118Request message for ListJobTriggers.
string parent = 1
The parent resource name, for example projects/my-project-id.
string page_token = 2
Optional page token to continue retrieval. Comes from previous call to ListJobTriggers. `order_by` and `filter` should not change for subsequent calls, but can be omitted if token is specified.
int32 page_size = 3
Optional size of the page, can be limited by a server.
string order_by = 4
Optional comma separated list of triggeredJob fields to order by, followed by 'asc/desc' postfix, i.e. `"create_time asc,name desc,schedule_mode asc"`. This list is case-insensitive. Example: `"name asc,schedule_mode desc, status desc"` Supported filters keys and values are: - `create_time`: corresponds to time the triggeredJob was created. - `update_time`: corresponds to time the triggeredJob was last updated. - `name`: corresponds to JobTrigger's display name. - `status`: corresponds to the triggeredJob status.
message
dlp.proto:2147Response message for ListJobTriggers.
repeated job_triggers = 1
List of triggeredJobs, up to page_size in ListJobTriggersRequest.
string next_page_token = 2
If the next page is available then the next page token to be used in following ListJobTriggers request.
rpc RedactImage (, )
dlp.proto:59Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. [How-to guide](/dlp/docs/redacting-sensitive-data-images)
message
dlp.proto:542Request to search for potentially sensitive info in a list of items and replace it with a default or provided content.
string parent = 1
The parent resource name, for example projects/my-project-id.
optional inspect_config = 2
Configuration for the inspector.
repeated image_redaction_configs = 5
The configuration for specifying what content to redact from images.
optional byte_item = 7
The content must be PNG, JPEG, SVG or BMP.
message
dlp.proto:589Results of redacting an image.
bytes redacted_image = 1
The redacted image. The type will be the same as the original image.
string extracted_text = 2
If an image was being inspected and the InspectConfig's include_quote was set to true, then this field will include all text, if any, that was found in the image.
rpc ReidentifyContent (, )
dlp.proto:77Re-identifies content that has been de-identified.
message
dlp.proto:642Request to re-identify an item.
string parent = 1
The parent resource name.
optional reidentify_config = 2
Configuration for the re-identification of the content item. This field shares the same proto message type that is used for de-identification, however its usage here is for the reversal of the previous de-identification. Re-identification is performed by examining the transformations used to de-identify the items and executing the reverse. This requires that only reversible transformations be provided here. The reversible transformations are: - `CryptoReplaceFfxFpeConfig`
optional inspect_config = 3
Configuration for the inspector.
optional item = 4
The item to re-identify. Will be treated as text.
string inspect_template_name = 5
Optional template to use. Any configuration directly specified in `inspect_config` will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.
string reidentify_template_name = 6
Optional template to use. References an instance of `DeidentifyTemplate`. Any configuration directly specified in `reidentify_config` or `inspect_config` will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.
message
dlp.proto:680Results of re-identifying a item.
optional item = 1
The re-identified item.
optional overview = 2
An overview of the changes that were made to the `item`.
Updates the DeidentifyTemplate.
message
dlp.proto:2319Request message for UpdateDeidentifyTemplate.
string name = 1
Resource name of organization and deidentify template to be updated, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342.
optional deidentify_template = 2
New DeidentifyTemplate value.
optional update_mask = 3
Mask to control which fields get updated.
rpc UpdateInspectTemplate (, )
dlp.proto:107Updates the InspectTemplate.
message
dlp.proto:2007Request message for UpdateInspectTemplate.
string name = 1
Resource name of organization and inspectTemplate to be updated, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342.
optional inspect_template = 2
New InspectTemplate value.
optional update_mask = 3
Mask to control which fields get updated.
rpc UpdateJobTrigger (, )
dlp.proto:213Updates a job trigger.
message
dlp.proto:2077Request message for UpdateJobTrigger.
string name = 1
Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`.
optional job_trigger = 2
New JobTrigger value.
optional update_mask = 3
Mask to control which fields get updated.
message
dlp.proto:1945A task to execute on the completion of a job.
Used in: ,
oneof action
save_findings = 1
Save resulting findings in a provided location.
pub_sub = 2
Publish a notification to a pubsub topic.
publish_summary_to_cscc = 3
Publish summary to Cloud Security Command Center (Alpha).
message
dlp.proto:1974Publish the result summary of a DlpJob to the Cloud Security Command Center (CSCC Alpha). This action is only available for projects which are parts of an organization and whitelisted for the alpha Cloud Security Command Center. The action will publish count of finding instances and their info types. The summary of findings will be persisted in CSCC and are governed by CSCC service-specific policy, see https://cloud.google.com/terms/service-terms Only a single instance of this action can be specified. Compatible with: Inspect
Used in:
(message has no fields)
message
dlp.proto:1956Publish the results of a DlpJob to a pub sub channel. Compatible with: Inspect, Risk
Used in:
string topic = 1
Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}.
message
dlp.proto:1950If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect
Used in:
optional output_config = 1
message
dlp.proto:982Result of a risk analysis operation request.
Used in:
optional requested_privacy_metric = 1
Privacy metric to compute.
optional requested_source_table = 2
Input dataset to compute metrics over.
oneof result
Values associated with this metric.
numerical_stats_result = 3
categorical_stats_result = 4
k_anonymity_result = 5
l_diversity_result = 6
k_map_estimation_result = 7
message
dlp.proto:997Result of the categorical stats computation.
Used in:
repeated value_frequency_histogram_buckets = 5
Histogram of value frequencies in the column.
message
dlp.proto:998Used in:
int64 value_frequency_lower_bound = 1
Lower bound on the value frequency of the values in this bucket.
int64 value_frequency_upper_bound = 2
Upper bound on the value frequency of the values in this bucket.
int64 bucket_size = 3
Total number of values in this bucket.
repeated bucket_values = 4
Sample of value frequencies in this bucket. The total number of values returned per bucket is capped at 20.
int64 bucket_value_count = 5
Total number of distinct values in this bucket.
message
dlp.proto:1021Result of the k-anonymity computation.
Used in:
repeated equivalence_class_histogram_buckets = 5
Histogram of k-anonymity equivalence classes.
message
dlp.proto:1023The set of columns' values that share the same ldiversity value
Used in:
repeated quasi_ids_values = 1
Set of values defining the equivalence class. One value per quasi-identifier column in the original KAnonymity metric message. The order is always the same as the original request.
int64 equivalence_class_size = 2
Size of the equivalence class, for example number of rows with the above set of values.
message
dlp.proto:1034Used in:
int64 equivalence_class_size_lower_bound = 1
Lower bound on the size of the equivalence classes in this bucket.
int64 equivalence_class_size_upper_bound = 2
Upper bound on the size of the equivalence classes in this bucket.
int64 bucket_size = 3
Total number of equivalence classes in this bucket.
repeated bucket_values = 4
Sample of equivalence classes in this bucket. The total number of classes returned per bucket is capped at 20.
int64 bucket_value_count = 5
Total number of distinct equivalence classes in this bucket.
message
dlp.proto:1100Result of the reidentifiability analysis. Note that these results are an estimation, not exact values.
Used in:
repeated k_map_estimation_histogram = 1
The intervals [min_anonymity, max_anonymity] do not overlap. If a value doesn't correspond to any such interval, the associated frequency is zero. For example, the following records: {min_anonymity: 1, max_anonymity: 1, frequency: 17} {min_anonymity: 2, max_anonymity: 3, frequency: 42} {min_anonymity: 5, max_anonymity: 10, frequency: 99} mean that there are no record with an estimated anonymity of 4, 5, or larger than 10.
message
dlp.proto:1118A KMapEstimationHistogramBucket message with the following values: min_anonymity: 3 max_anonymity: 5 frequency: 42 means that there are 42 records whose quasi-identifier values correspond to 3, 4 or 5 people in the overlying population. An important particular case is when min_anonymity = max_anonymity = 1: the frequency field then corresponds to the number of uniquely identifiable records.
Used in:
int64 min_anonymity = 1
Always positive.
int64 max_anonymity = 2
Always greater than or equal to min_anonymity.
int64 bucket_size = 5
Number of records within these anonymity bounds.
repeated bucket_values = 6
Sample of quasi-identifier tuple values in this bucket. The total number of classes returned per bucket is capped at 20.
int64 bucket_value_count = 7
Total number of distinct quasi-identifier tuple values in this bucket.
message
dlp.proto:1102A tuple of values for the quasi-identifier columns.
Used in:
repeated quasi_ids_values = 1
The quasi-identifier values.
int64 estimated_anonymity = 2
The estimated anonymity for these quasi-identifier values.
message
dlp.proto:1057Result of the l-diversity computation.
Used in:
repeated sensitive_value_frequency_histogram_buckets = 5
Histogram of l-diversity equivalence class sensitive value frequencies.
message
dlp.proto:1059The set of columns' values that share the same ldiversity value.
Used in:
repeated quasi_ids_values = 1
Quasi-identifier values defining the k-anonymity equivalence class. The order is always the same as the original request.
int64 equivalence_class_size = 2
Size of the k-anonymity equivalence class.
int64 num_distinct_sensitive_values = 3
Number of distinct sensitive values in this equivalence class.
repeated top_sensitive_values = 4
Estimated frequencies of top sensitive values.
message
dlp.proto:1074Used in:
int64 sensitive_value_frequency_lower_bound = 1
Lower bound on the sensitive value frequencies of the equivalence classes in this bucket.
int64 sensitive_value_frequency_upper_bound = 2
Upper bound on the sensitive value frequencies of the equivalence classes in this bucket.
int64 bucket_size = 3
Total number of equivalence classes in this bucket.
repeated bucket_values = 4
Sample of equivalence classes in this bucket. The total number of classes returned per bucket is capped at 20.
int64 bucket_value_count = 5
Total number of distinct equivalence classes in this bucket.
message
dlp.proto:984Result of the numerical stats computation.
Used in:
optional min_value = 1
Minimum value appearing in the column.
optional max_value = 2
Maximum value appearing in the column.
repeated quantile_values = 4
List of 99 values that partition the set of field values into 100 equal sized buckets.
message
storage.proto:339Row key for identifying a record in BigQuery table.
Used in:
optional table_reference = 1
Complete BigQuery table reference.
int64 row_number = 2
Absolute number of the row from the beginning of the table at the time of scanning.
message
storage.proto:267Options defining BigQuery table and row identifiers.
Used in:
optional table_reference = 1
Complete BigQuery table reference.
repeated identifying_fields = 2
References to fields uniquely identifying rows within the table. Nested fields in the format, like `person.birthdate.year`, are allowed.
int64 rows_limit = 3
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. Cannot be used in conjunction with TimespanConfig.
BigQueryOptions.SampleMethod sample_method = 4
How to sample rows if not all rows are scanned. Meaningful only when used in conjunction with rows_limit. If not specified, scanning would start from the top.
Used in:
SAMPLE_METHOD_UNSPECIFIED = 0
TOP = 1
Scan from the top (default).
RANDOM_START = 2
Randomly pick the row to start scanning. The scanned rows are contiguous.
message
storage.proto:416Message 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: `<project_id>:<dataset_id>.<table_id>` or `<project_id>.<dataset_id>.<table_id>`.
Used in: , , , , ,
string project_id = 1
The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call.
string dataset_id = 2
Dataset ID of the table.
string table_id = 3
Name of the table.
message
dlp.proto:526Bounding box encompassing detected text within an image.
Used in:
int32 top = 1
Top coordinate of the bounding box. (0,0) is upper left.
int32 left = 2
Left coordinate of the bounding box. (0,0) is upper left.
int32 width = 3
Width of the bounding box in pixels.
int32 height = 4
Height of the bounding box in pixels.
message
dlp.proto:1425Generalization 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 bound `Value` 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.
Used in:
repeated buckets = 1
Set of buckets. Ranges must be non-overlapping.
message
dlp.proto:1427Bucket is represented as a range, along with replacement values.
Used in:
optional min = 1
Lower bound of the range, inclusive. Type should be the same as max if used.
optional max = 2
Upper bound of the range, exclusive; type must match min.
optional replacement_value = 3
Replacement value for this bucket. If not provided the default behavior will be to hyphenate the min-max range.
message
dlp.proto:343Container for bytes to inspect or redact.
Used in: ,
ByteContentItem.BytesType type = 1
The type of data stored in the bytes string. Default will be TEXT_UTF8.
bytes data = 2
Content data to inspect or redact.
Used in:
BYTES_TYPE_UNSPECIFIED = 0
IMAGE = 6
IMAGE_JPEG = 1
IMAGE_BMP = 2
IMAGE_PNG = 3
IMAGE_SVG = 4
TEXT_UTF8 = 5
message
dlp.proto:1360Partially 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.
Used in:
string masking_character = 1
Character to mask the sensitive values—for example, "*" for an alphabetic string such as name, or "0" for a numeric string such as ZIP code or credit card number. String must have length 1. If not supplied, we will default to "*" for strings, 0 for digits.
int32 number_to_mask = 2
Number of characters to mask. If not set, all matching chars will be masked. Skipped characters do not count towards this tally.
bool reverse_order = 3
Mask characters in reverse order. For example, if `masking_character` is '0', number_to_mask is 14, and `reverse_order` is false, then 1234-5678-9012-3456 -> 00000000000000-3456 If `masking_character` is '*', `number_to_mask` is 3, and `reverse_order` is true, then 12345 -> 12***
repeated characters_to_ignore = 4
When masking a string, items in this list will be skipped when replacing. For example, if your string is 555-555-5555 and you ask us to skip `-` and mask 5 chars with * we would produce ***-*55-5555.
message
dlp.proto:1327Characters to skip when doing deidentification of a value. These will be left alone and skipped.
Used in:
oneof characters
string characters_to_skip = 1
CharsToIgnore.CommonCharsToIgnore common_characters_to_ignore = 2
Used in:
COMMON_CHARS_TO_IGNORE_UNSPECIFIED = 0
NUMERIC = 1
0-9
ALPHA_UPPER_CASE = 2
A-Z
ALPHA_LOWER_CASE = 3
a-z
PUNCTUATION = 4
US Punctuation, one of !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~
WHITESPACE = 5
Whitespace character, one of [ \t\n\x0B\f\r]
message
storage.proto:218Options defining a file or a set of files (path ending with *) within a Google Cloud Storage bucket.
Used in:
optional file_set = 1
int64 bytes_limit_per_file = 4
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 omitted.
repeated FileType file_types = 5
List of file type groups to include in the scan. If empty, all files are scanned and available data format processors are applied.
CloudStorageOptions.SampleMethod sample_method = 6
int32 files_limit_percent = 7
Limits the number of files to scan to this percentage of the input FileSet. Number of files scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0.
message
storage.proto:220Set of files to scan.
Used in:
string url = 1
The url, in the format `gs://<bucket>/<path>`. Trailing wildcard in the path is allowed.
How to sample bytes if not all bytes are scanned. Meaningful only when used in conjunction with bytes_limit_per_file. If not specified, scanning would start from the top.
Used in:
SAMPLE_METHOD_UNSPECIFIED = 0
TOP = 1
Scan from the top (default).
RANDOM_START = 2
For each file larger than bytes_limit_per_file, randomly pick the offset to start scanning. The scanned bytes are contiguous.
message
storage.proto:260Message representing a single file or path in Cloud Storage.
Used in:
string path = 1
A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt
message
dlp.proto:577Represents a color in the RGB color space.
Used in:
float red = 1
The amount of red in the color as a value in the interval [0, 1].
float green = 2
The amount of green in the color as a value in the interval [0, 1].
float blue = 3
The amount of blue in the color as a value in the interval [0, 1].
message
dlp.proto:368Container structure for the content to inspect.
Used in: , , , ,
oneof data_item
Data of the item either in the byte array or UTF-8 string form, or table.
string value = 3
String data to inspect or redact.
table = 4
Structured content for inspection.
byte_item = 5
Content data to inspect or redact. Replaces `type` and `data`.
message
dlp.proto:455Findings container location data.
Used in:
string container_name = 1
Name of the container where the finding is located. The top level name is the source file name or table name. Nested names could be absent if the embedded object has no string identifier (for an example an image contained within a document).
oneof location
Type of the container within the file with location of the finding.
record_location = 2
Location within a row or record of a database table.
image_location = 3
Location within an image's pixels.
document_location = 5
Location data for document files.
optional container_timestamp = 6
Findings container modification timestamp, if applicable. For Google Cloud Storage contains last file modification timestamp. For BigQuery table contains last_modified_time property. For Datastore - not populated.
string container_version = 7
Findings container version, if available ("generation" for Google Cloud Storage).
Options describing which parts of the provided content should be scanned.
Used in:
CONTENT_UNSPECIFIED = 0
Includes entire content of a file or a data stream.
CONTENT_TEXT = 1
Text content within the data, excluding any metadata.
CONTENT_IMAGE = 2
Images found in the data.
message
dlp.proto:1302Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a 32 byte digest as an uppercase hex string (for example, 41D1567F7F99F1DC2A5FAB886DEE5BEE). Currently, only string and integer values can be hashed.
Used in:
optional crypto_key = 1
The key used by the hash function.
message
dlp.proto:1548This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by KMS). When using KMS to wrap/unwrap DEKs, be sure to set an appropriate IAM policy on the KMS CryptoKey (KEK) to ensure an attacker cannot unwrap the data crypto key.
Used in: , ,
oneof source
transient = 1
unwrapped = 2
kms_wrapped = 3
message
dlp.proto:1454Replaces an identifier with a surrogate using FPE with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See [Pseudonymization](/dlp/docs/pseudonymization) for example usage.
Used in:
optional crypto_key = 1
The key used by the encryption algorithm. [required]
optional context = 2
The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and non-structured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2
oneof alphabet
CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabet common_alphabet = 4
string custom_alphabet = 5
This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 62]. This must be encoded as ASCII. The order of characters does not matter.
int32 radix = 6
The native way to select the alphabet. Must be in the range [2, 62].
optional surrogate_info_type = 8
The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](/dlp/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE
These are commonly used subsets of the alphabet that the FFX mode natively supports. In the algorithm, the alphabet is selected using the "radix". Therefore each corresponds to particular radix.
Used in:
FFX_COMMON_NATIVE_ALPHABET_UNSPECIFIED = 0
NUMERIC = 1
[0-9] (radix of 10)
HEXADECIMAL = 2
[0-9A-F] (radix of 16)
UPPER_CASE_ALPHA_NUMERIC = 3
[0-9A-Z] (radix of 36)
ALPHA_NUMERIC = 4
[0-9A-Za-z] (radix of 62)
message
storage.proto:38Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question.
Used in:
optional info_type = 1
Info type configuration. All custom info types must have configurations that do not conflict with built-in info types or other custom info types.
Likelihood likelihood = 6
Likelihood to return for this custom info type. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified.
oneof type
dictionary = 2
Dictionary-based custom info type.
regex = 3
Regex-based custom info type.
surrogate_type = 4
Surrogate info type.
repeated detection_rules = 7
Set of detection rules to apply to all findings of this custom info type. Rules are applied in order that they are specified. Not supported for the `surrogate_type` custom info type.
message
storage.proto:98Rule for modifying a custom info type to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom info type.
Used in:
oneof type
hotword_rule = 1
Hotword-based detection rule.
message
storage.proto:130Detection rule that adjusts the likelihood of findings within a certain proximity of hotwords.
Used in:
optional hotword_regex = 1
Regex pattern defining what qualifies as a hotword.
optional proximity = 2
Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question.
optional likelihood_adjustment = 3
Likelihood adjustment to apply to all matching findings.
message
storage.proto:111Message for specifying an adjustment to the likelihood of a finding as part of a detection rule.
Used in:
oneof adjustment
Likelihood fixed_likelihood = 1
Set the likelihood of a finding to a fixed value.
int32 relative_likelihood = 2
Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`.
message
storage.proto:101Message for specifying a window around a finding to apply a detection rule.
Used in:
int32 window_before = 1
Number of characters before the finding to consider.
int32 window_after = 2
Number of characters after the finding to consider.
message
storage.proto:58Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace.
Used in:
oneof source
word_list = 1
List of words or phrases to search for.
cloud_storage_path = 3
Newline-delimited file of words in Cloud Storage. Only a single file is accepted.
message
storage.proto:60Message defining a list of words or phrases to search for in the data.
Used in:
repeated string words = 1
Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits. [required]
message
storage.proto:78Message defining a custom regular expression.
Used in: ,
string pattern = 1
Pattern defining the regular expression.
message
storage.proto:91Message for detecting output from deidentification transformations such as [`CryptoReplaceFfxFpeConfig`](/dlp/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig). These types of transformations are those that perform pseudonymization, thereby producing a "surrogate" as output. This should be used in conjunction with a field on the transformation such as `surrogate_info_type`. This custom info type does not support the use of `detection_rules`.
Used in:
(message has no fields)
message
storage.proto:349Record key for a finding in Cloud Datastore.
Used in:
optional entity_key = 1
Datastore entity key.
message
storage.proto:207Options defining a data set within Google Cloud Datastore.
Used in:
optional partition_id = 1
A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty.
optional kind = 2
The kind to process.
message
dlp.proto:1591Shifts dates by random number of days, with option to be consistent for the same context.
Used in:
int32 upper_bound_days = 1
Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. [Required]
int32 lower_bound_days = 2
For example, -5 means shift date to at most 5 days back in the past. [Required]
optional context = 3
Points to the field that contains the context, for example, an entity id. If set, must also set method. If set, shift will be consistent for the given context.
oneof method
Method for calculating shift that takes context into consideration. If set, must also set context. Can only be applied to table items.
crypto_key = 4
Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key.
message
dlp.proto:1211Message for a date time object.
Used in:
optional date = 1
One or more of the following must be set. All fields are optional, but when set must be valid date or time values.
type.DayOfWeek day_of_week = 2
optional time = 3
optional time_zone = 4
message
dlp.proto:1212Used in:
int32 offset_minutes = 1
Set only if the offset can be determined. Positive for time ahead of UTC. E.g. For "UTC-9", this value is -540.
message
dlp.proto:1230The configuration that controls how the data will change.
Used in: , ,
oneof transformation
info_type_transformations = 1
Treat the dataset as free-form text and apply the same free text transformation everywhere.
record_transformations = 2
Treat the dataset as structured. Transformations can be applied to specific locations within structured datasets, such as transforming a column within a table.
message
dlp.proto:1843The DeidentifyTemplates contains instructions on how to deidentify content.
Used as response type in: DlpService.CreateDeidentifyTemplate, DlpService.GetDeidentifyTemplate, DlpService.UpdateDeidentifyTemplate
Used as field type in: , ,
string name = 1
The template name. Output only. The template will have one of the following formats: `projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID`
string display_name = 2
Display name (max 256 chars).
string description = 3
Short description (max 256 chars).
optional create_time = 4
The creation timestamp of a inspectTemplate, output only field.
optional update_time = 5
The last update timestamp of a inspectTemplate, output only field.
optional deidentify_config = 6
///////////// // The core content of the template // ///////////////
message
dlp.proto:2181Combines all of the information about a DLP job.
Used as response type in: DlpService.CreateDlpJob, DlpService.GetDlpJob
Used as field type in:
string name = 1
The server-assigned name.
DlpJobType type = 2
The type of job.
DlpJob.JobState state = 3
State of a job.
oneof details
risk_details = 4
Results from analyzing risk of a data source.
inspect_details = 5
Results from inspecting a data source.
optional create_time = 6
Time when the job was created.
optional start_time = 7
Time when the job started.
optional end_time = 8
Time when the job finished.
string job_trigger_name = 10
If created by a job trigger, the resource name of the trigger that instantiated the job.
repeated errors = 11
A stream of errors encountered running the job.
Used in:
JOB_STATE_UNSPECIFIED = 0
PENDING = 1
The job has not yet started.
RUNNING = 2
The job is currently running.
DONE = 3
The job is no longer running.
CANCELED = 4
The job was canceled before it could complete.
FAILED = 5
The job had an error and did not complete.
An enum to represent the various type of DLP jobs.
Used in: ,
DLP_JOB_TYPE_UNSPECIFIED = 0
INSPECT_JOB = 1
The job inspected Google Cloud for sensitive data.
RISK_ANALYSIS_JOB = 2
The job executed a Risk Analysis computation.
message
dlp.proto:486Location of a finding within a document.
Used in:
int64 file_offset = 1
Offset of the line, from the beginning of the file, where the finding is located.
message
storage.proto:433An entity in a dataset is a field or set of fields that correspond to a single person. For example, in medical records the `EntityId` might be a patient identifier, or for financial records it might be an account identifier. This message is used when generalizations or analysis must take into account that multiple rows correspond to the same entity.
Used in:
optional field = 1
Composite key indicating which field contains the entity identifier.
message
dlp.proto:1870Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger. Output only field.
Used in: ,
optional details = 1
repeated timestamps = 2
The times the error occurred.
message
storage.proto:181General identifier of a data field in a storage service.
Used in: , , , , , , , , , , , , , , , ,
string name = 1
Name describing the field.
message
dlp.proto:1640The transformation to apply to the field.
Used in: ,
repeated fields = 1
Input field(s) to apply the transformation to. [required]
optional condition = 3
Only apply the transformation if the condition evaluates to true for the given `RecordCondition`. The conditions are allowed to reference fields that are not used in the actual transformation. [optional] Example Use Cases: - Apply a different bucket transformation to an age column if the zip code column for the same record is within a specific range. - Redact a field if the date of birth field is greater than 85.
oneof transformation
Transformation to apply. [required]
primitive_transformation = 4
Apply the transformation to the entire field.
info_type_transformations = 5
Treat the contents of the field as free text, and selectively transform content that matches an `InfoType`.
Definitions of file type groups to scan.
Used in:
FILE_TYPE_UNSPECIFIED = 0
Includes all files.
BINARY_FILE = 1
Includes all file extensions not covered by text file types.
TEXT_FILE = 2
Included file extensions: asc, brf, c, cc, cpp, csv, cxx, c++, cs, css, dart, eml, go, h, hh, hpp, hxx, h++, hs, html, htm, shtml, shtm, xhtml, lhs, ini, java, js, json, ocaml, md, mkd, markdown, m, ml, mli, pl, pm, php, phtml, pht, py, pyw, rb, rbw, rs, rc, scala, sh, sql, tex, txt, text, tsv, vcard, vcs, wml, xml, xsl, xsd, yml, yaml.
message
dlp.proto:408Represents a piece of potentially sensitive content.
Used in:
string quote = 1
The content that was found. Even if the content is not textual, it may be converted to a textual representation here. Provided if requested by the `InspectConfig` and the finding is less than or equal to 4096 bytes long. If the finding exceeds 4096 bytes in length, the quote may be omitted.
optional info_type = 2
The type of content that might have been found. Provided if requested by the `InspectConfig`.
Likelihood likelihood = 3
Estimate of how likely it is that the `info_type` is correct.
optional location = 4
Where the content was found.
optional create_time = 6
Timestamp when finding was detected.
optional quote_info = 7
Contains data parsed from quotes. Only populated if include_quote was set to true and a supported infoType was requested. Currently supported infoTypes: DATE, DATE_OF_BIRTH and TIME.
message
dlp.proto:1398Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of <lower_bound>-<upper_bound>, i.e if lower_bound = 10 and upper_bound = 20 all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value 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.
Used in:
optional lower_bound = 1
Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value “-10”. [Required].
optional upper_bound = 2
Upper bound value of buckets. All values greater than upper_bound are grouped together into a single bucket; for example if `upper_bound` = 89, then all values greater than 89 are replaced with the value “89+”. [Required].
double bucket_size = 3
Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. [Required].
message
dlp.proto:520Location of the finding within an image.
Used in:
repeated bounding_boxes = 1
Bounding boxes locating the pixels within the image containing the finding.
message
storage.proto:31Type of information detected by the API.
Used in: , , , , , , , , ,
string name = 1
Name of the information type.
message
dlp.proto:796InfoType description.
Used in:
string name = 1
Internal name of the infoType.
string display_name = 2
Human readable form of the infoType name.
repeated InfoTypeSupportedBy supported_by = 3
Which parts of the API supports this InfoType.
message
dlp.proto:758Statistics regarding a specific InfoType.
Used in:
optional info_type = 1
The type of finding this stat is for.
int64 count = 2
Number of findings for this infoType.
Parts of the APIs which use certain infoTypes.
Used in:
ENUM_TYPE_UNSPECIFIED = 0
INSPECT = 1
Supported by the inspect operations.
RISK_ANALYSIS = 2
Supported by the risk analysis operations.
message
dlp.proto:1622A type of transformation that will scan unstructured text and apply various `PrimitiveTransformation`s to each finding, where the transformation is applied to only values that were identified as a specific info_type.
Used in: ,
repeated transformations = 1
Transformation for each infoType. Cannot specify more than one for a given infoType. [required]
message
dlp.proto:1625A transformation to apply to text that is identified as a specific info_type.
Used in:
repeated info_types = 1
InfoTypes to apply the transformation to. Empty list will match all available infoTypes for this transformation.
optional primitive_transformation = 2
Primitive transformation to apply to the infoType. [required]
message
dlp.proto:287Configuration description of the scanning process. When used with redactContent only info_types and min_likelihood are currently used.
Used in: , , , , ,
repeated info_types = 1
Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or found in documentation.
Likelihood min_likelihood = 2
Only returns findings equal or above this threshold. The default is POSSIBLE.
optional limits = 3
bool include_quote = 4
When true, a contextual quote from the data that triggered a finding is included in the response; see Finding.quote.
bool exclude_info_types = 5
When true, excludes type information of the findings.
repeated custom_info_types = 6
Custom infoTypes provided by the user.
repeated ContentOption content_options = 8
List of options defining data content to scan. If empty, text, images, and other content will be included.
message
dlp.proto:288Used in:
int32 max_findings_per_item = 1
Max number of findings that will be returned for each item scanned. When set within `InspectDataSourceRequest`, the maximum returned is 1000 regardless if this is set higher. When set within `InspectContentRequest`, this field is ignored.
int32 max_findings_per_request = 2
Max number of findings that will be returned per request/job. When set within `InspectContentRequest`, the maximum returned is 1000 regardless if this is set higher.
repeated max_findings_per_info_type = 3
Configuration of findings limit given for specified infoTypes.
message
dlp.proto:291Max findings configuration per infoType, per content item or long running DlpJob.
Used in:
optional info_type = 1
Type of information the findings limit applies to. Only one limit per info_type should be provided. If InfoTypeLimit does not have an info_type, the DLP API applies the limit against all info_types that are found but not specified in another InfoTypeLimit.
int32 max_findings = 2
Max findings limit for the given infoType.
message
dlp.proto:767The results of an inspect DataSource job.
Used in:
optional requested_options = 2
The configuration used for this job.
optional result = 3
A summary of the outcome of this inspect job.
message
dlp.proto:768Used in:
optional snapshot_inspect_template = 1
If run with an InspectTemplate, a snapshot of its state at the time of this run.
optional job_config = 3
message
dlp.proto:776Used in:
int64 processed_bytes = 1
Total size in bytes that were processed.
int64 total_estimated_bytes = 2
Estimate of the number of bytes to process.
repeated info_type_stats = 3
Statistics of how many instances of each info type were found during inspect job.
message
dlp.proto:2163Used in: , ,
optional storage_config = 1
The data to scan.
optional inspect_config = 2
How and what to scan for.
string inspect_template_name = 3
If provided, will be used as the default for all values in InspectConfig. `inspect_config` will be merged into the values persisted as part of the template.
repeated actions = 4
Actions to execute at the completion of the job. Are executed in the order provided.
message
dlp.proto:394All the findings for a single scanned item.
Used in:
repeated findings = 1
List of findings for an item.
bool findings_truncated = 2
If true, then this item might have more findings than were returned, and the findings returned are an arbitrary subset of all findings. The findings list might be truncated because the input items were too large, or because the server reached the maximum amount of resources allowed for a single API call. For best results, divide the input into smaller batches.
message
dlp.proto:1818The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig.
Used as response type in: DlpService.CreateInspectTemplate, DlpService.GetInspectTemplate, DlpService.UpdateInspectTemplate
Used as field type in: , , ,
string name = 1
The template name. Output only. The template will have one of the following formats: `projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID`
string display_name = 2
Display name (max 256 chars).
string description = 3
Short description (max 256 chars).
optional create_time = 4
The creation timestamp of a inspectTemplate, output only field.
optional update_time = 5
The last update timestamp of a inspectTemplate, output only field.
optional inspect_config = 6
The core content of the template. Configuration of the scanning process.
message
dlp.proto:1878Contains a configuration to make dlp api calls on a repeating basis.
Used as response type in: DlpService.CreateJobTrigger, DlpService.GetJobTrigger, DlpService.UpdateJobTrigger
Used as field type in: , ,
string name = 1
Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/triggeredJobs/53234423`.
string display_name = 2
Display name (max 100 chars)
string description = 3
User provided description (max 256 chars)
oneof job
The configuration details for the specific type of job to run.
inspect_job = 4
repeated triggers = 5
A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object.
repeated errors = 6
A stream of errors encountered when the trigger was activated. Repeated errors may result in the JobTrigger automaticaly being paused. Will return the last 100 errors. Whenever the JobTrigger is modified this list will be cleared. Output only field.
optional create_time = 7
The creation timestamp of a triggeredJob, output only field.
optional update_time = 8
The last update timestamp of a triggeredJob, output only field.
optional last_run_time = 9
The timestamp of the last time this trigger executed, output only field.
JobTrigger.Status status = 10
A status for this trigger. [required]
Whether the trigger is currently active. If PAUSED or CANCELLED, no jobs will be created with this configuration. The service may automatically pause triggers experiencing frequent errors. To restart a job, set the status to HEALTHY after correcting user errors.
Used in:
STATUS_UNSPECIFIED = 0
HEALTHY = 1
Trigger is healthy.
PAUSED = 2
Trigger is temporarily paused.
CANCELLED = 3
Trigger is cancelled and can not be resumed.
message
dlp.proto:1880What event needs to occur for a new job to be started.
Used in:
oneof trigger
schedule = 1
Create a job on a repeating basis based on the elapse of time.
message
storage.proto:358A unique identifier for a Datastore entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts.
Used in:
optional partition_id = 1
Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
repeated path = 2
The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. A path can never be empty, and a path can have at most 100 elements.
message
storage.proto:363A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
Used in:
string kind = 1
The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
oneof id_type
The type of ID.
int64 id = 2
The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
string name = 3
The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
message
storage.proto:201A representation of a Datastore kind.
Used in:
string name = 1
The name of the kind.
message
dlp.proto:1581Include to use an existing data crypto key wrapped by KMS. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a kms-wrapped crypto key: dlp.kms.encrypt
Used in:
bytes wrapped_key = 1
The wrapped data crypto key. [required]
string crypto_key_name = 2
The resource name of the KMS CryptoKey to use for unwrapping. [required]
Categorization of results based on how likely they are to represent a match, based on the number of elements they contain which imply a match.
Used in: , , ,
LIKELIHOOD_UNSPECIFIED = 0
Default value; information with all likelihoods is included.
VERY_UNLIKELY = 1
Few matching elements.
UNLIKELY = 2
POSSIBLE = 3
Some matching elements.
LIKELY = 4
VERY_LIKELY = 5
Many matching elements.
message
dlp.proto:436Specifies the location of the finding.
Used in:
optional byte_range = 1
Zero-based byte offsets delimiting the finding. These are relative to the finding's containing element. Note that when the content is not textual, this references the UTF-8 encoded textual representation of the content. Omitted if content is an image.
optional codepoint_range = 2
Unicode character offsets delimiting the finding. These are relative to the finding's containing element. Provided when the content is text.
repeated content_locations = 7
List of nested objects pointing to the precise location of the finding within the file or record.
message
dlp.proto:715Cloud repository for storing output.
Used in:
oneof type
table = 1
Store findings in an existing table or a new table in an existing dataset. Each column in an existing table must have the same name, type, and mode of a field in the `Finding` object. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific timezone will be used for generating the date details.
OutputStorageConfig.OutputSchema output_schema = 3
Schema used for writing the findings. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table, and no changes will be made to an existing table.
Predefined schemas for storing findings.
Used in:
OUTPUT_SCHEMA_UNSPECIFIED = 0
BASIC_COLUMNS = 1
Basic schema including only `info_type`, `quote`, `certainty`, and `timestamp`.
GCS_COLUMNS = 2
Schema tailored to findings from scanning Google Cloud Storage.
DATASTORE_COLUMNS = 3
Schema tailored to findings from scanning Google Datastore.
BIG_QUERY_COLUMNS = 4
Schema tailored to findings from scanning Google BigQuery.
ALL_COLUMNS = 5
Schema containing all columns.
message
storage.proto:192Datastore partition ID. A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID.
Used in: ,
string project_id = 2
The ID of the project to which the entities belong.
string namespace_id = 4
If not empty, the ID of the namespace to which the entities belong.
message
dlp.proto:1244A rule for transforming a value.
Used in: , ,
oneof transformation
replace_config = 1
redact_config = 2
character_mask_config = 3
crypto_replace_ffx_fpe_config = 4
fixed_size_bucketing_config = 5
bucketing_config = 6
replace_with_info_type_config = 7
time_part_config = 8
crypto_hash_config = 9
date_shift_config = 11
message
dlp.proto:839Privacy metric to compute for reidentification risk analysis.
Used in: ,
oneof type
numerical_stats_config = 1
categorical_stats_config = 2
k_anonymity_config = 3
l_diversity_config = 4
k_map_estimation_config = 5
message
dlp.proto:850Compute numerical stats over an individual column, including number of distinct values and value count distribution.
Used in:
optional field = 1
Field to compute categorical stats on. All column types are supported except for arrays and structs. However, it may be more informative to use NumericalStats when the field type is supported, depending on the data.
message
dlp.proto:859k-anonymity metric, used for analysis of reidentification risk.
Used in:
repeated quasi_ids = 1
Set of fields to compute k-anonymity over. When multiple fields are specified, they are considered a single composite key. Structs and repeated data types are not supported; however, nested fields are supported so long as they are not structs themselves or nested within a repeated field.
optional entity_id = 2
Optional message indicating that multiple rows might be associated to a single individual. If the same entity_id is associated to multiple quasi-identifier tuples over distict rows, we consider the entire collection of tuples as the composite quasi-identifier. This collection is a multiset: the order in which the different tuples appear in the dataset is ignored, but their frequency is taken into account. Important note: a maximum of 1000 rows can be associated to a single entity ID. If more rows are associated with the same entity ID, some might be ignored.
message
dlp.proto:898Reidentifiability metric. This corresponds to a risk model similar to what is called "journalist risk" in the literature, except the attack dataset is statistically modeled instead of being perfectly known. This can be done using publicly available data (like the US Census), or using a custom statistical model (indicated as one or several BigQuery tables), or by extrapolating from the distribution of values in the input dataset. A column with a semantic tag attached.
Used in:
repeated quasi_ids = 1
Fields considered to be quasi-identifiers. No two columns can have the same tag. [required]
string region_code = 2
ISO 3166-1 alpha-2 region code to use in the statistical modeling. Required if no column is tagged with a region-specific InfoType (like US_ZIP_5) or a region code.
repeated auxiliary_tables = 3
Several auxiliary tables can be used in the analysis. Each custom_tag used to tag a quasi-identifiers column must appear in exactly one column of one auxiliary table.
message
dlp.proto:932An 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).
Used in:
optional table = 3
Auxiliary table location. [required]
repeated quasi_ids = 1
Quasi-identifier columns. [required]
optional relative_frequency = 2
The relative frequency column must contain a floating-point number between 0 and 1 (inclusive). Null values are assumed to be zero. [required]
message
dlp.proto:935A quasi-identifier column has a custom_tag, used to know which column in the data corresponds to which column in the statistical model.
Used in:
optional field = 1
string custom_tag = 2
message
dlp.proto:899Used in:
optional field = 1
Identifies the column. [required]
oneof tag
Semantic tag that identifies what a column contains, to determine which statistical model to use to estimate the reidentifiability of each value. [required]
info_type = 2
A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter.
string custom_tag = 3
A column can be tagged with a custom tag. In this case, the user must indicate an auxiliary table that contains statistical information on the possible values of this column (below).
inferred = 4
If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data
message
dlp.proto:881l-diversity metric, used for analysis of reidentification risk.
Used in:
repeated quasi_ids = 1
Set of quasi-identifiers indicating how equivalence classes are defined for the l-diversity computation. When multiple fields are specified, they are considered a single composite key.
optional sensitive_attribute = 2
Sensitive field for computing the l-value.
message
dlp.proto:842Compute numerical stats over an individual column, including min, max, and quantiles.
Used in:
optional field = 1
Field to compute numerical stats on. Supported types are integer, float, date, datetime, timestamp, time.
message
dlp.proto:1203Message for infoType-dependent details parsed from quote.
Used in:
oneof parsed_quote
Object representation of the quote.
date_time = 2
message
dlp.proto:511Generic half-open interval [start, end)
Used in:
int64 start = 1
Index of the first character of the range (inclusive).
int64 end = 2
Index of the last character of the range (exclusive).
message
dlp.proto:1687A condition for determining whether a transformation should be applied to a field.
Used in: ,
optional expressions = 3
An expression.
message
dlp.proto:1706The field type of `value` and `field` do not need to match to be considered equal, but not all comparisons are possible. A `value` of type: - `string` can be compared against all other types - `boolean` can only be compared against other booleans - `integer` can be compared against doubles or a string if the string value can be parsed as an integer. - `double` can be compared against integers or a string if the string can be parsed as a double. - `Timestamp` can be compared against strings in RFC 3339 date string format. - `TimeOfDay` can be compared against timestamps and strings in the format of 'HH:mm:ss'. If we fail to compare do to type mismatch, a warning will be given and the condition will evaluate to false.
Used in:
optional field = 1
Field within the record this condition is evaluated against. [required]
RelationalOperator operator = 3
Operator used to compare the field or infoType to the value. [required]
optional value = 4
Value to compare against. [Required, except for `EXISTS` tests.]
message
dlp.proto:1718A collection of conditions.
Used in:
repeated conditions = 1
message
dlp.proto:1723An expression, consisting or an operator and conditions.
Used in:
Expressions.LogicalOperator logical_operator = 1
The operator to apply to the result of conditions. Default and currently only supported value is `AND`.
oneof type
conditions = 3
Used in:
LOGICAL_OPERATOR_UNSPECIFIED = 0
AND = 1
message
storage.proto:403Message for a unique key indicating a record that contains a finding.
Used in:
oneof type
datastore_key = 2
big_query_key = 3
message
dlp.proto:493Location of a finding within a row or record.
Used in:
optional record_key = 1
Key of the finding.
optional field_id = 2
Field id of the field containing the finding.
optional table_location = 3
Location within a `ContentItem.Table`.
message
dlp.proto:1679Configuration to suppress records whose suppression conditions evaluate to true.
Used in: ,
optional condition = 1
A condition that when it evaluates to true will result in the record being evaluated to be suppressed from the transformed content.
message
dlp.proto:1668A type of transformation that is applied over structured data such as a table.
Used in:
repeated field_transformations = 1
Transform the record by applying various field transformations.
repeated record_suppressions = 2
Configuration defining which records get suppressed entirely. Records that match any suppression rule are omitted from the output [optional].
message
dlp.proto:1321Redact a given value. For example, if used with an `InfoTypeTransformation` transforming PHONE_NUMBER, and input 'My phone number is 206-555-0123', the output would be 'My phone number is '.
Used in:
(message has no fields)
message
dlp.proto:544Configuration for determining how redaction of images should occur.
Used in:
oneof target
Type of information to redact from images.
info_type = 1
Only one per info_type should be provided per request. If not specified, and redact_all_text is false, the DLP API will redact all text that it matches against all info_types that are found, but not specified in another ImageRedactionConfig.
bool redact_all_text = 2
If true, all text found in the image, regardless whether it matches an info_type, is redacted.
optional redaction_color = 3
The color to use when redacting content from an image. If not specified, the default is black.
Operators available for comparing the value of fields.
Used in:
RELATIONAL_OPERATOR_UNSPECIFIED = 0
EQUAL_TO = 1
Equal.
NOT_EQUAL_TO = 2
Not equal to.
GREATER_THAN = 3
Greater than.
LESS_THAN = 4
Less than.
GREATER_THAN_OR_EQUALS = 5
Greater than or equals.
LESS_THAN_OR_EQUALS = 6
Less than or equals.
EXISTS = 7
Exists
message
dlp.proto:1308Replace each input value with a given `Value`.
Used in:
optional new_value = 1
Value to replace it with.
message
dlp.proto:1314Replace each matching finding with the name of the info_type.
Used in:
(message has no fields)
message
dlp.proto:826Configuration for a risk analysis job.
Used in:
optional privacy_metric = 1
Privacy metric to compute.
optional source_table = 2
Input dataset to compute metrics over.
repeated actions = 3
Actions to execute at the completion of the job. Are executed in the order provided.
message
dlp.proto:1801Schedule for triggeredJobs.
Used in:
oneof option
recurrence_period_duration = 1
With this option a job is started a regular periodic basis. For example: every 10 minutes. A scheduled start time will be skipped if the previous execution has not ended when its scheduled time occurs. This value must be set to a time duration greater than or equal to 60 minutes and can be no longer than 60 days.
message
storage.proto:297Shared message indicating Cloud storage type.
Used in:
oneof type
datastore_options = 2
Google Cloud Datastore options specification.
cloud_storage_options = 3
Google Cloud Storage options specification.
big_query_options = 4
BigQuery options specification.
optional timespan_config = 6
message
storage.proto:300Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Google Cloud Storage and BigQuery.
Used in:
optional start_time = 1
Exclude files older than this value.
optional end_time = 2
Exclude files newer than this value. If set to zero, no upper time limit is applied.
optional timestamp_field = 3
Specification of the field containing the timestamp of scanned items. Required for data sources like Datastore or BigQuery. The valid data types of the timestamp field are: for BigQuery - timestamp, date, datetime; for Datastore - timestamp. Datastore entity will be scanned if the timestamp property does not exist or its value is empty or invalid.
bool enable_auto_population_of_timespan_config = 4
When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger.
message
dlp.proto:383Structured content to inspect. Up to 50,000 `Value`s per request allowed.
Used in:
repeated headers = 1
repeated rows = 2
message
dlp.proto:384Used in:
repeated values = 1
message
dlp.proto:505Location of a finding within a table.
Used in:
int64 row_index = 1
The zero-based index of the row where the finding is located.
message
dlp.proto:1270For use with `Date`, `Timestamp`, and `TimeOfDay`, extract or preserve a portion of the value.
Used in:
TimePartConfig.TimePart part_to_extract = 1
Used in:
TIME_PART_UNSPECIFIED = 0
YEAR = 1
[0-9999]
MONTH = 2
[1-12]
DAY_OF_MONTH = 3
[1-31]
DAY_OF_WEEK = 4
[1-7]
WEEK_OF_YEAR = 5
[1-52]
HOUR_OF_DAY = 6
[0-23]
message
dlp.proto:1744Overview of the modifications that occurred.
Used in: ,
int64 transformed_bytes = 2
Total size in bytes that were transformed in some way.
repeated transformation_summaries = 3
Transformations applied to the dataset.
message
dlp.proto:1755Summary of a single tranformation. Only one of 'transformation', 'field_transformation', or 'record_suppress' will be set.
Used in:
optional info_type = 1
Set if the transformation was limited to a specific info_type.
optional field = 2
Set if the transformation was limited to a specific FieldId.
optional transformation = 3
The specific transformation these stats apply to.
repeated field_transformations = 5
The field transformation that was applied. If multiple field transformations are requested for a single field, this list will contain all of them; otherwise, only one is supplied.
optional record_suppress = 6
The specific suppression option these stats apply to.
repeated results = 4
int64 transformed_bytes = 7
Total size in bytes that were transformed in some way.
message
dlp.proto:1758A collection that informs the user the number of times a particular `TransformationResultCode` and error details occurred.
Used in:
int64 count = 1
TransformationResultCode code = 2
string details = 3
A place for warnings or errors to show up if a transformation didn't work as expected.
Possible outcomes of transformations.
Used in:
TRANSFORMATION_RESULT_CODE_UNSPECIFIED = 0
SUCCESS = 1
ERROR = 2
message
dlp.proto:1560Use this to have a random data crypto key generated. It will be discarded after the request finishes.
Used in:
string name = 1
Name of the key. [required] This is an arbitrary string used to differentiate different keys. A unique key is generated per name: two separate `TransientCryptoKey` protos share the same generated key if their names are the same. When the data crypto key is generated, this name is not used in any way (repeating the api call will result in a different key being generated).
message
dlp.proto:1572Using raw keys is prone to security risks due to accidentally leaking the key. Choose another type of key if possible.
Used in:
bytes key = 1
The AES 128/192/256 bit key. [required]
message
dlp.proto:1182Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data.
Used in: , , , , , , , , ,
oneof type
int64 integer_value = 1
double float_value = 2
string string_value = 3
bool boolean_value = 4
timestamp_value = 5
time_value = 6
date_value = 7
type.DayOfWeek day_of_week_value = 8
message
dlp.proto:1168A value of a field, including its frequency.
Used in: ,
optional value = 1
A value contained in the field in question.
int64 count = 2
How many times the value is contained in the field.