googleapis.dlp.v2 library

Classes

DlpApi
Provides methods for detection, risk analysis, and de-identification of privacy-sensitive fragments in text, images, and Google Cloud Platform storage repositories.
GooglePrivacyDlpV2Action
A task to execute on the completion of a job. See https://cloud.google.com/dlp/docs/concepts-actions to learn more.
GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails
Result of a risk analysis operation request.
GooglePrivacyDlpV2AuxiliaryTable
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).
GooglePrivacyDlpV2BigQueryField
Message defining a field of a BigQuery table.
GooglePrivacyDlpV2BigQueryKey
Row key for identifying a record in BigQuery table.
GooglePrivacyDlpV2BigQueryOptions
Options defining BigQuery table and row identifiers.
GooglePrivacyDlpV2BigQueryTable
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>.
GooglePrivacyDlpV2BoundingBox
Bounding box encompassing detected text within an image.
GooglePrivacyDlpV2Bucket
Bucket is represented as a range, along with replacement values.
GooglePrivacyDlpV2BucketingConfig
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.
GooglePrivacyDlpV2ByteContentItem
Container for bytes to inspect or redact.
GooglePrivacyDlpV2CancelDlpJobRequest
The request message for canceling a DLP job.
GooglePrivacyDlpV2CategoricalStatsConfig
Compute numerical stats over an individual column, including number of distinct values and value count distribution.
GooglePrivacyDlpV2CategoricalStatsHistogramBucket
GooglePrivacyDlpV2CategoricalStatsResult
Result of the categorical stats computation.
GooglePrivacyDlpV2CharacterMaskConfig
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.
GooglePrivacyDlpV2CharsToIgnore
Characters to skip when doing deidentification of a value. These will be left alone and skipped.
GooglePrivacyDlpV2CloudStorageFileSet
Message representing a set of files in Cloud Storage.
GooglePrivacyDlpV2CloudStorageOptions
Options defining a file or a set of files within a Google Cloud Storage bucket.
GooglePrivacyDlpV2CloudStoragePath
Message representing a single file or path in Cloud Storage.
GooglePrivacyDlpV2CloudStorageRegexFileSet
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. [...]
GooglePrivacyDlpV2Color
Represents a color in the RGB color space.
GooglePrivacyDlpV2Condition
The field type of value and field do not need to match to be considered equal, but not all comparisons are possible. [...]
GooglePrivacyDlpV2Conditions
A collection of conditions.
GooglePrivacyDlpV2ContentItem
Container structure for the content to inspect.
GooglePrivacyDlpV2ContentLocation
Findings container location data.
GooglePrivacyDlpV2CreateDeidentifyTemplateRequest
Request message for CreateDeidentifyTemplate.
GooglePrivacyDlpV2CreateDlpJobRequest
Request message for CreateDlpJobRequest. Used to initiate long running jobs such as calculating risk metrics or inspecting Google Cloud Storage.
GooglePrivacyDlpV2CreateInspectTemplateRequest
Request message for CreateInspectTemplate.
GooglePrivacyDlpV2CreateJobTriggerRequest
Request message for CreateJobTrigger.
GooglePrivacyDlpV2CreateStoredInfoTypeRequest
Request message for CreateStoredInfoType.
GooglePrivacyDlpV2CryptoHashConfig
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.
GooglePrivacyDlpV2CryptoKey
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.
GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig
Replaces an identifier with a surrogate using FPE with the FFX mode of operation; however when used in the ReidentifyContent API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/dlp/docs/pseudonymization to learn more.
GooglePrivacyDlpV2CustomInfoType
Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question.
GooglePrivacyDlpV2DatastoreKey
Record key for a finding in Cloud Datastore.
GooglePrivacyDlpV2DatastoreOptions
Options defining a data set within Google Cloud Datastore.
GooglePrivacyDlpV2DateShiftConfig
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.
GooglePrivacyDlpV2DateTime
Message for a date time object. e.g. 2018-01-01, 5th August.
GooglePrivacyDlpV2DeidentifyConfig
The configuration that controls how the data will change.
GooglePrivacyDlpV2DeidentifyContentRequest
Request to de-identify a list of items.
GooglePrivacyDlpV2DeidentifyContentResponse
Results of de-identifying a ContentItem.
GooglePrivacyDlpV2DeidentifyTemplate
The DeidentifyTemplates contains instructions on how to deidentify content. See https://cloud.google.com/dlp/docs/concepts-templates to learn more.
GooglePrivacyDlpV2DeltaPresenceEstimationConfig
δ-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.
GooglePrivacyDlpV2DeltaPresenceEstimationHistogramBucket
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.
GooglePrivacyDlpV2DeltaPresenceEstimationQuasiIdValues
A tuple of values for the quasi-identifier columns.
GooglePrivacyDlpV2DeltaPresenceEstimationResult
Result of the δ-presence computation. Note that these results are an estimation, not exact values.
GooglePrivacyDlpV2DetectionRule
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 info type.
GooglePrivacyDlpV2Dictionary
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. [...]
GooglePrivacyDlpV2DlpJob
Combines all of the information about a DLP job.
GooglePrivacyDlpV2DocumentLocation
Location of a finding within a document.
GooglePrivacyDlpV2EntityId
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.
GooglePrivacyDlpV2Error
Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger. Output only field.
GooglePrivacyDlpV2ExcludeInfoTypes
List of exclude infoTypes.
GooglePrivacyDlpV2ExclusionRule
The rule that specifies conditions when findings of infoTypes specified in InspectionRuleSet are removed from results.
GooglePrivacyDlpV2Expressions
An expression, consisting or an operator and conditions.
GooglePrivacyDlpV2FieldId
General identifier of a data field in a storage service.
GooglePrivacyDlpV2FieldTransformation
The transformation to apply to the field.
GooglePrivacyDlpV2FileSet
Set of files to scan.
GooglePrivacyDlpV2Finding
Represents a piece of potentially sensitive content.
GooglePrivacyDlpV2FindingLimits
GooglePrivacyDlpV2FixedSizeBucketingConfig
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. [...]
GooglePrivacyDlpV2HotwordRule
The rule that adjusts the likelihood of findings within a certain proximity of hotwords.
GooglePrivacyDlpV2ImageLocation
Location of the finding within an image.
GooglePrivacyDlpV2ImageRedactionConfig
Configuration for determining how redaction of images should occur.
GooglePrivacyDlpV2InfoType
Type of information detected by the API.
GooglePrivacyDlpV2InfoTypeDescription
InfoType description.
GooglePrivacyDlpV2InfoTypeLimit
Max findings configuration per infoType, per content item or long running DlpJob.
GooglePrivacyDlpV2InfoTypeStats
Statistics regarding a specific InfoType.
GooglePrivacyDlpV2InfoTypeTransformation
A transformation to apply to text that is identified as a specific info_type.
GooglePrivacyDlpV2InfoTypeTransformations
A type of transformation that will scan unstructured text and apply various PrimitiveTransformations to each finding, where the transformation is applied to only values that were identified as a specific info_type.
GooglePrivacyDlpV2InspectConfig
Configuration description of the scanning process. When used with redactContent only info_types and min_likelihood are currently used.
GooglePrivacyDlpV2InspectContentRequest
Request to search for potentially sensitive info in a ContentItem.
GooglePrivacyDlpV2InspectContentResponse
Results of inspecting an item.
GooglePrivacyDlpV2InspectDataSourceDetails
The results of an inspect DataSource job.
GooglePrivacyDlpV2InspectionRule
A single inspection rule to be applied to infoTypes, specified in InspectionRuleSet.
GooglePrivacyDlpV2InspectionRuleSet
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.
GooglePrivacyDlpV2InspectJobConfig
GooglePrivacyDlpV2InspectResult
All the findings for a single scanned item.
GooglePrivacyDlpV2InspectTemplate
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.
GooglePrivacyDlpV2JobTrigger
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.
GooglePrivacyDlpV2KAnonymityConfig
k-anonymity metric, used for analysis of reidentification risk.
GooglePrivacyDlpV2KAnonymityEquivalenceClass
The set of columns' values that share the same ldiversity value
GooglePrivacyDlpV2KAnonymityHistogramBucket
GooglePrivacyDlpV2KAnonymityResult
Result of the k-anonymity computation.
GooglePrivacyDlpV2Key
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.
GooglePrivacyDlpV2KindExpression
A representation of a Datastore kind.
GooglePrivacyDlpV2KMapEstimationConfig
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.
GooglePrivacyDlpV2KMapEstimationHistogramBucket
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.
GooglePrivacyDlpV2KMapEstimationQuasiIdValues
A tuple of values for the quasi-identifier columns.
GooglePrivacyDlpV2KMapEstimationResult
Result of the reidentifiability analysis. Note that these results are an estimation, not exact values.
GooglePrivacyDlpV2KmsWrappedCryptoKey
Include to use an existing data crypto key wrapped by KMS. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a kms-wrapped crypto key: dlp.kms.encrypt
GooglePrivacyDlpV2LargeCustomDictionaryConfig
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.
GooglePrivacyDlpV2LDiversityConfig
l-diversity metric, used for analysis of reidentification risk.
GooglePrivacyDlpV2LDiversityEquivalenceClass
The set of columns' values that share the same ldiversity value.
GooglePrivacyDlpV2LDiversityHistogramBucket
GooglePrivacyDlpV2LDiversityResult
Result of the l-diversity computation.
GooglePrivacyDlpV2LikelihoodAdjustment
Message for specifying an adjustment to the likelihood of a finding as part of a detection rule.
GooglePrivacyDlpV2ListDeidentifyTemplatesResponse
Response message for ListDeidentifyTemplates.
GooglePrivacyDlpV2ListDlpJobsResponse
The response message for listing DLP jobs.
GooglePrivacyDlpV2ListInfoTypesResponse
Response to the ListInfoTypes request.
GooglePrivacyDlpV2ListInspectTemplatesResponse
Response message for ListInspectTemplates.
GooglePrivacyDlpV2ListJobTriggersResponse
Response message for ListJobTriggers.
GooglePrivacyDlpV2ListStoredInfoTypesResponse
Response message for ListStoredInfoTypes.
GooglePrivacyDlpV2Location
Specifies the location of the finding.
GooglePrivacyDlpV2NumericalStatsConfig
Compute numerical stats over an individual column, including min, max, and quantiles.
GooglePrivacyDlpV2NumericalStatsResult
Result of the numerical stats computation.
GooglePrivacyDlpV2OutputStorageConfig
Cloud repository for storing output.
GooglePrivacyDlpV2PartitionId
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. [...]
GooglePrivacyDlpV2PathElement
A (kind, ID/name) pair used to construct a key path. [...]
GooglePrivacyDlpV2PrimitiveTransformation
A rule for transforming a value.
GooglePrivacyDlpV2PrivacyMetric
Privacy metric to compute for reidentification risk analysis.
GooglePrivacyDlpV2Proximity
Message for specifying a window around a finding to apply a detection rule.
GooglePrivacyDlpV2PublishSummaryToCscc
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
GooglePrivacyDlpV2PublishToPubSub
Publish the results of a DlpJob to a pub sub channel. Compatible with: Inspect, Risk
GooglePrivacyDlpV2QuasiId
A column with a semantic tag attached.
GooglePrivacyDlpV2QuasiIdentifierField
A quasi-identifier column has a custom_tag, used to know which column in the data corresponds to which column in the statistical model.
GooglePrivacyDlpV2QuasiIdField
A quasi-identifier column has a custom_tag, used to know which column in the data corresponds to which column in the statistical model.
GooglePrivacyDlpV2QuoteInfo
Message for infoType-dependent details parsed from quote.
GooglePrivacyDlpV2Range
Generic half-open interval [start, end)
GooglePrivacyDlpV2RecordCondition
A condition for determining whether a transformation should be applied to a field.
GooglePrivacyDlpV2RecordKey
Message for a unique key indicating a record that contains a finding.
GooglePrivacyDlpV2RecordLocation
Location of a finding within a row or record.
GooglePrivacyDlpV2RecordSuppression
Configuration to suppress records whose suppression conditions evaluate to true.
GooglePrivacyDlpV2RecordTransformations
A type of transformation that is applied over structured data such as a table.
GooglePrivacyDlpV2RedactConfig
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 '.
GooglePrivacyDlpV2RedactImageRequest
Request to search for potentially sensitive info in an image and redact it by covering it with a colored rectangle.
GooglePrivacyDlpV2RedactImageResponse
Results of redacting an image.
GooglePrivacyDlpV2Regex
Message defining a custom regular expression.
GooglePrivacyDlpV2ReidentifyContentRequest
Request to re-identify an item.
GooglePrivacyDlpV2ReidentifyContentResponse
Results of re-identifying a item.
GooglePrivacyDlpV2ReplaceValueConfig
Replace each input value with a given Value.
GooglePrivacyDlpV2ReplaceWithInfoTypeConfig
Replace each matching finding with the name of the info_type.
GooglePrivacyDlpV2RequestedOptions
GooglePrivacyDlpV2Result
GooglePrivacyDlpV2RiskAnalysisJobConfig
Configuration for a risk analysis job. See https://cloud.google.com/dlp/docs/concepts-risk-analysis to learn more.
GooglePrivacyDlpV2Row
GooglePrivacyDlpV2SaveFindings
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
GooglePrivacyDlpV2Schedule
Schedule for triggeredJobs.
GooglePrivacyDlpV2StatisticalTable
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).
GooglePrivacyDlpV2StorageConfig
Shared message indicating Cloud storage type.
GooglePrivacyDlpV2StoredInfoType
StoredInfoType resource message that contains information about the current version and any pending updates.
GooglePrivacyDlpV2StoredInfoTypeConfig
Configuration for a StoredInfoType.
GooglePrivacyDlpV2StoredInfoTypeVersion
Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state.
GooglePrivacyDlpV2StoredType
A reference to a StoredInfoType to use with scanning.
GooglePrivacyDlpV2SummaryResult
A collection that informs the user the number of times a particular TransformationResultCode and error details occurred.
GooglePrivacyDlpV2SurrogateType
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.
GooglePrivacyDlpV2Table
Structured content to inspect. Up to 50,000 Values per request allowed. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more.
GooglePrivacyDlpV2TableLocation
Location of a finding within a table.
GooglePrivacyDlpV2TaggedField
GooglePrivacyDlpV2TimePartConfig
For use with Date, Timestamp, and TimeOfDay, extract or preserve a portion of the value.
GooglePrivacyDlpV2TimespanConfig
Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Google Cloud Storage and BigQuery.
GooglePrivacyDlpV2TimeZone
GooglePrivacyDlpV2TransformationOverview
Overview of the modifications that occurred.
GooglePrivacyDlpV2TransformationSummary
Summary of a single tranformation. Only one of 'transformation', 'field_transformation', or 'record_suppress' will be set.
GooglePrivacyDlpV2TransientCryptoKey
Use this to have a random data crypto key generated. It will be discarded after the request finishes.
GooglePrivacyDlpV2Trigger
What event needs to occur for a new job to be started.
GooglePrivacyDlpV2UnwrappedCryptoKey
Using raw keys is prone to security risks due to accidentally leaking the key. Choose another type of key if possible.
GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest
Request message for UpdateDeidentifyTemplate.
GooglePrivacyDlpV2UpdateInspectTemplateRequest
Request message for UpdateInspectTemplate.
GooglePrivacyDlpV2UpdateJobTriggerRequest
Request message for UpdateJobTrigger.
GooglePrivacyDlpV2UpdateStoredInfoTypeRequest
Request message for UpdateStoredInfoType.
GooglePrivacyDlpV2Value
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.
GooglePrivacyDlpV2ValueFrequency
A value of a field, including its frequency.
GooglePrivacyDlpV2WordList
Message defining a list of words or phrases to search for in the data.
GoogleProtobufEmpty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: [...]
GoogleRpcStatus
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. The error model is designed to be: [...]
GoogleTypeDate
Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: [...]
GoogleTypeTimeOfDay
Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp.
InfoTypesResourceApi
OrganizationsDeidentifyTemplatesResourceApi
OrganizationsInspectTemplatesResourceApi
OrganizationsResourceApi
OrganizationsStoredInfoTypesResourceApi
ProjectsContentResourceApi
ProjectsDeidentifyTemplatesResourceApi
ProjectsDlpJobsResourceApi
ProjectsImageResourceApi
ProjectsInspectTemplatesResourceApi
ProjectsJobTriggersResourceApi
ProjectsResourceApi
ProjectsStoredInfoTypesResourceApi

Constants

USER_AGENT → const String
'dart-api-client dlp/v2'

Exceptions / Errors

ApiRequestError
Represents a general error reported by the API endpoint.
DetailedApiRequestError
Represents a specific error reported by the API endpoint.