Namespace Google.Cloud.Dlp.V2 (4.1.0)

Classes

Action

A task to execute on the completion of a job. See https://cloud.google.com/dlp/docs/concepts-actions to learn more.

Action.Types

Container for nested types declared in the Action message type.

Action.Types.JobNotificationEmails

Enable email notification to project owners and editors on jobs's completion/failure.

Action.Types.PublishFindingsToCloudDataCatalog

Publish findings of a DlpJob to Data Catalog. Labels summarizing the results of the DlpJob will be applied to the entry for the resource scanned in 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 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

Action.Types.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

Action.Types.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

Action.Types.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'.

Action.Types.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

ActivateJobTriggerRequest

Request message for ActivateJobTrigger.

AnalyzeDataSourceRiskDetails

Result of a risk analysis operation request.

AnalyzeDataSourceRiskDetails.Types

Container for nested types declared in the AnalyzeDataSourceRiskDetails message type.

AnalyzeDataSourceRiskDetails.Types.CategoricalStatsResult

Result of the categorical stats computation.

AnalyzeDataSourceRiskDetails.Types.CategoricalStatsResult.Types

Container for nested types declared in the CategoricalStatsResult message type.

AnalyzeDataSourceRiskDetails.Types.CategoricalStatsResult.Types.CategoricalStatsHistogramBucket

Histogram of value frequencies in the column.

AnalyzeDataSourceRiskDetails.Types.DeltaPresenceEstimationResult

Result of the δ-presence computation. Note that these results are an estimation, not exact values.

AnalyzeDataSourceRiskDetails.Types.DeltaPresenceEstimationResult.Types

Container for nested types declared in the DeltaPresenceEstimationResult message type.

AnalyzeDataSourceRiskDetails.Types.DeltaPresenceEstimationResult.Types.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.

AnalyzeDataSourceRiskDetails.Types.DeltaPresenceEstimationResult.Types.DeltaPresenceEstimationQuasiIdValues

A tuple of values for the quasi-identifier columns.

AnalyzeDataSourceRiskDetails.Types.KAnonymityResult

Result of the k-anonymity computation.

AnalyzeDataSourceRiskDetails.Types.KAnonymityResult.Types

Container for nested types declared in the KAnonymityResult message type.

AnalyzeDataSourceRiskDetails.Types.KAnonymityResult.Types.KAnonymityEquivalenceClass

The set of columns' values that share the same ldiversity value

AnalyzeDataSourceRiskDetails.Types.KAnonymityResult.Types.KAnonymityHistogramBucket

Histogram of k-anonymity equivalence classes.

AnalyzeDataSourceRiskDetails.Types.KMapEstimationResult

Result of the reidentifiability analysis. Note that these results are an estimation, not exact values.

AnalyzeDataSourceRiskDetails.Types.KMapEstimationResult.Types

Container for nested types declared in the KMapEstimationResult message type.

AnalyzeDataSourceRiskDetails.Types.KMapEstimationResult.Types.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.

AnalyzeDataSourceRiskDetails.Types.KMapEstimationResult.Types.KMapEstimationQuasiIdValues

A tuple of values for the quasi-identifier columns.

AnalyzeDataSourceRiskDetails.Types.LDiversityResult

Result of the l-diversity computation.

AnalyzeDataSourceRiskDetails.Types.LDiversityResult.Types

Container for nested types declared in the LDiversityResult message type.

AnalyzeDataSourceRiskDetails.Types.LDiversityResult.Types.LDiversityEquivalenceClass

The set of columns' values that share the same ldiversity value.

AnalyzeDataSourceRiskDetails.Types.LDiversityResult.Types.LDiversityHistogramBucket

Histogram of l-diversity equivalence class sensitive value frequencies.

AnalyzeDataSourceRiskDetails.Types.NumericalStatsResult

Result of the numerical stats computation.

AnalyzeDataSourceRiskDetails.Types.RequestedRiskAnalysisOptions

Risk analysis options.

