Index
DlpService
(interface)Action
(message)Action.JobNotificationEmails
(message)Action.PublishFindingsToCloudDataCatalog
(message)Action.PublishSummaryToCscc
(message)Action.PublishToPubSub
(message)Action.PublishToStackdriver
(message)Action.SaveFindings
(message)ActivateJobTriggerRequest
(message)AnalyzeDataSourceRiskDetails
(message)AnalyzeDataSourceRiskDetails.CategoricalStatsResult
(message)AnalyzeDataSourceRiskDetails.CategoricalStatsResult.CategoricalStatsHistogramBucket
(message)AnalyzeDataSourceRiskDetails.DeltaPresenceEstimationResult
(message)AnalyzeDataSourceRiskDetails.DeltaPresenceEstimationResult.DeltaPresenceEstimationHistogramBucket
(message)AnalyzeDataSourceRiskDetails.DeltaPresenceEstimationResult.DeltaPresenceEstimationQuasiIdValues
(message)AnalyzeDataSourceRiskDetails.KAnonymityResult
(message)AnalyzeDataSourceRiskDetails.KAnonymityResult.KAnonymityEquivalenceClass
(message)AnalyzeDataSourceRiskDetails.KAnonymityResult.KAnonymityHistogramBucket
(message)AnalyzeDataSourceRiskDetails.KMapEstimationResult
(message)AnalyzeDataSourceRiskDetails.KMapEstimationResult.KMapEstimationHistogramBucket
(message)AnalyzeDataSourceRiskDetails.KMapEstimationResult.KMapEstimationQuasiIdValues
(message)AnalyzeDataSourceRiskDetails.LDiversityResult
(message)AnalyzeDataSourceRiskDetails.LDiversityResult.LDiversityEquivalenceClass
(message)AnalyzeDataSourceRiskDetails.LDiversityResult.LDiversityHistogramBucket
(message)AnalyzeDataSourceRiskDetails.NumericalStatsResult
(message)BigQueryField
(message)BigQueryKey
(message)BigQueryOptions
(message)BigQueryOptions.SampleMethod
(enum)BigQueryTable
(message)BoundingBox
(message)BucketingConfig
(message)BucketingConfig.Bucket
(message)ByteContentItem
(message)ByteContentItem.BytesType
(enum)CancelDlpJobRequest
(message)CharacterMaskConfig
(message)CharsToIgnore
(message)CharsToIgnore.CommonCharsToIgnore
(enum)CloudStorageFileSet
(message)CloudStorageOptions
(message)CloudStorageOptions.FileSet
(message)CloudStorageOptions.SampleMethod
(enum)CloudStoragePath
(message)CloudStorageRegexFileSet
(message)Color
(message)ContentItem
(message)ContentLocation
(message)ContentOption
(enum)CreateDeidentifyTemplateRequest
(message)CreateDlpJobRequest
(message)CreateInspectTemplateRequest
(message)CreateJobTriggerRequest
(message)CreateStoredInfoTypeRequest
(message)CryptoDeterministicConfig
(message)CryptoHashConfig
(message)CryptoKey
(message)CryptoReplaceFfxFpeConfig
(message)CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabet
(enum)CustomInfoType
(message)CustomInfoType.DetectionRule
(message)CustomInfoType.DetectionRule.HotwordRule
(message)CustomInfoType.DetectionRule.LikelihoodAdjustment
(message)CustomInfoType.DetectionRule.Proximity
(message)CustomInfoType.Dictionary
(message)CustomInfoType.Dictionary.WordList
(message)CustomInfoType.ExclusionType
(enum)CustomInfoType.Regex
(message)CustomInfoType.SurrogateType
(message)DatastoreKey
(message)DatastoreOptions
(message)DateShiftConfig
(message)DateTime
(message)DateTime.TimeZone
(message)DeidentifyConfig
(message)DeidentifyContentRequest
(message)DeidentifyContentResponse
(message)DeidentifyTemplate
(message)DeleteDeidentifyTemplateRequest
(message)DeleteDlpJobRequest
(message)DeleteInspectTemplateRequest
(message)DeleteJobTriggerRequest
(message)DeleteStoredInfoTypeRequest
(message)DlpJob
(message)DlpJob.JobState
(enum)DlpJobType
(enum)DocumentLocation
(message)EntityId
(message)Error
(message)ExcludeInfoTypes
(message)ExclusionRule
(message)FieldId
(message)FieldTransformation
(message)FileType
(enum)Finding
(message)FixedSizeBucketingConfig
(message)GetDeidentifyTemplateRequest
(message)GetDlpJobRequest
(message)GetInspectTemplateRequest
(message)GetJobTriggerRequest
(message)GetStoredInfoTypeRequest
(message)ImageLocation
(message)InfoType
(message)InfoTypeDescription
(message)InfoTypeStats
(message)InfoTypeSupportedBy
(enum)InfoTypeTransformations
(message)InfoTypeTransformations.InfoTypeTransformation
(message)InspectConfig
(message)InspectConfig.FindingLimits
(message)InspectConfig.FindingLimits.InfoTypeLimit
(message)InspectContentRequest
(message)InspectContentResponse
(message)InspectDataSourceDetails
(message)InspectDataSourceDetails.RequestedOptions
(message)InspectDataSourceDetails.Result
(message)InspectJobConfig
(message)InspectResult
(message)InspectTemplate
(message)InspectionRule
(message)InspectionRuleSet
(message)JobTrigger
(message)JobTrigger.Status
(enum)JobTrigger.Trigger
(message)Key
(message)Key.PathElement
(message)KindExpression
(message)KmsWrappedCryptoKey
(message)LargeCustomDictionaryConfig
(message)LargeCustomDictionaryStats
(message)Likelihood
(enum)ListDeidentifyTemplatesRequest
(message)ListDeidentifyTemplatesResponse
(message)ListDlpJobsRequest
(message)ListDlpJobsResponse
(message)ListInfoTypesRequest
(message)ListInfoTypesResponse
(message)ListInspectTemplatesRequest
(message)ListInspectTemplatesResponse
(message)ListJobTriggersRequest
(message)ListJobTriggersResponse
(message)ListStoredInfoTypesRequest
(message)ListStoredInfoTypesResponse
(message)Location
(message)MatchingType
(enum)OutputStorageConfig
(message)OutputStorageConfig.OutputSchema
(enum)PartitionId
(message)PrimitiveTransformation
(message)PrivacyMetric
(message)PrivacyMetric.CategoricalStatsConfig
(message)PrivacyMetric.DeltaPresenceEstimationConfig
(message)PrivacyMetric.KAnonymityConfig
(message)PrivacyMetric.KMapEstimationConfig
(message)PrivacyMetric.KMapEstimationConfig.AuxiliaryTable
(message)PrivacyMetric.KMapEstimationConfig.AuxiliaryTable.QuasiIdField
(message)PrivacyMetric.KMapEstimationConfig.TaggedField
(message)PrivacyMetric.LDiversityConfig
(message)PrivacyMetric.NumericalStatsConfig
(message)QuasiId
(message)QuoteInfo
(message)Range
(message)RecordCondition
(message)RecordCondition.Condition
(message)RecordCondition.Conditions
(message)RecordCondition.Expressions
(message)RecordCondition.Expressions.LogicalOperator
(enum)RecordKey
(message)RecordLocation
(message)RecordSuppression
(message)RecordTransformations
(message)RedactConfig
(message)RedactImageRequest
(message)RedactImageRequest.ImageRedactionConfig
(message)RedactImageResponse
(message)ReidentifyContentRequest
(message)ReidentifyContentResponse
(message)RelationalOperator
(enum)ReplaceValueConfig
(message)ReplaceWithInfoTypeConfig
(message)RiskAnalysisJobConfig
(message)Schedule
(message)StatisticalTable
(message)StatisticalTable.QuasiIdentifierField
(message)StorageConfig
(message)StorageConfig.TimespanConfig
(message)StoredInfoType
(message)StoredInfoTypeConfig
(message)StoredInfoTypeState
(enum)StoredInfoTypeStats
(message)StoredInfoTypeVersion
(message)StoredType
(message)Table
(message)Table.Row
(message)TableLocation
(message)TimePartConfig
(message)TimePartConfig.TimePart
(enum)TransformationOverview
(message)TransformationSummary
(message)TransformationSummary.SummaryResult
(message)TransformationSummary.TransformationResultCode
(enum)TransientCryptoKey
(message)UnwrappedCryptoKey
(message)UpdateDeidentifyTemplateRequest
(message)UpdateInspectTemplateRequest
(message)UpdateJobTriggerRequest
(message)UpdateStoredInfoTypeRequest
(message)Value
(message)ValueFrequency
(message)
DlpService
The Cloud Data Loss Prevention (DLP) API is a service that allows clients to detect the presence of Personally Identifiable Information (PII) and other privacy-sensitive data in user-supplied, unstructured data streams, like text blocks or images. The service also includes methods for sensitive data redaction and scheduling of data scans on Google Cloud Platform based data sets.
To learn more about concepts and find how-to guides see https://cloud.google.com/dlp/docs/.
ActivateJobTrigger | |
---|---|
Activate a job trigger. Causes the immediate execute of a trigger instead of waiting on the trigger event to occur.
|
CancelDlpJob | |
---|---|
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.
|
CreateDeidentifyTemplate | |
---|---|
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.
|
CreateDlpJob | |
---|---|
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.
|
CreateInspectTemplate | |
---|---|
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.
|
CreateJobTrigger | |
---|---|
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.
|
CreateStoredInfoType | |
---|---|
Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.
|
DeidentifyContent | |
---|---|
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.
|
DeleteDeidentifyTemplate | |
---|---|
Deletes a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.
|
DeleteDlpJob | |
---|---|
Deletes a long-running DlpJob. This method indicates that the client is no longer interested in the DlpJob result. The job will be cancelled if possible. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.
|
DeleteInspectTemplate | |
---|---|
Deletes an InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.
|
DeleteJobTrigger | |
---|---|
Deletes a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.
|
DeleteStoredInfoType | |
---|---|
Deletes a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.
|
GetDeidentifyTemplate | |
---|---|
Gets a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.
|
GetDlpJob | |
---|---|
Gets the latest state of a long-running DlpJob. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.
|
GetInspectTemplate | |
---|---|
Gets an InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.
|
GetJobTrigger | |
---|---|
Gets a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.
|
GetStoredInfoType | |
---|---|
Gets a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.
|
InspectContent | |
---|---|
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,
|
ListDeidentifyTemplates | |
---|---|
Lists DeidentifyTemplates. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.
|
ListDlpJobs | |
---|---|
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.
|
ListInfoTypes | |
---|---|
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.
|
ListInspectTemplates | |
---|---|
Lists InspectTemplates. See https://cloud.google.com/dlp/docs/creating-templates to learn more.
|
ListJobTriggers | |
---|---|
Lists job triggers. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.
|
ListStoredInfoTypes | |
---|---|
Lists stored infoTypes. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.
|
RedactImage | |
---|---|
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.
|
ReidentifyContent | |
---|---|
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.
|
UpdateDeidentifyTemplate | |
---|---|
Updates the DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.
|
UpdateInspectTemplate | |
---|---|
Updates the InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.
|
UpdateJobTrigger | |
---|---|
Updates a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.
|
UpdateStoredInfoType | |
---|---|
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.
|
Action
A task to execute on the completion of a job. See https://cloud.google.com/dlp/docs/concepts-actions to learn more.
Fields | ||
---|---|---|
Union field
|
||
save_findings |
Save resulting findings in a provided location. |
|
pub_sub |
Publish a notification to a pubsub topic. |
|
publish_summary_to_cscc |
Publish summary to Cloud Security Command Center (Alpha). |
|
publish_findings_to_cloud_data_catalog |
Publish findings to Cloud Datahub. |
|
job_notification_emails |
Enable email notification to project owners and editors on job's completion/failure. |
|
publish_to_stackdriver |
Enable Stackdriver metric dlp.googleapis.com/finding_count. |
JobNotificationEmails
Enable email notification to project owners and editors on jobs's completion/failure.
PublishFindingsToCloudDataCatalog
Publish findings of a DlpJob to Cloud Data Catalog. Labels summarizing the results of the DlpJob will be applied to the entry for the resource scanned in Cloud Data Catalog. Any labels previously written by another DlpJob will be deleted. InfoType naming patterns are strictly enforced when using this feature. Note that the findings will be persisted in Cloud Data Catalog storage and are governed by Data Catalog service-specific policy, see https://cloud.google.com/terms/service-terms Only a single instance of this action can be specified and only allowed if all resources being scanned are BigQuery tables. Compatible with: Inspect
PublishSummaryToCscc
Publish 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
PublishToPubSub
Publish a message into given Pub/Sub topic when DlpJob has completed. The message contains a single field, DlpJobName
, which is equal to the finished job's DlpJob.name
. Compatible with: Inspect, Risk
Fields | |
---|---|
topic |
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}. |
PublishToStackdriver
Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'.
SaveFindings
If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk
Fields | |
---|---|
output_config |
|
ActivateJobTriggerRequest
Request message for ActivateJobTrigger.
Fields | |
---|---|
name |
Required. Resource name of the trigger to activate, for example Authorization requires one or more of the following Google IAM permissions on the specified resource
|
AnalyzeDataSourceRiskDetails
Result of a risk analysis operation request.
Fields | ||
---|---|---|
requested_privacy_metric |
Privacy metric to compute. |
|
requested_source_table |
Input dataset to compute metrics over. |
|
Union field result . Values associated with this metric. result can be only one of the following: |
||
numerical_stats_result |
|
|
categorical_stats_result |
|
|
k_anonymity_result |
|
|
l_diversity_result |
|
|
k_map_estimation_result |
|
|
delta_presence_estimation_result |
|
CategoricalStatsResult
Result of the categorical stats computation.
Fields | |
---|---|
value_frequency_histogram_buckets[] |
Histogram of value frequencies in the column. |
CategoricalStatsHistogramBucket
Fields | |
---|---|
value_frequency_lower_bound |
Lower bound on the value frequency of the values in this bucket. |
value_frequency_upper_bound |
Upper bound on the value frequency of the values in this bucket. |
bucket_size |
Total number of values in this bucket. |
bucket_values[] |
Sample of value frequencies in this bucket. The total number of values returned per bucket is capped at 20. |
bucket_value_count |
Total number of distinct values in this bucket. |
DeltaPresenceEstimationResult
Result of the δ-presence computation. Note that these results are an estimation, not exact values.
Fields | |
---|---|
delta_presence_estimation_histogram[] |
The intervals [min_probability, max_probability) do not overlap. If a value doesn't correspond to any such interval, the associated frequency is zero. For example, the following records: {min_probability: 0, max_probability: 0.1, frequency: 17} {min_probability: 0.2, max_probability: 0.3, frequency: 42} {min_probability: 0.3, max_probability: 0.4, frequency: 99} mean that there are no record with an estimated probability in [0.1, 0.2) nor larger or equal to 0.4. |
DeltaPresenceEstimationHistogramBucket
A DeltaPresenceEstimationHistogramBucket message with the following values: min_probability: 0.1 max_probability: 0.2 frequency: 42 means that there are 42 records for which δ is in [0.1, 0.2). An important particular case is when min_probability = max_probability = 1: then, every individual who shares this quasi-identifier combination is in the dataset.
Fields | |
---|---|
min_probability |
Between 0 and 1. |
max_probability |
Always greater than or equal to min_probability. |
bucket_size |
Number of records within these probability bounds. |
bucket_values[] |
Sample of quasi-identifier tuple values in this bucket. The total number of classes returned per bucket is capped at 20. |
bucket_value_count |
Total number of distinct quasi-identifier tuple values in this bucket. |
DeltaPresenceEstimationQuasiIdValues
A tuple of values for the quasi-identifier columns.
Fields | |
---|---|
quasi_ids_values[] |
The quasi-identifier values. |
estimated_probability |
The estimated probability that a given individual sharing these quasi-identifier values is in the dataset. This value, typically called δ, is the ratio between the number of records in the dataset with these quasi-identifier values, and the total number of individuals (inside and outside the dataset) with these quasi-identifier values. For example, if there are 15 individuals in the dataset who share the same quasi-identifier values, and an estimated 100 people in the entire population with these values, then δ is 0.15. |
KAnonymityResult
Result of the k-anonymity computation.
Fields | |
---|---|
equivalence_class_histogram_buckets[] |
Histogram of k-anonymity equivalence classes. |
KAnonymityEquivalenceClass
The set of columns' values that share the same ldiversity value
Fields | |
---|---|
quasi_ids_values[] |
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. |
equivalence_class_size |
Size of the equivalence class, for example number of rows with the above set of values. |
KAnonymityHistogramBucket
Fields | |
---|---|
equivalence_class_size_lower_bound |
Lower bound on the size of the equivalence classes in this bucket. |
equivalence_class_size_upper_bound |
Upper bound on the size of the equivalence classes in this bucket. |
bucket_size |
Total number of equivalence classes in this bucket. |
bucket_values[] |
Sample of equivalence classes in this bucket. The total number of classes returned per bucket is capped at 20. |
bucket_value_count |
Total number of distinct equivalence classes in this bucket. |
KMapEstimationResult
Result of the reidentifiability analysis. Note that these results are an estimation, not exact values.
Fields | |
---|---|
k_map_estimation_histogram[] |
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. |
KMapEstimationHistogramBucket
A 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.
Fields | |
---|---|
min_anonymity |
Always positive. |
max_anonymity |
Always greater than or equal to min_anonymity. |
bucket_size |
Number of records within these anonymity bounds. |
bucket_values[] |
Sample of quasi-identifier tuple values in this bucket. The total number of classes returned per bucket is capped at 20. |
bucket_value_count |
Total number of distinct quasi-identifier tuple values in this bucket. |
KMapEstimationQuasiIdValues
A tuple of values for the quasi-identifier columns.
Fields | |
---|---|
quasi_ids_values[] |
The quasi-identifier values. |
estimated_anonymity |
The estimated anonymity for these quasi-identifier values. |
LDiversityResult
Result of the l-diversity computation.
Fields | |
---|---|
sensitive_value_frequency_histogram_buckets[] |
Histogram of l-diversity equivalence class sensitive value frequencies. |
LDiversityEquivalenceClass
The set of columns' values that share the same ldiversity value.
Fields | |
---|---|
quasi_ids_values[] |
Quasi-identifier values defining the k-anonymity equivalence class. The order is always the same as the original request. |
equivalence_class_size |
Size of the k-anonymity equivalence class. |
num_distinct_sensitive_values |
Number of distinct sensitive values in this equivalence class. |
top_sensitive_values[] |
Estimated frequencies of top sensitive values. |
LDiversityHistogramBucket
Fields | |
---|---|
sensitive_value_frequency_lower_bound |
Lower bound on the sensitive value frequencies of the equivalence classes in this bucket. |
sensitive_value_frequency_upper_bound |
Upper bound on the sensitive value frequencies of the equivalence classes in this bucket. |
bucket_size |
Total number of equivalence classes in this bucket. |
bucket_values[] |
Sample of equivalence classes in this bucket. The total number of classes returned per bucket is capped at 20. |
bucket_value_count |
Total number of distinct equivalence classes in this bucket. |
NumericalStatsResult
Result of the numerical stats computation.
Fields | |
---|---|
min_value |
Minimum value appearing in the column. |
max_value |
Maximum value appearing in the column. |
quantile_values[] |
List of 99 values that partition the set of field values into 100 equal sized buckets. |
BigQueryField
Message defining a field of a BigQuery table.
Fields | |
---|---|
table |
Source table of the field. |
field |
Designated field in the BigQuery table. |
BigQueryKey
Row key for identifying a record in BigQuery table.
Fields | |
---|---|
table_reference |
Complete BigQuery table reference. |
row_number |
Absolute number of the row from the beginning of the table at the time of scanning. |
BigQueryOptions
Options defining BigQuery table and row identifiers.
Fields | |
---|---|
table_reference |
Complete BigQuery table reference. |
identifying_fields[] |
References to fields uniquely identifying rows within the table. Nested fields in the format, like |
rows_limit |
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. |
rows_limit_percent |
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. |
sample_method |
|
excluded_fields[] |
References to fields excluded from scanning. This allows you to skip inspection of entire columns which you know have no findings. |
SampleMethod
How to sample rows if not all rows are scanned. Meaningful only when used in conjunction with either rows_limit or rows_limit_percent. If not specified, scanning would start from the top.
Enums | |
---|---|
SAMPLE_METHOD_UNSPECIFIED |
|
TOP |
Scan from the top (default). |
RANDOM_START |
Randomly pick the row to start scanning. The scanned rows are contiguous. |
BigQueryTable
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: <project_id>:<dataset_id>.<table_id>
or <project_id>.<dataset_id>.<table_id>
.
Fields | |
---|---|
project_id |
The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. |
dataset_id |
Dataset ID of the table. |
table_id |
Name of the table. |
BoundingBox
Bounding box encompassing detected text within an image.
Fields | |
---|---|
top |
Top coordinate of the bounding box. (0,0) is upper left. |
left |
Left coordinate of the bounding box. (0,0) is upper left. |
width |
Width of the bounding box in pixels. |
height |
Height of the bounding box in pixels. |
BucketingConfig
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 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. See https://cloud.google.com/dlp/docs/concepts-bucketing to learn more.
Fields | |
---|---|
buckets[] |
Set of buckets. Ranges must be non-overlapping. |
Bucket
Bucket is represented as a range, along with replacement values.
Fields | |
---|---|
min |
Lower bound of the range, inclusive. Type should be the same as max if used. |
max |
Upper bound of the range, exclusive; type must match min. |
replacement_value |
Replacement value for this bucket. If not provided the default behavior will be to hyphenate the min-max range. |
ByteContentItem
Container for bytes to inspect or redact.
Fields | |
---|---|
type |
The type of data stored in the bytes string. Default will be TEXT_UTF8. |
data |
Content data to inspect or redact. |
BytesType
Enums | |
---|---|
BYTES_TYPE_UNSPECIFIED |
|
IMAGE |
|
IMAGE_JPEG |
|
IMAGE_BMP |
|
IMAGE_PNG |
|
IMAGE_SVG |
|
TEXT_UTF8 |
|
AVRO |
CancelDlpJobRequest
The request message for canceling a DLP job.
Fields | |
---|---|
name |
Required. The name of the DlpJob resource to be cancelled. Authorization requires the following Google IAM permission on the specified resource
|
CharacterMaskConfig
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.
Fields | |
---|---|
masking_character |
Character to use to mask the sensitive values—for example, |
number_to_mask |
Number of characters to mask. If not set, all matching chars will be masked. Skipped characters do not count towards this tally. |
reverse_order |
Mask characters in reverse order. For example, if |
characters_to_ignore[] |
When masking a string, items in this list will be skipped when replacing characters. For example, if the input string is |
CharsToIgnore
Characters to skip when doing deidentification of a value. These will be left alone and skipped.
Fields | ||
---|---|---|
Union field
|
||
characters_to_skip |
|
|
common_characters_to_ignore |
|
CommonCharsToIgnore
Enums | |
---|---|
COMMON_CHARS_TO_IGNORE_UNSPECIFIED |
|
NUMERIC |
0-9 |
ALPHA_UPPER_CASE |
A-Z |
ALPHA_LOWER_CASE |
a-z |
PUNCTUATION |
US Punctuation, one of !"#$%&'()*+,-./:;<=>?@[]^_`{|}~ |
WHITESPACE |
Whitespace character, one of [ \t\n\x0B\f\r] |
CloudStorageFileSet
Message representing a set of files in Cloud Storage.
Fields | |
---|---|
url |
The url, in the format |
CloudStorageOptions
Options defining a file or a set of files within a Google Cloud Storage bucket.
Fields | |
---|---|
file_set |
The set of one or more files to scan. |
bytes_limit_per_file |
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. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. |
bytes_limit_per_file_percent |
Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. |
file_types[] |
List of file type groups to include in the scan. If empty, all files are scanned and available data format processors are applied. In addition, the binary content of the selected files is always scanned as well. |
sample_method |
|
files_limit_percent |
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. |
FileSet
Set of files to scan.
Fields | |
---|---|
url |
The Cloud Storage url of the file(s) to scan, in the format If the url ends in a trailing slash, the bucket or directory represented by the url will be scanned non-recursively (content in sub-directories will not be scanned). This means that Exactly one of |
regex_file_set |
The regex-filtered set of files to scan. Exactly one of |
SampleMethod
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.
Enums | |
---|---|
SAMPLE_METHOD_UNSPECIFIED |
|
TOP |
Scan from the top (default). |
RANDOM_START |
For each file larger than bytes_limit_per_file, randomly pick the offset to start scanning. The scanned bytes are contiguous. |
CloudStoragePath
Message representing a single file or path in Cloud Storage.
Fields | |
---|---|
path |
A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt |
CloudStorageRegexFileSet
Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include.
Included files are those that match at least one item in include_regex
and do not match any items in exclude_regex
. Note that a file that matches items from both lists will not be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression.
For example, given the input {bucket_name: "mybucket", include_regex:
["directory1/.*"], exclude_regex:
["directory1/excluded.*"]}
:
gs://mybucket/directory1/myfile
will be includedgs://mybucket/directory1/directory2/myfile
will be included (.*
matches across/
)gs://mybucket/directory0/directory1/myfile
will not be included (the full path doesn't match any items ininclude_regex
)gs://mybucket/directory1/excludedfile
will not be included (the path matches an item inexclude_regex
)
If include_regex
is left empty, it will match all files by default (this is equivalent to setting include_regex: [".*"]
).
Some other common use cases:
{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}
will include all files inmybucket
except for .pdf files{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}
will include all files directly undergs://mybucket/directory/
, without matching across/
Fields | |
---|---|
bucket_name |
The name of a Cloud Storage bucket. Required. |
include_regex[] |
A list of regular expressions matching file paths to include. All files in the bucket that match at least one of these regular expressions will be included in the set of files, except for those that also match an item in Regular expressions use RE2 syntax; a guide can be found under the google/re2 repository on GitHub. |
exclude_regex[] |
A list of regular expressions matching file paths to exclude. All files in the bucket that match at least one of these regular expressions will be excluded from the scan. Regular expressions use RE2 syntax; a guide can be found under the google/re2 repository on GitHub. |
Color
Represents a color in the RGB color space.
Fields | |
---|---|
red |
The amount of red in the color as a value in the interval [0, 1]. |
green |
The amount of green in the color as a value in the interval [0, 1]. |
blue |
The amount of blue in the color as a value in the interval [0, 1]. |
ContentItem
Container structure for the content to inspect.
Fields | ||
---|---|---|
Union field data_item . Data of the item either in the byte array or UTF-8 string form, or table. data_item can be only one of the following: |
||
value |
String data to inspect or redact. |
|
table |
Structured content for inspection. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more. |
|
byte_item |
Content data to inspect or redact. Replaces |
ContentLocation
Findings container location data.
Fields | ||
---|---|---|
container_name |
Name of the container where the finding is located. The top level name is the source file name or table name. Names of some common storage containers are formatted as follows:
Nested names could be absent if the embedded object has no string identifier (for an example an image contained within a document). |
|
container_timestamp |
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. |
|
container_version |
Findings container version, if available ("generation" for Google Cloud Storage). |
|
Union field location . Type of the container within the file with location of the finding. location can be only one of the following: |
||
record_location |
Location within a row or record of a database table. |
|
image_location |
Location within an image's pixels. |
|
document_location |
Location data for document files. |
ContentOption
Options describing which parts of the provided content should be scanned.
Enums | |
---|---|
CONTENT_UNSPECIFIED |
Includes entire content of a file or a data stream. |
CONTENT_TEXT |
Text content within the data, excluding any metadata. |
CONTENT_IMAGE |
Images found in the data. |
CreateDeidentifyTemplateRequest
Request message for CreateDeidentifyTemplate.
Fields | |
---|---|
parent |
Required. The parent resource name, for example projects/my-project-id or organizations/my-org-id. Authorization requires the following Google IAM permission on the specified resource
|
deidentify_template |
The DeidentifyTemplate to create. |
template_id |
The template id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: |
location_id |
The geographic location to store the deidentification template. Reserved for future extensions. |
CreateDlpJobRequest
Request message for CreateDlpJobRequest. Used to initiate long running jobs such as calculating risk metrics or inspecting Google Cloud Storage.
Fields | ||
---|---|---|
parent |
Required. The parent resource name, for example projects/my-project-id. Authorization requires the following Google IAM permission on the specified resource
|
|
job_id |
The job id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: |
|
location_id |
The geographic location to store and process the job. Reserved for future extensions. |
|
Union field job . The configuration details for the specific type of job to run. job can be only one of the following: |
||
inspect_job |
|
|
risk_job |
|
CreateInspectTemplateRequest
Request message for CreateInspectTemplate.
Fields | |
---|---|
parent |
Required. The parent resource name, for example projects/my-project-id or organizations/my-org-id. Authorization requires the following Google IAM permission on the specified resource
|
inspect_template |
The InspectTemplate to create. |
template_id |
The template id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: |
location_id |
The geographic location to store the inspection template. Reserved for future extensions. |
CreateJobTriggerRequest
Request message for CreateJobTrigger.
Fields | |
---|---|
parent |
Required. The parent resource name, for example projects/my-project-id. Authorization requires one or more of the following Google IAM permissions on the specified resource
|
job_trigger |
The JobTrigger to create. |
trigger_id |
The trigger id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: |
location_id |
The geographic location to store the job trigger. Reserved for future extensions. |
CreateStoredInfoTypeRequest
Request message for CreateStoredInfoType.
Fields | |
---|---|
parent |
Required. The parent resource name, for example projects/my-project-id or organizations/my-org-id. Authorization requires the following Google IAM permission on the specified resource
|
config |
Configuration of the storedInfoType to create. |
stored_info_type_id |
The storedInfoType ID can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: |
location_id |
The geographic location to store the stored infoType. Reserved for future extensions. |
CryptoDeterministicConfig
Pseudonymization method that generates deterministic encryption for the given input. Outputs a base64 encoded representation of the encrypted output. Uses AES-SIV based on the RFC https://tools.ietf.org/html/rfc5297.
Fields | |
---|---|
crypto_key |
The key used by the encryption function. |
surrogate_info_type |
The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: For example, if the name of custom info type 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 info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are optional to use. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either
Therefore, choose your custom info type 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. |
context |
Optional. A context may be used for higher security and maintaining referential integrity such that the same identifier in two different contexts will be given a distinct surrogate. The context is appended to plaintext value being encrypted. On decryption the provided context is validated against the value used during encryption. If a context was provided during encryption, same context must be provided during decryption as well. If the context is not set, plaintext would be used as is for encryption. If the context is set but:
plaintext would be used as is for encryption. Note that case (1) is expected when an |
CryptoHashConfig
Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/dlp/docs/pseudonymization to learn more.
Fields | |
---|---|
crypto_key |
The key used by the hash function. |
CryptoKey
This 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.
Fields | ||
---|---|---|
Union field
|
||
transient |
|
|
unwrapped |
|
|
kms_wrapped |
|
CryptoReplaceFfxFpeConfig
Replaces an identifier with a surrogate using Format Preserving Encryption (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 https://cloud.google.com/dlp/docs/pseudonymization to learn more.
Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity.
Fields | ||
---|---|---|
crypto_key |
The key used by the encryption algorithm. [required] |
|
context |
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:
a default tweak will be used. Note that case (1) is expected when an The tweak is constructed as a sequence of bytes in big endian byte order such that:
|
|
surrogate_info_type |
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 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 |
|
Union field
|
||
common_alphabet |
|
|
custom_alphabet |
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, 95]. This must be encoded as ASCII. The order of characters does not matter. |
|
radix |
The native way to select the alphabet. Must be in the range [2, 95]. |
FfxCommonNativeAlphabet
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.
Enums | |
---|---|
FFX_COMMON_NATIVE_ALPHABET_UNSPECIFIED |
|
NUMERIC |
[0-9] (radix of 10) |
HEXADECIMAL |
[0-9A-F] (radix of 16) |
UPPER_CASE_ALPHA_NUMERIC |
[0-9A-Z] (radix of 36) |
ALPHA_NUMERIC |
[0-9A-Za-z] (radix of 62) |
CustomInfoType
Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question.
Fields | ||
---|---|---|
info_type |
CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in |
|
likelihood |
Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to |
|
detection_rules[] |
Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the |
|
exclusion_type |
If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. |
|
Union field
|
||
dictionary |
A list of phrases to detect as a CustomInfoType. |
|
regex |
Regular expression based CustomInfoType. |
|
surrogate_type |
Message for detecting output from deidentification transformations that support reversing. |
|
stored_type |
Load an existing |
DetectionRule
Deprecated; use InspectionRuleSet
instead. Rule for modifying a CustomInfoType
to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the surrogate_type
custom infoType.
Fields | |
---|---|
hotword_rule |
Hotword-based detection rule. |
HotwordRule
The rule that adjusts the likelihood of findings within a certain proximity of hotwords.
Fields | |
---|---|
hotword_regex |
Regular expression pattern defining what qualifies as a hotword. |
proximity |
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. |
likelihood_adjustment |
Likelihood adjustment to apply to all matching findings. |
LikelihoodAdjustment
Message for specifying an adjustment to the likelihood of a finding as part of a detection rule.
Fields | ||
---|---|---|
Union field
|
||
fixed_likelihood |
Set the likelihood of a finding to a fixed value. |
|
relative_likelihood |
Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be |
Proximity
Message for specifying a window around a finding to apply a detection rule.
Fields | |
---|---|
window_before |
Number of characters before the finding to consider. |
window_after |
Number of characters after the finding to consider. |
Dictionary
Custom 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 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. The limits page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using LargeCustomDictionaryConfig
in the StoredInfoType
API.
Fields | ||
---|---|---|
Union field
|
||
word_list |
List of words or phrases to search for. |
|
cloud_storage_path |
Newline-delimited file of words in Cloud Storage. Only a single file is accepted. |
WordList
Message defining a list of words or phrases to search for in the data.
Fields | |
---|---|
words[] |
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] |
ExclusionType
Enums | |
---|---|
EXCLUSION_TYPE_UNSPECIFIED |
A finding of this custom info type will not be excluded from results. |
EXCLUSION_TYPE_EXCLUDE |
A finding of this custom info type will be excluded from final results, but can still affect rule execution. |
Regex
Message defining a custom regular expression.
Fields | |
---|---|
pattern |
Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. |
group_indexes[] |
The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. |
SurrogateType
Message for detecting output from deidentification transformations such as 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 CustomInfoType does not support the use of detection_rules
.
DatastoreKey
Record key for a finding in Cloud Datastore.
Fields | |
---|---|
entity_key |
Datastore entity key. |
DatastoreOptions
Options defining a data set within Google Cloud Datastore.
Fields | |
---|---|
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. |
kind |
The kind to process. |
DateShiftConfig
Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/dlp/docs/concepts-date-shifting to learn more.
Fields | |
---|---|
upper_bound_days |
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] |
lower_bound_days |
For example, -5 means shift date to at most 5 days back in the past. [Required] |
context |
Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. |
crypto_key |
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. If set, must also set context. Can only be applied to table items. |
DateTime
Message for a date time object. e.g. 2018-01-01, 5th August.
Fields | |
---|---|
date |
One or more of the following must be set. All fields are optional, but when set must be valid date or time values. |
day_of_week |
|
time |
|
time_zone |
|
TimeZone
Fields | |
---|---|
offset_minutes |
Set only if the offset can be determined. Positive for time ahead of UTC. E.g. For "UTC-9", this value is -540. |
DeidentifyConfig
The configuration that controls how the data will change.
Fields | ||
---|---|---|
Union field
|
||
info_type_transformations |
Treat the dataset as free-form text and apply the same free text transformation everywhere. |
|
record_transformations |
Treat the dataset as structured. Transformations can be applied to specific locations within structured datasets, such as transforming a column within a table. |
DeidentifyContentRequest
Request to de-identify a list of items.
Fields | |
---|---|
parent |
The parent resource name, for example projects/my-project-id. Authorization requires the following Google IAM permission on the specified resource
|
deidentify_config |
Configuration for the de-identification of the content item. Items specified here will override the template referenced by the deidentify_template_name argument. |
inspect_config |
Configuration for the inspector. Items specified here will override the template referenced by the inspect_template_name argument. |
item |
The item to de-identify. Will be treated as text. |
inspect_template_name |
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. |
deidentify_template_name |
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. |
location_id |
The geographic location to process de-identification. Reserved for future extensions. |
DeidentifyContentResponse
Results of de-identifying a ContentItem.
Fields | |
---|---|
item |
The de-identified item. |
overview |
An overview of the changes that were made on the |
DeidentifyTemplate
DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/dlp/docs/concepts-templates to learn more.
Fields | |
---|---|
name |
The template name. Output only. The template will have one of the following formats: |
display_name |
Display name (max 256 chars). |
description |
Short description (max 256 chars). |
create_time |
The creation timestamp of an inspectTemplate, output only field. |
update_time |
The last update timestamp of an inspectTemplate, output only field. |
deidentify_config |
///////////// // The core content of the template // /////////////// |
DeleteDeidentifyTemplateRequest
Request message for DeleteDeidentifyTemplate.
Fields | |
---|---|
name |
Required. Resource name of the organization and deidentify template to be deleted, for example Authorization requires the following Google IAM permission on the specified resource
|
DeleteDlpJobRequest
The request message for deleting a DLP job.
Fields | |
---|---|
name |
Required. The name of the DlpJob resource to be deleted. Authorization requires the following Google IAM permission on the specified resource
|
DeleteInspectTemplateRequest
Request message for DeleteInspectTemplate.
Fields | |
---|---|
name |
Required. Resource name of the organization and inspectTemplate to be deleted, for example Authorization requires the following Google IAM permission on the specified resource
|
DeleteJobTriggerRequest
Request message for DeleteJobTrigger.
Fields | |
---|---|
name |
Required. Resource name of the project and the triggeredJob, for example Authorization requires the following Google IAM permission on the specified resource
|
DeleteStoredInfoTypeRequest
Request message for DeleteStoredInfoType.
Fields | |
---|---|
name |
Required. Resource name of the organization and storedInfoType to be deleted, for example Authorization requires the following Google IAM permission on the specified resource
|
DlpJob
Combines all of the information about a DLP job.
Fields | ||
---|---|---|
name |
The server-assigned name. |
|
type |
The type of job. |
|
state |
State of a job. |
|
create_time |
Time when the job was created. |
|
start_time |
Time when the job started. |
|
end_time |
Time when the job finished. |
|
job_trigger_name |
If created by a job trigger, the resource name of the trigger that instantiated the job. |
|
errors[] |
A stream of errors encountered running the job. |
|
Union field
|
||
risk_details |
Results from analyzing risk of a data source. |
|
inspect_details |
Results from inspecting a data source. |
JobState
Enums | |
---|---|
JOB_STATE_UNSPECIFIED |
|
PENDING |
The job has not yet started. |
RUNNING |
The job is currently running. |
DONE |
The job is no longer running. |
CANCELED |
The job was canceled before it could complete. |
FAILED |
The job had an error and did not complete. |
DlpJobType
An enum to represent the various type of DLP jobs.
Enums | |
---|---|
DLP_JOB_TYPE_UNSPECIFIED |
|
INSPECT_JOB |
The job inspected Google Cloud for sensitive data. |
RISK_ANALYSIS_JOB |
The job executed a Risk Analysis computation. |
DocumentLocation
Location of a finding within a document.
Fields | |
---|---|
file_offset |
Offset of the line, from the beginning of the file, where the finding is located. |
EntityId
An 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.
Fields | |
---|---|
field |
Composite key indicating which field contains the entity identifier. |
Error
Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger. Output only field.
Fields | |
---|---|
details |
|
timestamps[] |
The times the error occurred. |
ExcludeInfoTypes
List of exclude infoTypes.
Fields | |
---|---|
info_types[] |
InfoType list in ExclusionRule rule drops a finding when it overlaps or contained within with a finding of an infoType from this list. For example, for |
ExclusionRule
The rule that specifies conditions when findings of infoTypes specified in InspectionRuleSet
are removed from results.
Fields | ||
---|---|---|
matching_type |
How the rule is applied, see MatchingType documentation for details. |
|
Union field
|
||
dictionary |
Dictionary which defines the rule. |
|
regex |
Regular expression which defines the rule. |
|
exclude_info_types |
Set of infoTypes for which findings would affect this rule. |
FieldId
General identifier of a data field in a storage service.
Fields | |
---|---|
name |
Name describing the field. |
FieldTransformation
The transformation to apply to the field.
Fields | ||
---|---|---|
fields[] |
Input field(s) to apply the transformation to. [required] |
|
condition |
Only apply the transformation if the condition evaluates to true for the given Example Use Cases:
|
|
Union field transformation . Transformation to apply. [required] transformation can be only one of the following: |
||
primitive_transformation |
Apply the transformation to the entire field. |
|
info_type_transformations |
Treat the contents of the field as free text, and selectively transform content that matches an |
FileType
Definitions of file type groups to scan.
Enums | |
---|---|
FILE_TYPE_UNSPECIFIED |
Includes all files. |
BINARY_FILE |
Includes all file extensions not covered by text file types. |
TEXT_FILE |
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. |
IMAGE |
Included file extensions: bmp, gif, jpg, jpeg, jpe, png. bytes_limit_per_file has no effect on image files. |
AVRO |
Included file extensions: avro |
Finding
Represents a piece of potentially sensitive content.
Fields | |
---|---|
quote |
The content that was found. Even if the content is not textual, it may be converted to a textual representation here. Provided if |
info_type |
The type of content that might have been found. Provided if |
likelihood |
Confidence of how likely it is that the |
location |
Where the content was found. |
create_time |
Timestamp when finding was detected. |
quote_info |
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. |
FixedSizeBucketingConfig
Buckets 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
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.
See https://cloud.google.com/dlp/docs/concepts-bucketing to learn more.
Fields | |
---|---|
lower_bound |
Lower bound value of buckets. All values less than |
upper_bound |
Upper bound value of buckets. All values greater than upper_bound are grouped together into a single bucket; for example if |
bucket_size |
Size of each bucket (except for minimum and maximum buckets). So if |
GetDeidentifyTemplateRequest
Request message for GetDeidentifyTemplate.
Fields | |
---|---|
name |
Required. Resource name of the organization and deidentify template to be read, for example Authorization requires the following Google IAM permission on the specified resource
|
GetDlpJobRequest
The request message for [DlpJobs.GetDlpJob][].
Fields | |
---|---|
name |
Required. The name of the DlpJob resource. Authorization requires the following Google IAM permission on the specified resource
|
GetInspectTemplateRequest
Request message for GetInspectTemplate.
Fields | |
---|---|
name |
Required. Resource name of the organization and inspectTemplate to be read, for example Authorization requires the following Google IAM permission on the specified resource
|
GetJobTriggerRequest
Request message for GetJobTrigger.
Fields | |
---|---|
name |
Required. Resource name of the project and the triggeredJob, for example Authorization requires the following Google IAM permission on the specified resource
|
GetStoredInfoTypeRequest
Request message for GetStoredInfoType.
Fields | |
---|---|
name |
Required. Resource name of the organization and storedInfoType to be read, for example Authorization requires the following Google IAM permission on the specified resource
|
ImageLocation
Location of the finding within an image.
Fields | |
---|---|
bounding_boxes[] |
Bounding boxes locating the pixels within the image containing the finding. |
InfoType
Type of information detected by the API.
Fields | |
---|---|
name |
Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. InfoType names should conform to the pattern [a-zA-Z0-9_]{1,64}. |
InfoTypeDescription
InfoType description.
Fields | |
---|---|
name |
Internal name of the infoType. |
display_name |
Human readable form of the infoType name. |
supported_by[] |
Which parts of the API supports this InfoType. |
description |
Description of the infotype. Translated when language is provided in the request. |
InfoTypeStats
Statistics regarding a specific InfoType.
Fields | |
---|---|
info_type |
The type of finding this stat is for. |
count |
Number of findings for this infoType. |
InfoTypeSupportedBy
Parts of the APIs which use certain infoTypes.
Enums | |
---|---|
ENUM_TYPE_UNSPECIFIED |
|
INSPECT |
Supported by the inspect operations. |
RISK_ANALYSIS |
Supported by the risk analysis operations. |
InfoTypeTransformations
A 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.
Fields | |
---|---|
transformations[] |
Transformation for each infoType. Cannot specify more than one for a given infoType. [required] |
InfoTypeTransformation
A transformation to apply to text that is identified as a specific info_type.
Fields | |
---|---|
info_types[] |
InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in |
primitive_transformation |
Primitive transformation to apply to the infoType. [required] |
InspectConfig
Configuration description of the scanning process. When used with redactContent only info_types and min_likelihood are currently used.
Fields | |
---|---|
info_types[] |
Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or listed at https://cloud.google.com/dlp/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. If you need precise control and predictability as to what detectors are run you should specify specific InfoTypes listed in the reference, otherwise a default list will be used, which may change over time. |
min_likelihood |
Only returns findings equal or above this threshold. The default is POSSIBLE. See https://cloud.google.com/dlp/docs/likelihood to learn more. |
limits |
|
include_quote |
When true, a contextual quote from the data that triggered a finding is included in the response; see Finding.quote. |
exclude_info_types |
When true, excludes type information of the findings. |
custom_info_types[] |
CustomInfoTypes provided by the user. See https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more. |
content_options[] |
List of options defining data content to scan. If empty, text, images, and other content will be included. |
rule_set[] |
Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. |
FindingLimits
Fields | |
---|---|
max_findings_per_item |
Max number of findings that will be returned for each item scanned. When set within |
max_findings_per_request |
Max number of findings that will be returned per request/job. When set within |
max_findings_per_info_type[] |
Configuration of findings limit given for specified infoTypes. |
InfoTypeLimit
Max findings configuration per infoType, per content item or long running DlpJob.
Fields | |
---|---|
info_type |
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. |
max_findings |
Max findings limit for the given infoType. |
InspectContentRequest
Request to search for potentially sensitive info in a ContentItem.
Fields | |
---|---|
parent |
The parent resource name, for example projects/my-project-id. Authorization requires the following Google IAM permission on the specified resource
|
inspect_config |
Configuration for the inspector. What specified here will override the template referenced by the inspect_template_name argument. |
item |
The item to inspect. |
inspect_template_name |
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. |
location_id |
The geographic location to process content inspection. Reserved for future extensions. |
InspectContentResponse
Results of inspecting an item.
Fields | |
---|---|
result |
The findings. |
InspectDataSourceDetails
The results of an inspect DataSource job.
Fields | |
---|---|
requested_options |
The configuration used for this job. |
result |
A summary of the outcome of this inspect job. |
RequestedOptions
Fields | |
---|---|
snapshot_inspect_template |
If run with an InspectTemplate, a snapshot of its state at the time of this run. |
job_config |
|
Result
All result fields mentioned below are updated while the job is processing.
Fields | |
---|---|
processed_bytes |
Total size in bytes that were processed. |
total_estimated_bytes |
Estimate of the number of bytes to process. |
info_type_stats[] |
Statistics of how many instances of each info type were found during inspect job. |
InspectJobConfig
Fields | |
---|---|
storage_config |
The data to scan. |
inspect_config |
How and what to scan for. |
inspect_template_name |
If provided, will be used as the default for all values in InspectConfig. |
actions[] |
Actions to execute at the completion of the job. |
InspectResult
All the findings for a single scanned item.
Fields | |
---|---|
findings[] |
List of findings for an item. |
findings_truncated |
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. |
InspectTemplate
The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/dlp/docs/concepts-templates to learn more.
Fields | |
---|---|
name |
The template name. Output only. The template will have one of the following formats: |
display_name |
Display name (max 256 chars). |
description |
Short description (max 256 chars). |
create_time |
The creation timestamp of an inspectTemplate, output only field. |
update_time |
The last update timestamp of an inspectTemplate, output only field. |
inspect_config |
The core content of the template. Configuration of the scanning process. |
InspectionRule
A single inspection rule to be applied to infoTypes, specified in InspectionRuleSet
.
Fields | ||
---|---|---|
Union field
|
||
hotword_rule |
Hotword-based detection rule. |
|
exclusion_rule |
Exclusion rule. |
InspectionRuleSet
Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set.
Fields | |
---|---|
info_types[] |
List of infoTypes this rule set is applied to. |
rules[] |
Set of rules to be applied to infoTypes. The rules are applied in order. |
JobTrigger
Contains a configuration to make dlp api calls on a repeating basis. See https://cloud.google.com/dlp/docs/concepts-job-triggers to learn more.
Fields | |
---|---|
name |
Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example |
display_name |
Display name (max 100 chars) |
description |
User provided description (max 256 chars) |
triggers[] |
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. |
errors[] |
A stream of errors encountered when the trigger was activated. Repeated errors may result in the JobTrigger automatically being paused. Will return the last 100 errors. Whenever the JobTrigger is modified this list will be cleared. Output only field. |
create_time |
The creation timestamp of a triggeredJob, output only field. |
update_time |
The last update timestamp of a triggeredJob, output only field. |
last_run_time |
The timestamp of the last time this trigger executed, output only field. |
status |
A status for this trigger. [required] |
inspect_job |
|
Status
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.
Enums | |
---|---|
STATUS_UNSPECIFIED |
|
HEALTHY |
Trigger is healthy. |
PAUSED |
Trigger is temporarily paused. |
CANCELLED |
Trigger is cancelled and can not be resumed. |
Trigger
What event needs to occur for a new job to be started.
Fields | |
---|---|
schedule |
Create a job on a repeating basis based on the elapse of time. |
Key
A 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.
Fields | |
---|---|
partition_id |
Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. |
path[] |
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. |
PathElement
A (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.
Fields | ||
---|---|---|
kind |
The kind of the entity. A kind matching regex |
|
Union field id_type . The type of ID. id_type can be only one of the following: |
||
id |
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. |
|
name |
The name of the entity. A name matching regex |
KindExpression
A representation of a Datastore kind.
Fields | |
---|---|
name |
The name of the kind. |
KmsWrappedCryptoKey
Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128/192/256 bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a kms-wrapped crypto key: dlp.kms.encrypt
Fields | |
---|---|
wrapped_key |
The wrapped data crypto key. [required] |
crypto_key_name |
The resource name of the KMS CryptoKey to use for unwrapping. [required] |
LargeCustomDictionaryConfig
Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the limits page. The artifacts of dictionary creation are stored in the specified Google Cloud Storage location. Consider using CustomInfoType.Dictionary
for smaller dictionaries that satisfy the size requirements.
Fields | ||
---|---|---|
output_path |
Location to store dictionary artifacts in Google Cloud Storage. These files will only be accessible by project owners and the DLP API. If any of these artifacts are modified, the dictionary is considered invalid and can no longer be used. |
|
Union field
|
||
cloud_storage_file_set |
Set of files containing newline-delimited lists of dictionary phrases. |
|
big_query_field |
Field in a BigQuery table where each cell represents a dictionary phrase. |
LargeCustomDictionaryStats
Summary statistics of a custom dictionary.
Fields | |
---|---|
approx_num_phrases |
Approximate number of distinct phrases in the dictionary. |
Likelihood
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.
Enums | |
---|---|
LIKELIHOOD_UNSPECIFIED |
Default value; same as POSSIBLE. |
VERY_UNLIKELY |
Few matching elements. |
UNLIKELY |
|
POSSIBLE |
Some matching elements. |
LIKELY |
|
VERY_LIKELY |
Many matching elements. |
ListDeidentifyTemplatesRequest
Request message for ListDeidentifyTemplates.
Fields | |
---|---|
parent |
Required. The parent resource name, for example projects/my-project-id or organizations/my-org-id. Authorization requires the following Google IAM permission on the specified resource
|
page_token |
Optional page token to continue retrieval. Comes from previous call to |
page_size |
Optional size of the page, can be limited by server. If zero server returns a page of max size 100. |
order_by |
Optional comma separated list of fields to order by, followed by Example: Supported fields are:
|
location_id |
The geographic location where deidentifications templates will be retrieved from. Use |
ListDeidentifyTemplatesResponse
Response message for ListDeidentifyTemplates.
Fields | |
---|---|
deidentify_templates[] |
List of deidentify templates, up to page_size in ListDeidentifyTemplatesRequest. |
next_page_token |
If the next page is available then the next page token to be used in following ListDeidentifyTemplates request. |
ListDlpJobsRequest
The request message for listing DLP jobs.
Fields | |
---|---|
parent |
Required. The parent resource name, for example projects/my-project-id. Authorization requires the following Google IAM permission on the specified resource
|
filter |
Optional. Allows filtering. Supported syntax:
Examples:
The length of this field should be no more than 500 characters. |
page_size |
The standard list page size. |
page_token |
The standard list page token. |
type |
The type of job. Defaults to |
order_by |
Optional comma separated list of fields to order by, followed by Example: Supported fields are:
|
location_id |
The geographic location where jobs will be retrieved from. Use |
ListDlpJobsResponse
The response message for listing DLP jobs.
Fields | |
---|---|
jobs[] |
A list of DlpJobs that matches the specified filter in the request. |
next_page_token |
The standard List next-page token. |
ListInfoTypesRequest
Request for the list of infoTypes.
Fields | |
---|---|
language_code |
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. |
filter |
Optional filter to only return infoTypes supported by certain parts of the API. Defaults to supported_by=INSPECT. |
location_id |
The geographic location to list info types. Reserved for future extensions. |
ListInfoTypesResponse
Response to the ListInfoTypes request.
Fields | |
---|---|
info_types[] |
Set of sensitive infoTypes. |
ListInspectTemplatesRequest
Request message for ListInspectTemplates.
Fields | |
---|---|
parent |
Required. The parent resource name, for example projects/my-project-id or organizations/my-org-id. Authorization requires the following Google IAM permission on the specified resource
|
page_token |
Optional page token to continue retrieval. Comes from previous call to |
page_size |
Optional size of the page, can be limited by server. If zero server returns a page of max size 100. |
order_by |
Optional comma separated list of fields to order by, followed by Example: Supported fields are:
|
location_id |
The geographic location where inspection templates will be retrieved from. Use |
ListInspectTemplatesResponse
Response message for ListInspectTemplates.
Fields | |
---|---|
inspect_templates[] |
List of inspectTemplates, up to page_size in ListInspectTemplatesRequest. |
next_page_token |
If the next page is available then the next page token to be used in following ListInspectTemplates request. |
ListJobTriggersRequest
Request message for ListJobTriggers.
Fields | |
---|---|
parent |
Required. The parent resource name, for example Authorization requires the following Google IAM permission on the specified resource
|
page_token |
Optional page token to continue retrieval. Comes from previous call to ListJobTriggers. |
page_size |
Optional size of the page, can be limited by a server. |
order_by |
Optional comma separated list of triggeredJob fields to order by, followed by Example: Supported fields are:
|
filter |
Optional. Allows filtering. Supported syntax:
Examples:
The length of this field should be no more than 500 characters. |
location_id |
The geographic location where job triggers will be retrieved from. Use |
ListJobTriggersResponse
Response message for ListJobTriggers.
Fields | |
---|---|
job_triggers[] |
List of triggeredJobs, up to page_size in ListJobTriggersRequest. |
next_page_token |
If the next page is available then the next page token to be used in following ListJobTriggers request. |
ListStoredInfoTypesRequest
Request message for ListStoredInfoTypes.
Fields | |
---|---|
parent |
Required. The parent resource name, for example projects/my-project-id or organizations/my-org-id. Authorization requires the following Google IAM permission on the specified resource
|
page_token |
Optional page token to continue retrieval. Comes from previous call to |
page_size |
Optional size of the page, can be limited by server. If zero server returns a page of max size 100. |
order_by |
Optional comma separated list of fields to order by, followed by Example: Supported fields are:
|
location_id |
The geographic location where stored infoTypes will be retrieved from. Use |
ListStoredInfoTypesResponse
Response message for ListStoredInfoTypes.
Fields | |
---|---|
stored_info_types[] |
List of storedInfoTypes, up to page_size in ListStoredInfoTypesRequest. |
next_page_token |
If the next page is available then the next page token to be used in following ListStoredInfoTypes request. |
Location
Specifies the location of the finding.
Fields | |
---|---|
byte_range |
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. |
codepoint_range |
Unicode character offsets delimiting the finding. These are relative to the finding's containing element. Provided when the content is text. |
content_locations[] |
List of nested objects pointing to the precise location of the finding within the file or record. |
MatchingType
Type of the match which can be applied to different ways of matching, like Dictionary, regular expression and intersecting with findings of another info type.
Enums | |
---|---|
MATCHING_TYPE_UNSPECIFIED |
Invalid. |
MATCHING_TYPE_FULL_MATCH |
Full match.
|
MATCHING_TYPE_PARTIAL_MATCH |
Partial match.
|
MATCHING_TYPE_INVERSE_MATCH |
Inverse match.
|
OutputStorageConfig
Cloud repository for storing output.
Fields | |
---|---|
output_schema |
Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. |
table |
Store findings in an existing table or a new table in an existing dataset. 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. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. |
OutputSchema
Predefined schemas for storing findings.
Enums | |
---|---|
OUTPUT_SCHEMA_UNSPECIFIED |
|
BASIC_COLUMNS |
Basic schema including only info_type , quote , certainty , and timestamp . |
GCS_COLUMNS |
Schema tailored to findings from scanning Google Cloud Storage. |
DATASTORE_COLUMNS |
Schema tailored to findings from scanning Google Datastore. |
BIG_QUERY_COLUMNS |
Schema tailored to findings from scanning Google BigQuery. |
ALL_COLUMNS |
Schema containing all columns. |
PartitionId
Datastore 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.
Fields | |
---|---|
project_id |
The ID of the project to which the entities belong. |
namespace_id |
If not empty, the ID of the namespace to which the entities belong. |
PrimitiveTransformation
A rule for transforming a value.
Fields | ||
---|---|---|
Union field
|
||
replace_config |
|
|
redact_config |
|
|
character_mask_config |
|
|
crypto_replace_ffx_fpe_config |
|
|
fixed_size_bucketing_config |
|
|
bucketing_config |
|
|
replace_with_info_type_config |
|
|
time_part_config |
|
|
crypto_hash_config |
|
|
date_shift_config |
|
|
crypto_deterministic_config |
|
PrivacyMetric
Privacy metric to compute for reidentification risk analysis.
Fields | ||
---|---|---|
Union field
|
||
numerical_stats_config |
|
|
categorical_stats_config |
|
|
k_anonymity_config |
|
|
l_diversity_config |
|
|
k_map_estimation_config |
|
|
delta_presence_estimation_config |
|
CategoricalStatsConfig
Compute numerical stats over an individual column, including number of distinct values and value count distribution.
Fields | |
---|---|
field |
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. |
DeltaPresenceEstimationConfig
δ-presence metric, used to estimate how likely it is for an attacker to figure out that one given individual appears in a de-identified dataset. Similarly to the k-map metric, we cannot compute δ-presence exactly without knowing the attack dataset, so we use a statistical model instead.
Fields | |
---|---|
quasi_ids[] |
Fields considered to be quasi-identifiers. No two fields can have the same tag. [required] |
region_code |
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. |
auxiliary_tables[] |
Several auxiliary tables can be used in the analysis. Each custom_tag used to tag a quasi-identifiers field must appear in exactly one field of one auxiliary table. |
KAnonymityConfig
k-anonymity metric, used for analysis of reidentification risk.
Fields | |
---|---|
quasi_ids[] |
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. |
entity_id |
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 distinct 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. |
KMapEstimationConfig
Reidentifiability 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.
Fields | |
---|---|
quasi_ids[] |
Fields considered to be quasi-identifiers. No two columns can have the same tag. [required] |
region_code |
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. |
auxiliary_tables[] |
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. |
AuxiliaryTable
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).
Fields | |
---|---|
table |
Auxiliary table location. [required] |
quasi_ids[] |
Quasi-identifier columns. [required] |
relative_frequency |
The relative frequency column must contain a floating-point number between 0 and 1 (inclusive). Null values are assumed to be zero. [required] |
QuasiIdField
A quasi-identifier column has a custom_tag, used to know which column in the data corresponds to which column in the statistical model.
Fields | |
---|---|
field |
|
custom_tag |
|
TaggedField
Fields | ||
---|---|---|
field |
Identifies the column. [required] |
|
Union field tag . Semantic tag that identifies what a column contains, to determine which statistical model to use to estimate the reidentifiability of each value. [required] tag can be only one of the following: |
||
info_type |
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. |
|
custom_tag |
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 |
If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data |
LDiversityConfig
l-diversity metric, used for analysis of reidentification risk.
Fields | |
---|---|
quasi_ids[] |
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. |
sensitive_attribute |
Sensitive field for computing the l-value. |
NumericalStatsConfig
Compute numerical stats over an individual column, including min, max, and quantiles.
Fields | |
---|---|
field |
Field to compute numerical stats on. Supported types are integer, float, date, datetime, timestamp, time. |
QuasiId
A column with a semantic tag attached.
Fields | ||
---|---|---|
field |
Identifies the column. [required] |
|
Union field tag . Semantic tag that identifies what a column contains, to determine which statistical model to use to estimate the reidentifiability of each value. [required] tag can be only one of the following: |
||
info_type |
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. |
|
custom_tag |
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 |
If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data |
QuoteInfo
Message for infoType-dependent details parsed from quote.
Fields | |
---|---|
date_time |
The date time indicated by the quote. |
Range
Generic half-open interval [start, end)
Fields | |
---|---|
start |
Index of the first character of the range (inclusive). |
end |
Index of the last character of the range (exclusive). |
RecordCondition
A condition for determining whether a transformation should be applied to a field.
Fields | |
---|---|
expressions |
An expression. |
Condition
The field type of value
and field
do not need to match to be considered equal, but not all comparisons are possible. EQUAL_TO and NOT_EQUAL_TO attempt to compare even with incompatible types, but all other comparisons are invalid with incompatible types. A value
of type:
string
can be compared against all other typesboolean
can only be compared against other booleansinteger
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.
Fields | |
---|---|
field |
Field within the record this condition is evaluated against. [required] |
operator |
Operator used to compare the field or infoType to the value. [required] |
value |
Value to compare against. [Required, except for |
Conditions
A collection of conditions.
Fields | |
---|---|
conditions[] |
|
Expressions
An expression, consisting or an operator and conditions.
Fields | |
---|---|
logical_operator |
The operator to apply to the result of conditions. Default and currently only supported value is |
conditions |
|
LogicalOperator
Enums | |
---|---|
LOGICAL_OPERATOR_UNSPECIFIED |
|
AND |
RecordKey
Message for a unique key indicating a record that contains a finding.
Fields | ||
---|---|---|
id_values[] |
Values of identifying columns in the given row. Order of values matches the order of field identifiers specified in the scanning request. |
|
Union field
|
||
datastore_key |
|
|
big_query_key |
|
RecordLocation
Location of a finding within a row or record.
Fields | |
---|---|
record_key |
Key of the finding. |
field_id |
Field id of the field containing the finding. |
table_location |
Location within a |
RecordSuppression
Configuration to suppress records whose suppression conditions evaluate to true.
Fields | |
---|---|
condition |
A condition that when it evaluates to true will result in the record being evaluated to be suppressed from the transformed content. |
RecordTransformations
A type of transformation that is applied over structured data such as a table.
Fields | |
---|---|
field_transformations[] |
Transform the record by applying various field transformations. |
record_suppressions[] |
Configuration defining which records get suppressed entirely. Records that match any suppression rule are omitted from the output [optional]. |
RedactConfig
Redact 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 '.
RedactImageRequest
Request to search for potentially sensitive info in an image and redact it by covering it with a colored rectangle.
Fields | |
---|---|
parent |
The parent resource name, for example projects/my-project-id. Authorization requires the following Google IAM permission on the specified resource
|
location_id |
The geographic location to process the request. Reserved for future extensions. |
inspect_config |
Configuration for the inspector. |
image_redaction_configs[] |
The configuration for specifying what content to redact from images. |
include_findings |
Whether the response should include findings along with the redacted image. |
byte_item |
The content must be PNG, JPEG, SVG or BMP. |
ImageRedactionConfig
Configuration for determining how redaction of images should occur.
Fields | ||
---|---|---|
redaction_color |
The color to use when redacting content from an image. If not specified, the default is black. |
|
Union field target . Type of information to redact from images. target can be only one of the following: |
||
info_type |
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. |
|
redact_all_text |
If true, all text found in the image, regardless whether it matches an info_type, is redacted. Only one should be provided. |
RedactImageResponse
Results of redacting an image.
Fields | |
---|---|
redacted_image |
The redacted image. The type will be the same as the original image. |
extracted_text |
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. |
inspect_result |
The findings. Populated when include_findings in the request is true. |
ReidentifyContentRequest
Request to re-identify an item.
Fields | |
---|---|
parent |
Required. The parent resource name. Authorization requires the following Google IAM permission on the specified resource
|
reidentify_config |
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:
|
inspect_config |
Configuration for the inspector. |
item |
The item to re-identify. Will be treated as text. |
inspect_template_name |
Optional template to use. Any configuration directly specified in |
reidentify_template_name |
Optional template to use. References an instance of |
location_id |
The geographic location to process content reidentification. Reserved for future extensions. |
ReidentifyContentResponse
Results of re-identifying a item.
Fields | |
---|---|
item |
The re-identified item. |
overview |
An overview of the changes that were made to the |
RelationalOperator
Operators available for comparing the value of fields.
Enums | |
---|---|
RELATIONAL_OPERATOR_UNSPECIFIED |
|
EQUAL_TO |
Equal. Attempts to match even with incompatible types. |
NOT_EQUAL_TO |
Not equal to. Attempts to match even with incompatible types. |
GREATER_THAN |
Greater than. |
LESS_THAN |
Less than. |
GREATER_THAN_OR_EQUALS |
Greater than or equals. |
LESS_THAN_OR_EQUALS |
Less than or equals. |
EXISTS |
Exists |
ReplaceValueConfig
Replace each input value with a given Value
.
Fields | |
---|---|
new_value |
Value to replace it with. |
ReplaceWithInfoTypeConfig
Replace each matching finding with the name of the info_type.
RiskAnalysisJobConfig
Configuration for a risk analysis job. See https://cloud.google.com/dlp/docs/concepts-risk-analysis to learn more.
Fields | |
---|---|
privacy_metric |
Privacy metric to compute. |
source_table |
Input dataset to compute metrics over. |
actions[] |
Actions to execute at the completion of the job. Are executed in the order provided. |
Schedule
Schedule for triggeredJobs.
Fields | |
---|---|
recurrence_period_duration |
With this option a job is started a regular periodic basis. For example: every day (86400 seconds). 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 1 day and can be no longer than 60 days. |
StatisticalTable
An auxiliary table containing 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).
Fields | |
---|---|
table |
Auxiliary table location. [required] |
quasi_ids[] |
Quasi-identifier columns. [required] |
relative_frequency |
The relative frequency column must contain a floating-point number between 0 and 1 (inclusive). Null values are assumed to be zero. [required] |
QuasiIdentifierField
A quasi-identifier column has a custom_tag, used to know which column in the data corresponds to which column in the statistical model.
Fields | |
---|---|
field |
|
custom_tag |
|
StorageConfig
Shared message indicating Cloud storage type.
Fields | ||
---|---|---|
timespan_config |
|
|
Union field
|
||
datastore_options |
Google Cloud Datastore options specification. |
|
cloud_storage_options |
Google Cloud Storage options specification. |
|
big_query_options |
BigQuery options specification. |
TimespanConfig
Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Google Cloud Storage and BigQuery.
Fields | |
---|---|
start_time |
Exclude files or rows older than this value. |
end_time |
Exclude files or rows newer than this value. If set to zero, no upper time limit is applied. |
timestamp_field |
Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. For BigQuery: Required to filter out rows based on the given start and end times. If not specified and the table was modified between the given start and end times, the entire table will be scanned. The valid data types of the timestamp field are: For Datastore. Valid data types of the timestamp field are: |
enable_auto_population_of_timespan_config |
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. |
StoredInfoType
StoredInfoType resource message that contains information about the current version and any pending updates.
Fields | |
---|---|
name |
Resource name. |
current_version |
Current version of the stored info type. |
pending_versions[] |
Pending versions of the stored info type. Empty if no versions are pending. |
StoredInfoTypeConfig
Configuration for a StoredInfoType.
Fields | |
---|---|
display_name |
Display name of the StoredInfoType (max 256 characters). |
description |
Description of the StoredInfoType (max 256 characters). |
large_custom_dictionary |
StoredInfoType where findings are defined by a dictionary of phrases. |
StoredInfoTypeState
State of a StoredInfoType version.
Enums | |
---|---|
STORED_INFO_TYPE_STATE_UNSPECIFIED |
|
PENDING |
StoredInfoType version is being created. |
READY |
StoredInfoType version is ready for use. |
FAILED |
StoredInfoType creation failed. All relevant error messages are returned in the StoredInfoTypeVersion message. |
INVALID |
StoredInfoType is no longer valid because artifacts stored in user-controlled storage were modified. To fix an invalid StoredInfoType, use the UpdateStoredInfoType method to create a new version. |
StoredInfoTypeStats
Statistics for a StoredInfoType.
Fields | |
---|---|
large_custom_dictionary |
StoredInfoType where findings are defined by a dictionary of phrases. |
StoredInfoTypeVersion
Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state.
Fields | |
---|---|
config |
StoredInfoType configuration. |
create_time |
Create timestamp of the version. Read-only, determined by the system when the version is created. |
state |
Stored info type version state. Read-only, updated by the system during dictionary creation. |
errors[] |
Errors that occurred when creating this storedInfoType version, or anomalies detected in the storedInfoType data that render it unusable. Only the five most recent errors will be displayed, with the most recent error appearing first. For example, some of the data for stored custom dictionaries is put in the user's Google Cloud Storage bucket, and if this data is modified or deleted by the user or another system, the dictionary becomes invalid. If any errors occur, fix the problem indicated by the error message and use the UpdateStoredInfoType API method to create another version of the storedInfoType to continue using it, reusing the same |
stats |
Statistics about this storedInfoType version. |
StoredType
A reference to a StoredInfoType to use with scanning.
Fields | |
---|---|
name |
Resource name of the requested |
create_time |
Timestamp indicating when the version of the |
Table
Structured content to inspect. Up to 50,000 Value
s per request allowed. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more.
Fields | |
---|---|
headers[] |
|
rows[] |
|
Row
Fields | |
---|---|
values[] |
|
TableLocation
Location of a finding within a table.
Fields | |
---|---|
row_index |
The zero-based index of the row where the finding is located. |
TimePartConfig
For use with Date
, Timestamp
, and TimeOfDay
, extract or preserve a portion of the value.
Fields | |
---|---|
part_to_extract |
|
TimePart
Enums | |
---|---|
TIME_PART_UNSPECIFIED |
|
YEAR |
[0-9999] |
MONTH |
[1-12] |
DAY_OF_MONTH |
[1-31] |
DAY_OF_WEEK |
[1-7] |
WEEK_OF_YEAR |
[1-53] |
HOUR_OF_DAY |
[0-23] |
TransformationOverview
Overview of the modifications that occurred.
Fields | |
---|---|
transformed_bytes |
Total size in bytes that were transformed in some way. |
transformation_summaries[] |
Transformations applied to the dataset. |
TransformationSummary
Summary of a single transformation. Only one of 'transformation', 'field_transformation', or 'record_suppress' will be set.
Fields | |
---|---|
info_type |
Set if the transformation was limited to a specific InfoType. |
field |
Set if the transformation was limited to a specific FieldId. |
transformation |
The specific transformation these stats apply to. |
field_transformations[] |
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. |
record_suppress |
The specific suppression option these stats apply to. |
results[] |
|
transformed_bytes |
Total size in bytes that were transformed in some way. |
SummaryResult
A collection that informs the user the number of times a particular TransformationResultCode
and error details occurred.
Fields | |
---|---|
count |
|
code |
|
details |
A place for warnings or errors to show up if a transformation didn't work as expected. |
TransformationResultCode
Possible outcomes of transformations.
Enums | |
---|---|
TRANSFORMATION_RESULT_CODE_UNSPECIFIED |
|
SUCCESS |
|
ERROR |
TransientCryptoKey
Use this to have a random data crypto key generated. It will be discarded after the request finishes.
Fields | |
---|---|
name |
Name of the key. [required] This is an arbitrary string used to differentiate different keys. A unique key is generated per name: two separate |
UnwrappedCryptoKey
Using raw keys is prone to security risks due to accidentally leaking the key. Choose another type of key if possible.
Fields | |
---|---|
key |
A 128/192/256 bit key. [required] |
UpdateDeidentifyTemplateRequest
Request message for UpdateDeidentifyTemplate.
Fields | |
---|---|
name |
Required. Resource name of organization and deidentify template to be updated, for example Authorization requires the following Google IAM permission on the specified resource
|
deidentify_template |
New DeidentifyTemplate value. |
update_mask |
Mask to control which fields get updated. |
UpdateInspectTemplateRequest
Request message for UpdateInspectTemplate.
Fields | |
---|---|
name |
Required. Resource name of organization and inspectTemplate to be updated, for example Authorization requires the following Google IAM permission on the specified resource
|
inspect_template |
New InspectTemplate value. |
update_mask |
Mask to control which fields get updated. |
UpdateJobTriggerRequest
Request message for UpdateJobTrigger.
Fields | |
---|---|
name |
Required. Resource name of the project and the triggeredJob, for example Authorization requires one or more of the following Google IAM permissions on the specified resource
|
job_trigger |
New JobTrigger value. |
update_mask |
Mask to control which fields get updated. |
UpdateStoredInfoTypeRequest
Request message for UpdateStoredInfoType.
Fields | |
---|---|
name |
Required. Resource name of organization and storedInfoType to be updated, for example Authorization requires the following Google IAM permission on the specified resource
|
config |
Updated configuration for the storedInfoType. If not provided, a new version of the storedInfoType will be created with the existing configuration. |
update_mask |
Mask to control which fields get updated. |
Value
Set 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.
Fields | ||
---|---|---|
Union field
|
||
integer_value |
|
|
float_value |
|
|
string_value |
|
|
boolean_value |
|
|
timestamp_value |
|
|
time_value |
|
|
date_value |
|
|
day_of_week_value |
|
ValueFrequency
A value of a field, including its frequency.
Fields | |
---|---|
value |
A value contained in the field in question. |
count |
How many times the value is contained in the field. |