BigQueryField

Message defining a field of a BigQuery table.

BigQueryKey

Row key for identifying a record in BigQuery table.

BigQueryOptions

Options defining BigQuery table and row identifiers.

BigQueryOptions.Types

Container for nested types declared in the BigQueryOptions message type.

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>.

BoundingBox

Bounding box encompassing detected text within an image.

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.

BucketingConfig.Types

Container for nested types declared in the BucketingConfig message type.

BucketingConfig.Types.Bucket

Bucket is represented as a range, along with replacement values.

ByteContentItem

Container for bytes to inspect or redact.

ByteContentItem.Types

Container for nested types declared in the ByteContentItem message type.

CancelDlpJobRequest

The request message for canceling a DLP job.

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.

CharsToIgnore

Characters to skip when doing deidentification of a value. These will be left alone and skipped.

CharsToIgnore.Types

Container for nested types declared in the CharsToIgnore message type.

CloudStorageFileSet

Message representing a set of files in Cloud Storage.

CloudStorageOptions

Options defining a file or a set of files within a Google Cloud Storage bucket.

CloudStorageOptions.Types

Container for nested types declared in the CloudStorageOptions message type.

CloudStorageOptions.Types.FileSet

Set of files to scan.

CloudStoragePath

Message representing a single file or path in Cloud Storage.

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 included
gs://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 in include_regex)
gs://mybucket/directory1/excludedfile will not be included (the path matches an item in exclude_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 in mybucket except for .pdf files
{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]} will include all files directly under gs://mybucket/directory/, without matching across /

Color

Represents a color in the RGB color space.

Container

Represents a container that may contain DLP findings. Examples of a container include a file, table, or database record.

ContentItem

Container structure for the content to inspect.

ContentLocation

Precise location of the finding within a document, record, image, or metadata container.

CreateDeidentifyTemplateRequest

Request message for CreateDeidentifyTemplate.

CreateDlpJobRequest

Request message for CreateDlpJobRequest. Used to initiate long running jobs such as calculating risk metrics or inspecting Google Cloud Storage.

CreateInspectTemplateRequest

Request message for CreateInspectTemplate.

CreateJobTriggerRequest

Request message for CreateJobTrigger.

CreateStoredInfoTypeRequest

Request message for CreateStoredInfoType.

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.

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.

CryptoKey

This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK.

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.

CryptoReplaceFfxFpeConfig.Types

Container for nested types declared in the CryptoReplaceFfxFpeConfig message type.

CustomInfoType

Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question.

CustomInfoType.Types

Container for nested types declared in the CustomInfoType message type.

CustomInfoType.Types.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.

CustomInfoType.Types.DetectionRule.Types

Container for nested types declared in the DetectionRule message type.

CustomInfoType.Types.DetectionRule.Types.HotwordRule

The rule that adjusts the likelihood of findings within a certain proximity of hotwords.

CustomInfoType.Types.DetectionRule.Types.LikelihoodAdjustment

Message for specifying an adjustment to the likelihood of a finding as part of a detection rule.

CustomInfoType.Types.DetectionRule.Types.Proximity

Message for specifying a window around a finding to apply a detection rule.

CustomInfoType.Types.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.

CustomInfoType.Types.Dictionary.Types

Container for nested types declared in the Dictionary message type.

CustomInfoType.Types.Dictionary.Types.WordList

Message defining a list of words or phrases to search for in the data.

CustomInfoType.Types.Regex

Message defining a custom regular expression.

CustomInfoType.Types.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.

DataProfileAction

A task to execute when a data profile has been generated.

DataProfileAction.Types

Container for nested types declared in the DataProfileAction message type.

DataProfileAction.Types.Export

If set, the detailed data profiles will be persisted to the location of your choice whenever updated.

DataProfileAction.Types.PubSubNotification

Send a Pub/Sub message into the given Pub/Sub topic to connect other systems to data profile generation. The message payload data will be the byte serialization of DataProfilePubSubMessage.

DataProfileAction.Types.PubSubNotification.Types

Container for nested types declared in the PubSubNotification message type.

DataProfileConfigSnapshot

Snapshot of the configurations used to generate the profile.

DataProfileJobConfig

Configuration for setting up a job to scan resources for profile generation. Only one data profile configuration may exist per organization, folder, or project.

The generated data profiles are retained according to the data retention policy.

DataProfileLocation

The data that will be profiled.

DataProfilePubSubCondition

A condition for determining whether a PubSub should be triggered.

DataProfilePubSubCondition.Types

Container for nested types declared in the DataProfilePubSubCondition message type.

DataProfilePubSubCondition.Types.PubSubCondition

A condition consisting of a value.

DataProfilePubSubCondition.Types.PubSubExpressions

An expression, consisting of an operator and conditions.

DataProfilePubSubCondition.Types.PubSubExpressions.Types

Container for nested types declared in the PubSubExpressions message type.

DataProfilePubSubMessage

The message that will be published to a Pub/Sub topic. To receive a message of protocol buffer schema type, convert the message data to an object of this proto class. https://cloud.google.com/pubsub/docs/samples/pubsub-subscribe-proto-messages

DataRiskLevel

Score is a summary of all elements in the data profile. A higher number means more risky.

DataRiskLevel.Types

Container for nested types declared in the DataRiskLevel message type.

DatastoreKey

Record key for a finding in Cloud Datastore.

DatastoreOptions

Options defining a data set within Google Cloud Datastore.

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.

DateTime

Message for a date time object. e.g. 2018-01-01, 5th August.

DateTime.Types

Container for nested types declared in the DateTime message type.

DateTime.Types.TimeZone

Time zone of the date time object.

DeidentifyConfig

The configuration that controls how the data will change.

DeidentifyContentRequest

Request to de-identify a list of items.

DeidentifyContentResponse

Results of de-identifying a ContentItem.

DeidentifyTemplate

DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/dlp/docs/concepts-templates to learn more.

DeidentifyTemplateName

Resource name for the DeidentifyTemplate resource.

DeleteDeidentifyTemplateRequest

Request message for DeleteDeidentifyTemplate.

DeleteDlpJobRequest

The request message for deleting a DLP job.

DeleteInspectTemplateRequest

Request message for DeleteInspectTemplate.

DeleteJobTriggerRequest

Request message for DeleteJobTrigger.

DeleteStoredInfoTypeRequest

Request message for DeleteStoredInfoType.

DlpContentName

Resource name for the DlpContent resource.

DlpJob

Combines all of the information about a DLP job.

DlpJob.Types

Container for nested types declared in the DlpJob message type.

DlpJobName

Resource name for the DlpJob resource.

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/.

DlpService.DlpServiceBase

Base class for server-side implementations of DlpService

DlpService.DlpServiceClient

Client for DlpService

DlpServiceClient

DlpService client wrapper, for convenient use.

DlpServiceClientBuilder

Builder class for DlpServiceClient to provide simple configuration of credentials, endpoint etc.

DlpServiceClientImpl

DlpService client wrapper implementation, for convenient use.

DlpServiceSettings

Settings for DlpServiceClient instances.

DocumentLocation

Location of a finding within a document.

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.

Error

Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger.

ExcludeInfoTypes

List of exclude infoTypes.

ExclusionRule

The rule that specifies conditions when findings of infoTypes specified in InspectionRuleSet are removed from results.

FieldId

General identifier of a data field in a storage service.

FieldTransformation

The transformation to apply to the field.

Finding

Represents a piece of potentially sensitive content.

FindingName

Resource name for the Finding resource.

FinishDlpJobRequest

The request message for finishing a DLP hybrid job.

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 {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20".

This can be used on data of type: double, long.

If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing.

See https://cloud.google.com/dlp/docs/concepts-bucketing to learn more.

GetDeidentifyTemplateRequest

Request message for GetDeidentifyTemplate.

GetDlpJobRequest

The request message for [DlpJobs.GetDlpJob][].

GetInspectTemplateRequest

Request message for GetInspectTemplate.

GetJobTriggerRequest

Request message for GetJobTrigger.

GetStoredInfoTypeRequest

Request message for GetStoredInfoType.

HybridContentItem

An individual hybrid item to inspect. Will be stored temporarily during processing.

HybridFindingDetails

Populate to associate additional data with each finding.

HybridInspectDlpJobRequest

Request to search for potentially sensitive info in a custom location.

HybridInspectJobTriggerRequest

Request to search for potentially sensitive info in a custom location.

HybridInspectResponse

Quota exceeded errors will be thrown once quota has been met.

HybridInspectStatistics

Statistics related to processing hybrid inspect requests.

HybridOptions

Configuration to control jobs where the content being inspected is outside of Google Cloud Platform.

ImageLocation

Location of the finding within an image.

InfoType

Type of information detected by the API.

InfoTypeCategory

Classification of infoTypes to organize them according to geographic location, industry, and data type.

InfoTypeCategory.Types

Container for nested types declared in the InfoTypeCategory message type.

InfoTypeDescription

InfoType description.

InfoTypeStats

Statistics regarding a specific InfoType.

InfoTypeSummary

The infoType details for this column.

InfoTypeTransformations

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.

InfoTypeTransformations.Types

Container for nested types declared in the InfoTypeTransformations message type.

InfoTypeTransformations.Types.InfoTypeTransformation

A transformation to apply to text that is identified as a specific info_type.

InspectConfig

Configuration description of the scanning process. When used with redactContent only info_types and min_likelihood are currently used.

InspectConfig.Types

Container for nested types declared in the InspectConfig message type.

InspectConfig.Types.FindingLimits

Configuration to control the number of findings returned for inspection. This is not used for de-identification or data profiling.

InspectConfig.Types.FindingLimits.Types

Container for nested types declared in the FindingLimits message type.

InspectConfig.Types.FindingLimits.Types.InfoTypeLimit

Max findings configuration per infoType, per content item or long running DlpJob.

InspectContentRequest

Request to search for potentially sensitive info in a ContentItem.

InspectContentResponse

Results of inspecting an item.

InspectDataSourceDetails

The results of an inspect DataSource job.

InspectDataSourceDetails.Types

Container for nested types declared in the InspectDataSourceDetails message type.

InspectDataSourceDetails.Types.RequestedOptions

Snapshot of the inspection configuration.

InspectDataSourceDetails.Types.Result

All result fields mentioned below are updated while the job is processing.

InspectionRule

A single inspection rule to be applied to infoTypes, specified in InspectionRuleSet.

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.

InspectJobConfig

Controls what and how to inspect for findings.

InspectResult

All the findings for a single scanned item.

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.

InspectTemplateName

Resource name for the InspectTemplate resource.

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.

JobTrigger.Types

Container for nested types declared in the JobTrigger message type.

JobTrigger.Types.Trigger

What event needs to occur for a new job to be started.

JobTriggerName

Resource name for the JobTrigger resource.

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.

Key.Types

Container for nested types declared in the Key message type.

Key.Types.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.

KindExpression

A representation of a Datastore kind.

KmsWrappedCryptoKey

Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 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

For more information, see Creating a wrapped key.

Note: When you use Cloud KMS for cryptographic operations, charges apply.

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.

LargeCustomDictionaryStats

Summary statistics of a custom dictionary.

ListDeidentifyTemplatesRequest

Request message for ListDeidentifyTemplates.

ListDeidentifyTemplatesResponse

Response message for ListDeidentifyTemplates.

ListDlpJobsRequest

The request message for listing DLP jobs.

ListDlpJobsResponse

The response message for listing DLP jobs.

ListInfoTypesRequest

Request for the list of infoTypes.

ListInfoTypesResponse

Response to the ListInfoTypes request.

ListInspectTemplatesRequest

Request message for ListInspectTemplates.

ListInspectTemplatesResponse

Response message for ListInspectTemplates.

ListJobTriggersRequest

Request message for ListJobTriggers.

ListJobTriggersResponse

Response message for ListJobTriggers.

ListStoredInfoTypesRequest

Request message for ListStoredInfoTypes.

ListStoredInfoTypesResponse

Response message for ListStoredInfoTypes.

Location

Specifies the location of the finding.

Manual

Job trigger option for hybrid jobs. Jobs must be manually created and finished.

MetadataLocation

Metadata Location

OrganizationLocationName

Resource name for the OrganizationLocation resource.

OtherInfoTypeSummary

Infotype details for other infoTypes found within a column.

OutputStorageConfig

Cloud repository for storing output.

OutputStorageConfig.Types

Container for nested types declared in the OutputStorageConfig message type.

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.

PrimitiveTransformation

A rule for transforming a value.

PrivacyMetric

Privacy metric to compute for reidentification risk analysis.

PrivacyMetric.Types

Container for nested types declared in the PrivacyMetric message type.

PrivacyMetric.Types.CategoricalStatsConfig

Compute numerical stats over an individual column, including number of distinct values and value count distribution.

PrivacyMetric.Types.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.

PrivacyMetric.Types.KAnonymityConfig

k-anonymity metric, used for analysis of reidentification risk.

PrivacyMetric.Types.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.

PrivacyMetric.Types.KMapEstimationConfig.Types

Container for nested types declared in the KMapEstimationConfig message type.

PrivacyMetric.Types.KMapEstimationConfig.Types.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).

PrivacyMetric.Types.KMapEstimationConfig.Types.AuxiliaryTable.Types

Container for nested types declared in the AuxiliaryTable message type.

PrivacyMetric.Types.KMapEstimationConfig.Types.AuxiliaryTable.Types.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.

PrivacyMetric.Types.KMapEstimationConfig.Types.TaggedField

A column with a semantic tag attached.

PrivacyMetric.Types.LDiversityConfig

l-diversity metric, used for analysis of reidentification risk.

PrivacyMetric.Types.NumericalStatsConfig

Compute numerical stats over an individual column, including min, max, and quantiles.

ProfileStatus

QuasiId

A column with a semantic tag attached.

QuoteInfo

Message for infoType-dependent details parsed from quote.

Range

Generic half-open interval [start, end)

RecordCondition

A condition for determining whether a transformation should be applied to a field.

RecordCondition.Types

Container for nested types declared in the RecordCondition message type.

RecordCondition.Types.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 types
boolean can only be compared against other booleans
integer can be compared against doubles or a string if the string value can be parsed as an integer.
double can be compared against integers or a string if the string can be parsed as a double.
Timestamp can be compared against strings in RFC 3339 date string format.
TimeOfDay can be compared against timestamps and strings in the format of 'HH:mm:ss'.

If we fail to compare do to type mismatch, a warning will be given and the condition will evaluate to false.

RecordCondition.Types.Conditions

A collection of conditions.

RecordCondition.Types.Expressions

An expression, consisting or an operator and conditions.

RecordCondition.Types.Expressions.Types

Container for nested types declared in the Expressions message type.

RecordKey

Message for a unique key indicating a record that contains a finding.

RecordLocation

Location of a finding within a row or record.

RecordSuppression

Configuration to suppress records whose suppression conditions evaluate to true.

RecordTransformations

A type of transformation that is applied over structured data such as a table.

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.

RedactImageRequest.Types

Container for nested types declared in the RedactImageRequest message type.

RedactImageRequest.Types.ImageRedactionConfig

Configuration for determining how redaction of images should occur.

RedactImageResponse

Results of redacting an image.

ReidentifyContentRequest

Request to re-identify an item.

ReidentifyContentResponse

Results of re-identifying a item.

ReplaceDictionaryConfig

Replace each input value with a value randomly selected from the dictionary.

ReplaceValueConfig

Replace each input value with a given Value.

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.

Schedule

Schedule for inspect job triggers.

SensitivityScore

Score is a summary of all elements in the data profile. A higher number means more sensitive.

SensitivityScore.Types

Container for nested types declared in the SensitivityScore message type.

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).

StatisticalTable.Types

Container for nested types declared in the StatisticalTable message type.

StatisticalTable.Types.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.

StorageConfig

Shared message indicating Cloud storage type.

StorageConfig.Types

Container for nested types declared in the StorageConfig message type.

StorageConfig.Types.TimespanConfig

Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Google Cloud Storage and BigQuery.

StorageMetadataLabel

Storage metadata label to indicate which metadata entry contains findings.

StoredInfoType

StoredInfoType resource message that contains information about the current version and any pending updates.

StoredInfoTypeConfig

Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/dlp/docs/creating-custom-infotypes.

StoredInfoTypeName

Resource name for the StoredInfoType resource.

StoredInfoTypeStats

Statistics for a StoredInfoType.

StoredInfoTypeVersion

Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state.

StoredType

A reference to a StoredInfoType to use with scanning.

Table

Structured content to inspect. Up to 50,000 Values per request allowed. See https://cloud.google.com/dlp/docs/inspecting-structured-text#inspecting_a_table to learn more.

Table.Types

Container for nested types declared in the Table message type.

Table.Types.Row

Values of the row.

TableDataProfile

The profile for a scanned table.

TableDataProfile.Types

Container for nested types declared in the TableDataProfile message type.

TableLocation

Location of a finding within a table.

TableOptions

Instructions regarding the table content being inspected.

TimePartConfig

For use with Date, Timestamp, and TimeOfDay, extract or preserve a portion of the value.

TimePartConfig.Types

Container for nested types declared in the TimePartConfig message type.

TransformationErrorHandling

How to handle transformation errors during de-identification. A transformation error occurs when the requested transformation is incompatible with the data. For example, trying to de-identify an IP address using a DateShift transformation would result in a transformation error, since date info cannot be extracted from an IP address. Information about any incompatible transformations, and how they were handled, is returned in the response as part of the TransformationOverviews.

TransformationErrorHandling.Types

Container for nested types declared in the TransformationErrorHandling message type.

TransformationErrorHandling.Types.LeaveUntransformed

Skips the data without modifying it if the requested transformation would cause an error. For example, if a DateShift transformation were applied an an IP address, this mode would leave the IP address unchanged in the response.

TransformationErrorHandling.Types.ThrowError

Throw an error and fail the request when a transformation error occurs.

TransformationOverview

Overview of the modifications that occurred.

TransformationSummary

Summary of a single transformation. Only one of 'transformation', 'field_transformation', or 'record_suppress' will be set.

TransformationSummary.Types

Container for nested types declared in the TransformationSummary message type.

TransformationSummary.Types.SummaryResult

A collection that informs the user the number of times a particular TransformationResultCode and error details occurred.

TransientCryptoKey

Use this to have a random data crypto key generated. It will be discarded after the request finishes.

UnwrappedCryptoKey

Using raw keys is prone to security risks due to accidentally leaking the key. Choose another type of key if possible.

UpdateDeidentifyTemplateRequest

Request message for UpdateDeidentifyTemplate.

UpdateInspectTemplateRequest

Request message for UpdateInspectTemplate.

UpdateJobTriggerRequest

Request message for UpdateJobTrigger.

UpdateStoredInfoTypeRequest

Request message for UpdateStoredInfoType.

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.

ValueFrequency

A value of a field, including its frequency.

Enums

Action.ActionOneofCase

Enum of possible cases for the "action" oneof.

AnalyzeDataSourceRiskDetails.ResultOneofCase

Enum of possible cases for the "result" oneof.

BigQueryOptions.Types.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, rows are scanned in the order BigQuery reads them.

ByteContentItem.Types.BytesType

The type of data being sent for inspection. To learn more, see Supported file types.

CharsToIgnore.CharactersOneofCase

Enum of possible cases for the "characters" oneof.

CharsToIgnore.Types.CommonCharsToIgnore

Convenience enum for indication common characters to not transform.

CloudStorageOptions.Types.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.

ContentItem.DataItemOneofCase

Enum of possible cases for the "data_item" oneof.

ContentLocation.LocationOneofCase

Enum of possible cases for the "location" oneof.

ContentOption

Deprecated and unused.

CreateDlpJobRequest.JobOneofCase

Enum of possible cases for the "job" oneof.

CryptoKey.SourceOneofCase

Enum of possible cases for the "source" oneof.

CryptoReplaceFfxFpeConfig.AlphabetOneofCase

Enum of possible cases for the "alphabet" oneof.

CryptoReplaceFfxFpeConfig.Types.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.

CustomInfoType.TypeOneofCase

Enum of possible cases for the "type" oneof.

CustomInfoType.Types.DetectionRule.TypeOneofCase

Enum of possible cases for the "type" oneof.

CustomInfoType.Types.DetectionRule.Types.LikelihoodAdjustment.AdjustmentOneofCase

Enum of possible cases for the "adjustment" oneof.

CustomInfoType.Types.Dictionary.SourceOneofCase

Enum of possible cases for the "source" oneof.

CustomInfoType.Types.ExclusionType

DataProfileAction.ActionOneofCase

Enum of possible cases for the "action" oneof.

DataProfileAction.Types.EventType

Types of event that can trigger an action.

DataProfileAction.Types.PubSubNotification.Types.DetailLevel

The levels of detail that can be included in the Pub/Sub message.

DataProfileLocation.LocationOneofCase

Enum of possible cases for the "location" oneof.

DataProfilePubSubCondition.Types.ProfileScoreBucket

Various score levels for resources.

DataProfilePubSubCondition.Types.PubSubCondition.ValueOneofCase

Enum of possible cases for the "value" oneof.

DataProfilePubSubCondition.Types.PubSubExpressions.Types.PubSubLogicalOperator

Logical operators for conditional checks.

DataRiskLevel.Types.DataRiskLevelScore

Various score levels for resources.

DateShiftConfig.MethodOneofCase

Enum of possible cases for the "method" oneof.

DeidentifyConfig.TransformationOneofCase

Enum of possible cases for the "transformation" oneof.

DeidentifyTemplateName.ResourceNameType

The possible contents of DeidentifyTemplateName.

DlpContentName.ResourceNameType

The possible contents of DlpContentName.

DlpJob.DetailsOneofCase

Enum of possible cases for the "details" oneof.

DlpJob.Types.JobState

Possible states of a job. New items may be added.

DlpJobName.ResourceNameType

The possible contents of DlpJobName.

DlpJobType

An enum to represent the various types of DLP jobs.

EncryptionStatus

How a resource is encrypted.

ExclusionRule.TypeOneofCase

Enum of possible cases for the "type" oneof.

FieldTransformation.TransformationOneofCase

Enum of possible cases for the "transformation" oneof.

FileType

Definitions of file type groups to scan. New types will be added to this list.

FindingName.ResourceNameType

The possible contents of FindingName.

InfoTypeCategory.CategoryOneofCase

Enum of possible cases for the "category" oneof.

InfoTypeCategory.Types.IndustryCategory

Enum of the current industries in the category. We might add more industries in the future.

InfoTypeCategory.Types.LocationCategory

Enum of the current locations. We might add more locations in the future.

InfoTypeCategory.Types.TypeCategory

Enum of the current types in the category. We might add more types in the future.

InfoTypeSupportedBy

Parts of the APIs which use certain infoTypes.

InspectionRule.TypeOneofCase

Enum of possible cases for the "type" oneof.

InspectTemplateName.ResourceNameType

The possible contents of InspectTemplateName.

JobTrigger.JobOneofCase

Enum of possible cases for the "job" oneof.

JobTrigger.Types.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.