"description":"Provides methods for detection, risk analysis, and de-identification of privacy-sensitive fragments in text, images, and Google Cloud Platform storage repositories.",
"description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location":"query",
"type":"string"
}
},
"protocol":"rest",
"resources":{
"infoTypes":{
"methods":{
"list":{
"description":"Returns sensitive information types DLP supports.",
"flatPath":"v2beta2/infoTypes",
"httpMethod":"GET",
"id":"dlp.infoTypes.list",
"parameterOrder":[],
"parameters":{
"filter":{
"description":"Optional filter to only return infoTypes supported by certain parts of the\nAPI. Defaults to supported_by=INSPECT.",
"location":"query",
"type":"string"
},
"languageCode":{
"description":"Optional BCP-47 language code for localized infoType friendly\nnames. If omitted, or if localized strings are not available,\nen-US strings will be returned.",
"description":"Resource name of the organization and deidentify template to be deleted,\nfor example `organizations/433245324/deidentifyTemplates/432452342` or\nprojects/project-id/deidentifyTemplates/432452342.",
"description":"Resource name of the organization and deidentify template to be read, for\nexample `organizations/433245324/deidentifyTemplates/432452342` or\nprojects/project-id/deidentifyTemplates/432452342.",
"description":"Resource name of organization and deidentify template to be updated, for\nexample `organizations/433245324/deidentifyTemplates/432452342` or\nprojects/project-id/deidentifyTemplates/432452342.",
"description":"Resource name of the organization and inspectTemplate to be deleted, for\nexample `organizations/433245324/inspectTemplates/432452342` or\nprojects/project-id/inspectTemplates/432452342.",
"description":"Resource name of the organization and inspectTemplate to be read, for\nexample `organizations/433245324/inspectTemplates/432452342` or\nprojects/project-id/inspectTemplates/432452342.",
"description":"Resource name of organization and inspectTemplate to be updated, for\nexample `organizations/433245324/inspectTemplates/432452342` or\nprojects/project-id/inspectTemplates/432452342.",
"description":"De-identifies potentially sensitive info from a ContentItem.\nThis method has limits on input size and output size.\n[How-to guide](/dlp/docs/deidentify-sensitive-data)",
"description":"Finds potentially sensitive info in content.\nThis method has limits on input size, processing time, and output size.\n[How-to guide for text](/dlp/docs/inspecting-text), [How-to guide for\nimages](/dlp/docs/inspecting-images)",
"description":"Schedules a job to compute risk analysis metrics over content in a Google\nCloud Platform repository. [How-to guide](/dlp/docs/compute-risk-analysis)",
"description":"Resource name of the organization and deidentify template to be deleted,\nfor example `organizations/433245324/deidentifyTemplates/432452342` or\nprojects/project-id/deidentifyTemplates/432452342.",
"description":"Resource name of the organization and deidentify template to be read, for\nexample `organizations/433245324/deidentifyTemplates/432452342` or\nprojects/project-id/deidentifyTemplates/432452342.",
"description":"Resource name of organization and deidentify template to be updated, for\nexample `organizations/433245324/deidentifyTemplates/432452342` or\nprojects/project-id/deidentifyTemplates/432452342.",
"description":"Starts asynchronous cancellation on a long-running DlpJob. The server\nmakes a best effort to cancel the DlpJob, but success is not\nguaranteed.",
"description":"Deletes a long-running DlpJob. This method indicates that the client is\nno longer interested in the DlpJob result. The job will be cancelled if\npossible.",
"description":"Optional. Allows filtering.\n\nSupported syntax:\n\n* Filter expressions are made up of one or more restrictions.\n* Restrictions can be combined by `AND` or `OR` logical operators. A\nsequence of restrictions implicitly uses `AND`.\n* A restriction has the form of `\u003cfield\u003e \u003coperator\u003e \u003cvalue\u003e`.\n* Supported fields/values for inspect jobs:\n - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED\n - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY\n - `trigger_name` - The resource name of the trigger that created job.\n* Supported fields for risk analysis jobs:\n - `state` - RUNNING|CANCELED|FINISHED|FAILED\n* The operator must be `=` or `!=`.\n\nExamples:\n\n* inspected_storage = cloud_storage AND state = done\n* inspected_storage = cloud_storage OR inspected_storage = bigquery\n* inspected_storage = cloud_storage AND (state = done OR state = canceled)\n\nThe length of this field should be no more than 500 characters.",
"location":"query",
"type":"string"
},
"pageSize":{
"description":"The standard list page size.",
"format":"int32",
"location":"query",
"type":"integer"
},
"pageToken":{
"description":"The standard list page token.",
"location":"query",
"type":"string"
},
"parent":{
"description":"The parent resource name, for example projects/my-project-id.",
"location":"path",
"pattern":"^projects/[^/]+$",
"required":true,
"type":"string"
},
"type":{
"description":"The type of job. Defaults to `DlpJobType.INSPECT`",
"description":"Redacts potentially sensitive info from an image.\nThis method has limits on input size, processing time, and output size.\n[How-to guide](/dlp/docs/redacting-sensitive-data-images)",
"description":"Resource name of the organization and inspectTemplate to be deleted, for\nexample `organizations/433245324/inspectTemplates/432452342` or\nprojects/project-id/inspectTemplates/432452342.",
"description":"Resource name of the organization and inspectTemplate to be read, for\nexample `organizations/433245324/inspectTemplates/432452342` or\nprojects/project-id/inspectTemplates/432452342.",
"description":"Resource name of organization and inspectTemplate to be updated, for\nexample `organizations/433245324/inspectTemplates/432452342` or\nprojects/project-id/inspectTemplates/432452342.",
"description":"Optional comma separated list of triggeredJob fields to order by,\nfollowed by 'asc/desc' postfix, i.e.\n`\"create_time asc,name desc,schedule_mode asc\"`. This list is\ncase-insensitive.\n\nExample: `\"name asc,schedule_mode desc, status desc\"`\n\nSupported filters keys and values are:\n\n- `create_time`: corresponds to time the triggeredJob was created.\n- `update_time`: corresponds to time the triggeredJob was last updated.\n- `name`: corresponds to JobTrigger's display name.\n- `status`: corresponds to the triggeredJob status.",
"location":"query",
"type":"string"
},
"pageSize":{
"description":"Optional size of the page, can be limited by a server.",
"format":"int32",
"location":"query",
"type":"integer"
},
"pageToken":{
"description":"Optional page token to continue retrieval. Comes from previous call\nto ListJobTriggers. `order_by` and `filter` should not change for\nsubsequent calls, but can be omitted if token is specified.",
"location":"query",
"type":"string"
},
"parent":{
"description":"The parent resource name, for example projects/my-project-id.",
"description":"An auxiliary table contains statistical information on the relative\nfrequency of different quasi-identifiers values. It has one or several\nquasi-identifiers columns, and one column that indicates the relative\nfrequency of each quasi-identifier tuple.\nIf a tuple is present in the data but not in the auxiliary table, the\ncorresponding relative frequency is assumed to be zero (and thus, the\ntuple is highly reidentifiable).",
"description":"The relative frequency column must contain a floating-point number\nbetween 0 and 1 (inclusive). Null values are assumed to be zero.\n[required]"
"description":"Options defining BigQuery table and row identifiers.",
"id":"GooglePrivacyDlpV2beta1BigQueryOptions",
"properties":{
"identifyingFields":{
"description":"References to fields uniquely identifying rows within the table.\nNested fields in the format, like `person.birthdate.year`, are allowed.",
"description":"Message defining the location of a BigQuery table. A table is uniquely\nidentified by its project_id, dataset_id, and table_name. Within a query\na table is often referenced with a string in the format of:\n`\u003cproject_id\u003e:\u003cdataset_id\u003e.\u003ctable_id\u003e` or\n`\u003cproject_id\u003e.\u003cdataset_id\u003e.\u003ctable_id\u003e`.",
"description":"Field to compute categorical stats on. All column types are\nsupported except for arrays and structs. However, it may be more\ninformative to use NumericalStats when the field type is supported,\ndepending on the data."
"description":"Custom information type provided by the user. Used to find domain-specific\nsensitive information configurable to the data in question.",
"description":"Info type configuration. All custom info types must have configurations\nthat do not conflict with built-in info types or other custom info types."
"description":"A partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty."
"description":"Custom information type based on a dictionary of words or phrases. This can\nbe used to match sensitive information specific to the data, such as a list\nof employee IDs or job titles.\n\nDictionary words are case-insensitive and all characters other than letters\nand digits in the unicode [Basic Multilingual\nPlane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane)\nwill be replaced with whitespace when scanning for matches, so the\ndictionary phrase \"Sam Johnson\" will match all three phrases \"sam johnson\",\n\"Sam, Johnson\", and \"Sam (Johnson)\". Additionally, the characters\nsurrounding any match must be of a different type than the adjacent\ncharacters within the word, so letters must be next to non-letters and\ndigits next to non-digits. For example, the dictionary word \"jen\" will\nmatch the first three letters of the text \"jen123\" but will return no\nmatches for \"jennifer\".\n\nDictionary words containing a large number of characters that are not\nletters or digits may result in unexpected findings because such characters\nare treated as whitespace.",
"description":"An entity in a dataset is a field or set of fields that correspond to a\nsingle person. For example, in medical records the `EntityId` might be\na patient identifier, or for financial records it might be an account\nidentifier. This message is used when generalizations or analysis must be\nconsistent across multiple rows pertaining to the same entity.",
"description":"Type of information the findings limit applies to. Only one limit per\ninfo_type should be provided. If InfoTypeLimit does not have an\ninfo_type, the DLP API applies the limit against all info_types that are\nfound but not specified in another InfoTypeLimit."
"description":"Configuration description of the scanning process.\nWhen used with redactContent only info_types and min_likelihood are currently\nused.",
"description":"Custom info types provided by the user.",
"items":{
"$ref":"GooglePrivacyDlpV2beta1CustomInfoType"
},
"type":"array"
},
"excludeTypes":{
"description":"When true, excludes type information of the findings.",
"type":"boolean"
},
"includeQuote":{
"description":"When true, a contextual quote from the data that triggered a finding is\nincluded in the response; see Finding.quote.",
"type":"boolean"
},
"infoTypeLimits":{
"description":"Configuration of findings limit given for specified info types.",
"items":{
"$ref":"GooglePrivacyDlpV2beta1InfoTypeLimit"
},
"type":"array"
},
"infoTypes":{
"description":"Restricts what info_types to look for. The values must correspond to\nInfoType values returned by ListInfoTypes or found in documentation.\nEmpty info_types runs all enabled detectors.",
"items":{
"$ref":"GooglePrivacyDlpV2beta1InfoType"
},
"type":"array"
},
"maxFindings":{
"description":"Limits the number of findings per content item or long running operation.",
"format":"int32",
"type":"integer"
},
"minLikelihood":{
"description":"Only returns findings equal or above this threshold.",
"description":"The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `inspect/results/{id}`.",
"description":"Optional message indicating that each distinct entity_id should not\ncontribute to the k-anonymity count more than once per equivalence class.\nIf an entity_id appears on several rows with different quasi-identifier\ntuples, it will contribute to each count exactly once.\n\nThis can lead to unexpected results. Consider a table where ID 1 is\nassociated to quasi-identifier \"foo\", ID 2 to \"bar\", and ID 3 to *both*\nquasi-identifiers \"foo\" and \"bar\" (on separate rows), and where this ID\nis used as entity_id. Then, the anonymity value associated to ID 3 will\nbe 2, even if it is the only ID to be associated to both values \"foo\" and\n\"bar\"."
},
"quasiIds":{
"description":"Set of fields to compute k-anonymity over. When multiple fields are\nspecified, they are considered a single composite key. Structs and\nrepeated data types are not supported; however, nested fields are\nsupported so long as they are not structs themselves or nested within\na repeated field.",
"description":"Set of values defining the equivalence class. One value per\nquasi-identifier column in the original KAnonymity metric message.\nThe order is always the same as the original request.",
"description":"Reidentifiability metric. This corresponds to a risk model similar to what\nis called \"journalist risk\" in the literature, except the attack dataset is\nstatistically modeled instead of being perfectly known. This can be done\nusing publicly available data (like the US Census), or using a custom\nstatistical model (indicated as one or several BigQuery tables), or by\nextrapolating from the distribution of values in the input dataset.",
"description":"Several auxiliary tables can be used in the analysis. Each custom_tag\nused to tag a quasi-identifiers column must appear in exactly one column\nof one auxiliary table.",
"description":"ISO 3166-1 alpha-2 region code to use in the statistical modeling.\nRequired if no column is tagged with a region-specific InfoType (like\nUS_ZIP_5) or a region code.",
"description":"A KMapEstimationHistogramBucket message with the following values:\n min_anonymity: 3\n max_anonymity: 5\n frequency: 42\nmeans that there are 42 records whose quasi-identifier values correspond\nto 3, 4 or 5 people in the overlying population. An important particular\ncase is when min_anonymity = max_anonymity = 1: the frequency field then\ncorresponds to the number of uniquely identifiable records.",
"description":"The intervals [min_anonymity, max_anonymity] do not overlap. If a value\ndoesn't correspond to any such interval, the associated frequency is\nzero. For example, the following records:\n {min_anonymity: 1, max_anonymity: 1, frequency: 17}\n {min_anonymity: 2, max_anonymity: 3, frequency: 42}\n {min_anonymity: 5, max_anonymity: 10, frequency: 99}\nmean that there are no record with an estimated anonymity of 4, 5, or\nlarger than 10.",
"description":"Set of quasi-identifiers indicating how equivalence classes are\ndefined for the l-diversity computation. When multiple fields are\nspecified, they are considered a single composite key.",
"description":"The path to a Google Cloud Storage location to store output.\nThe bucket must already exist and\nthe Google APIs service account for DLP must have write permission to\nwrite to the given bucket.\nResults are split over multiple csv files with each file name matching\nthe pattern \"[operation_id]_[count].csv\", for example\n`3094877188788974909_1.csv`. The `operation_id` matches the\nidentifier for the Operation, and the `count` is a counter used for\ntracking the number of files written.\n\nThe CSV file(s) contain the following columns regardless of storage type\nscanned:\n- id\n- info_type\n- likelihood\n- byte size of finding\n- quote\n- timestamp\n\nFor Cloud Storage the next columns are:\n\n- file_path\n- start_offset\n\nFor Cloud Datastore the next columns are:\n\n- project_id\n- namespace_id\n- path\n- column_name\n- offset\n\nFor BigQuery the next columns are:\n\n- row_number\n- project_id\n- dataset_id\n- table_id"
"description":"Datastore partition ID.\nA partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty.\n\nA partition ID contains several dimensions:\nproject ID and namespace ID.",
"description":"A quasi-identifier column has a custom_tag, used to know which column\nin the data corresponds to which column in the statistical model.",
"description":"Metadata returned within the\n[`riskAnalysis.operations.get`](/dlp/docs/reference/rest/v2beta1/riskAnalysis.operations/get)\nfor risk analysis.",
"description":"Message for detecting output from deidentification transformations\nsuch as\n[`CryptoReplaceFfxFpeConfig`](/dlp/docs/reference/rest/v2beta1/content/deidentify#CryptoReplaceFfxFpeConfig).\nThese types of transformations are\nthose that perform pseudonymization, thereby producing a \"surrogate\" as\noutput. This should be used in conjunction with a field on the\ntransformation such as `surrogate_info_type`. This custom info type does\nnot support the use of `detection_rules`.",
"description":"A column can be tagged with a custom tag. In this case, the user must\nindicate an auxiliary table that contains statistical information on\nthe possible values of this column (below).",
"description":"If no semantic tag is indicated, we infer the statistical model from\nthe distribution of values in the input data"
},
"infoType":{
"$ref":"GooglePrivacyDlpV2beta1InfoType",
"description":"A column can be tagged with a InfoType to use the relevant public\ndataset as a statistical model of population, if available. We\ncurrently support US ZIP codes, region codes, ages and genders."
"description":"Set of primitive values supported by the system.\nNote that for the purposes of inspection or transformation, the number\nof bytes considered to comprise a 'Value' is based on its representation\nas a UTF-8 encoded string. For example, if 'integer_value' is set to\n123456789, the number of bytes would be counted as 9, even though an\nint64 only holds up to 8 bytes of data.",
"description":"Words or phrases defining the dictionary. The dictionary must contain\nat least one phrase and every phrase must contain at least 2 characters\nthat are letters or digits. [required]",
"description":"Optional job ID to use for the created job. If not provided, a job ID will\nautomatically be generated. Must be unique within the project. The job ID\ncan contain uppercase and lowercase letters, numbers, and hyphens; that is,\nit must match the regular expression: `[a-zA-Z\\\\d-]+`. The maximum length\nis 100 characters. Can be empty to allow the system to generate one.",
"description":"An auxiliary table contains statistical information on the relative\nfrequency of different quasi-identifiers values. It has one or several\nquasi-identifiers columns, and one column that indicates the relative\nfrequency of each quasi-identifier tuple.\nIf a tuple is present in the data but not in the auxiliary table, the\ncorresponding relative frequency is assumed to be zero (and thus, the\ntuple is highly reidentifiable).",
"description":"The relative frequency column must contain a floating-point number\nbetween 0 and 1 (inclusive). Null values are assumed to be zero.\n[required]"
"description":"References to fields uniquely identifying rows within the table.\nNested fields in the format, like `person.birthdate.year`, are allowed.",
"description":"Message defining the location of a BigQuery table. A table is uniquely\nidentified by its project_id, dataset_id, and table_name. Within a query\na table is often referenced with a string in the format of:\n`\u003cproject_id\u003e:\u003cdataset_id\u003e.\u003ctable_id\u003e` or\n`\u003cproject_id\u003e.\u003cdataset_id\u003e.\u003ctable_id\u003e`.",
"id":"GooglePrivacyDlpV2beta2BigQueryTable",
"properties":{
"datasetId":{
"description":"Dataset ID of the table.",
"type":"string"
},
"projectId":{
"description":"The Google Cloud Platform project ID of the project containing the table.\nIf omitted, project ID is inferred from the API call.",
"description":"Generalization function that buckets values based on ranges. The ranges and\nreplacement values are dynamically provided by the user for custom behavior,\nsuch as 1-30 -\u003e LOW 31-65 -\u003e MEDIUM 66-100 -\u003e HIGH\nThis can be used on\ndata of type: number, long, string, timestamp.\nIf the bound `Value` type differs from the type of data being transformed, we\nwill first attempt converting the type of the data to be transformed to match\nthe type of the bound before comparing.",
"description":"Field to compute categorical stats on. All column types are\nsupported except for arrays and structs. However, it may be more\ninformative to use NumericalStats when the field type is supported,\ndepending on the data."
"description":"Partially mask a string by replacing a given number of characters with a\nfixed character. Masking can start from the beginning or end of the string.\nThis can be used on data of any type (numbers, longs, and so on) and when\nde-identifying structured data we'll attempt to preserve the original data's\ntype. (This allows you to take a long like 123 and modify it to a string like\n**3.",
"description":"When masking a string, items in this list will be skipped when replacing.\nFor example, if your string is 555-555-5555 and you ask us to skip `-` and\nmask 5 chars with * we would produce ***-*55-5555.",
"description":"Character to mask the sensitive values\u0026mdash;for example, \"*\" for an\nalphabetic string such as name, or \"0\" for a numeric string such as ZIP\ncode or credit card number. String must have length 1. If not supplied, we\nwill default to \"*\" for strings, 0 for digits.",
"description":"Mask characters in reverse order. For example, if `masking_character` is\n'0', number_to_mask is 14, and `reverse_order` is false, then\n1234-5678-9012-3456 -\u003e 00000000000000-3456\nIf `masking_character` is '*', `number_to_mask` is 3, and `reverse_order`\nis true, then 12345 -\u003e 12***",
"description":"The amount of red in the color as a value in the interval [0, 1].",
"format":"float",
"type":"number"
}
},
"type":"object"
},
"GooglePrivacyDlpV2beta2Condition":{
"description":"The field type of `value` and `field` do not need to match to be\nconsidered equal, but not all comparisons are possible.\n\nA `value` of type:\n\n- `string` can be compared against all other types\n- `boolean` can only be compared against other booleans\n- `integer` can be compared against doubles or a string if the string value\ncan be parsed as an integer.\n- `double` can be compared against integers or a string if the string can\nbe parsed as a double.\n- `Timestamp` can be compared against strings in RFC 3339 date string\nformat.\n- `TimeOfDay` can be compared against timestamps and strings in the format\nof 'HH:mm:ss'.\n\nIf we fail to compare do to type mismatch, a warning will be given and\nthe condition will evaluate to false.",
"id":"GooglePrivacyDlpV2beta2Condition",
"properties":{
"field":{
"$ref":"GooglePrivacyDlpV2beta2FieldId",
"description":"Field within the record this condition is evaluated against. [required]"
"description":"Structured content for inspection."
},
"type":{
"description":"Type of the content, as defined in Content-Type HTTP header.\nSupported types are: all \"text\" types, octet streams, PNG images,\nJPEG images.",
"type":"string"
},
"value":{
"description":"String data to inspect or redact.",
"description":"The template id can contain uppercase and lowercase letters,\nnumbers, and hyphens; that is, it must match the regular\nexpression: `[a-zA-Z\\\\d-]+`. The maximum length is 100\ncharacters. Can be empty to allow the system to generate one.",
"description":"The template id can contain uppercase and lowercase letters,\nnumbers, and hyphens; that is, it must match the regular\nexpression: `[a-zA-Z\\\\d-]+`. The maximum length is 100\ncharacters. Can be empty to allow the system to generate one.",
"description":"The trigger id can contain uppercase and lowercase letters,\nnumbers, and hyphens; that is, it must match the regular\nexpression: `[a-zA-Z\\\\d-]+`. The maximum length is 100\ncharacters. Can be empty to allow the system to generate one.",
"description":"Pseudonymization method that generates surrogates via cryptographic hashing.\nUses SHA-256.\nThe key size must be either 32 or 64 bytes.\nOutputs a 32 byte digest as an uppercase hex string\n(for example, 41D1567F7F99F1DC2A5FAB886DEE5BEE).\nCurrently, only string and integer values can be hashed.",
"description":"This is a data encryption key (DEK) (as opposed to\na key encryption key (KEK) stored by KMS).\nWhen using KMS to wrap/unwrap DEKs, be sure to set an appropriate\nIAM policy on the KMS CryptoKey (KEK) to ensure an attacker cannot\nunwrap the data crypto key.",
"description":"Replaces an identifier with a surrogate using FPE with the FFX\nmode of operation; however when used in the `ReidentifyContent` API method,\nit serves the opposite function by reversing the surrogate back into\nthe original identifier.\nThe identifier must be encoded as ASCII.\nFor a given crypto key and context, the same identifier will be\nreplaced with the same surrogate.\nIdentifiers must be at least two characters long.\nIn the case that the identifier is the empty string, it will be skipped.\nSee [Pseudonymization](/dlp/docs/pseudonymization) for example usage.",
"description":"The 'tweak', a context may be used for higher security since the same\nidentifier in two different contexts won't be given the same surrogate. If\nthe context is not set, a default tweak will be used.\n\nIf the context is set but:\n\n1. there is no record present when transforming a given value or\n1. the field is not present when transforming a given value,\n\na default tweak will be used.\n\nNote that case (1) is expected when an `InfoTypeTransformation` is\napplied to both structured and non-structured `ContentItem`s.\nCurrently, the referenced field may be of value type integer or string.\n\nThe tweak is constructed as a sequence of bytes in big endian byte order\nsuch that:\n\n- a 64 bit integer is encoded followed by a single byte of value 1\n- a string is encoded in UTF-8 format followed by a single byte of value\n å 2"
},
"cryptoKey":{
"$ref":"GooglePrivacyDlpV2beta2CryptoKey",
"description":"The key used by the encryption algorithm. [required]"
},
"customAlphabet":{
"description":"This is supported by mapping these to the alphanumeric characters\nthat the FFX mode natively supports. This happens before/after\nencryption/decryption.\nEach character listed must appear only once.\nNumber of characters must be in the range [2, 62].\nThis must be encoded as ASCII.\nThe order of characters does not matter.",
"description":"The custom infoType to annotate the surrogate with.\nThis annotation will be applied to the surrogate by prefixing it with\nthe name of the custom infoType followed by the number of\ncharacters comprising the surrogate. The following scheme defines the\nformat: info_type_name(surrogate_character_count):surrogate\n\nFor example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and\nthe surrogate is 'abc', the full replacement value\nwill be: 'MY_TOKEN_INFO_TYPE(3):abc'\n\nThis annotation identifies the surrogate when inspecting content using the\ncustom infoType\n[`SurrogateType`](/dlp/docs/reference/rest/v2beta2/InspectConfig#surrogatetype).\nThis facilitates reversal of the surrogate when it occurs in free text.\n\nIn order for inspection to work properly, the name of this infoType must\nnot occur naturally anywhere in your data; otherwise, inspection may\nfind a surrogate that does not correspond to an actual identifier.\nTherefore, choose your custom infoType name carefully after considering\nwhat your data looks like. One way to select a name that has a high chance\nof yielding reliable detection is to include one or more unicode characters\nthat are highly improbable to exist in your data.\nFor example, assuming your data is entered from a regular ASCII keyboard,\nthe symbol with the hex code point 29DD might be used like so:\n⧝MY_TOKEN_TYPE"
"description":"Custom information type provided by the user. Used to find domain-specific\nsensitive information configurable to the data in question.",
"description":"Set of detection rules to apply to all findings of this custom info type.\nRules are applied in order that they are specified. Not supported for the\n`surrogate_type` custom info type.",
"description":"Dictionary-based custom info type."
},
"infoType":{
"$ref":"GooglePrivacyDlpV2beta2InfoType",
"description":"Info type configuration. All custom info types must have configurations\nthat do not conflict with built-in info types or other custom info types."
},
"likelihood":{
"description":"Likelihood to return for this custom info type. This base value can be\naltered by a detection rule if the finding meets the criteria specified by\nthe rule. Defaults to `VERY_LIKELY` if not specified.",
"enum":[
"LIKELIHOOD_UNSPECIFIED",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"enumDescriptions":[
"Default value; information with all likelihoods is included.",
"description":"A partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty."
"description":"Points to the field that contains the context, for example, an entity id.\nIf set, must also set method. If set, shift will be consistent for the\ngiven context."
"description":"Causes the shift to be computed based on this key and the context. This\nresults in the same shift for the same context and crypto_key."
"description":"Range of shift in days. Actual shift will be selected at random within this\nrange (inclusive ends). Negative means shift to earlier in time. Must not\nbe more than 365250 days (1000 years) each direction.\n\nFor example, 3 means shift date to at most 3 days into the future.\n[Required]",
"description":"Treat the dataset as structured. Transformations can be applied to\nspecific locations within structured datasets, such as transforming\na column within a table."
"description":"Configuration for the de-identification of the content item.\nItems specified here will override the template referenced by the\ndeidentify_template_name argument."
},
"deidentifyTemplateName":{
"description":"Optional template to use. Any configuration directly specified in\ndeidentify_config will override those set in the template. Singular fields\nthat are set in this request will replace their corresponding fields in the\ntemplate. Repeated fields are appended. Singular sub-messages and groups\nare recursively merged.",
"type":"string"
},
"inspectConfig":{
"$ref":"GooglePrivacyDlpV2beta2InspectConfig",
"description":"Configuration for the inspector.\nItems specified here will override the template referenced by the\ninspect_template_name argument."
},
"inspectTemplateName":{
"description":"Optional template to use. Any configuration directly specified in\ninspect_config will override those set in the template. Singular fields\nthat are set in this request will replace their corresponding fields in the\ntemplate. Repeated fields are appended. Singular sub-messages and groups\nare recursively merged.",
"type":"string"
},
"item":{
"$ref":"GooglePrivacyDlpV2beta2ContentItem",
"description":"The item to de-identify. Will be treated as text."
"description":"The template name. Output only.\n\nThe template will have one of the following formats:\n`projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR\n`organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID`",
"type":"string"
},
"updateTime":{
"description":"The last update timestamp of a inspectTemplate, output only field.",
"description":"Rule for modifying a custom info type to alter behavior under certain\ncircumstances, depending on the specific details of the rule. Not supported\nfor the `surrogate_type` custom info type.",
"description":"Custom information type based on a dictionary of words or phrases. This can\nbe used to match sensitive information specific to the data, such as a list\nof employee IDs or job titles.\n\nDictionary words are case-insensitive and all characters other than letters\nand digits in the unicode [Basic Multilingual\nPlane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane)\nwill be replaced with whitespace when scanning for matches, so the\ndictionary phrase \"Sam Johnson\" will match all three phrases \"sam johnson\",\n\"Sam, Johnson\", and \"Sam (Johnson)\". Additionally, the characters\nsurrounding any match must be of a different type than the adjacent\ncharacters within the word, so letters must be next to non-letters and\ndigits next to non-digits. For example, the dictionary word \"jen\" will\nmatch the first three letters of the text \"jen123\" but will return no\nmatches for \"jennifer\".\n\nDictionary words containing a large number of characters that are not\nletters or digits may result in unexpected findings because such characters\nare treated as whitespace.",
"description":"An entity in a dataset is a field or set of fields that correspond to a\nsingle person. For example, in medical records the `EntityId` might be\na patient identifier, or for financial records it might be an account\nidentifier. This message is used when generalizations or analysis must be\nconsistent across multiple rows pertaining to the same entity.",
"id":"GooglePrivacyDlpV2beta2EntityId",
"properties":{
"field":{
"$ref":"GooglePrivacyDlpV2beta2FieldId",
"description":"Composite key indicating which field contains the entity identifier."
}
},
"type":"object"
},
"GooglePrivacyDlpV2beta2Error":{
"description":"The results of an unsuccessful activation of the JobTrigger.",
"description":"Only apply the transformation if the condition evaluates to true for the\ngiven `RecordCondition`. The conditions are allowed to reference fields\nthat are not used in the actual transformation. [optional]\n\nExample Use Cases:\n\n- Apply a different bucket transformation to an age column if the zip code\ncolumn for the same record is within a specific range.\n- Redact a field if the date of birth field is greater than 85."
},
"fields":{
"description":"Input field(s) to apply the transformation to. [required]",
"Default value; information with all likelihoods is included.",
"Few matching elements.",
"",
"Some matching elements.",
"",
"Many matching elements."
],
"type":"string"
},
"location":{
"$ref":"GooglePrivacyDlpV2beta2Location",
"description":"Where the content was found."
},
"quote":{
"description":"The content that was found. Even if the content is not textual, it\nmay be converted to a textual representation here.\nProvided if requested by the `InspectConfig` and the finding is\nless than or equal to 4096 bytes long. If the finding exceeds 4096 bytes\nin length, the quote may be omitted.",
"type":"string"
},
"quoteInfo":{
"$ref":"GooglePrivacyDlpV2beta2QuoteInfo",
"description":"Contains data parsed from quotes. Only populated if include_quote was set\nto true and a supported infoType was requested. Currently supported\ninfoTypes: DATE, DATE_OF_BIRTH and TIME."
"description":"Configuration of findings limit given for specified infoTypes.",
"items":{
"$ref":"GooglePrivacyDlpV2beta2InfoTypeLimit"
},
"type":"array"
},
"maxFindingsPerItem":{
"description":"Max number of findings that will be returned for each item scanned.\nWhen set within `InspectDataSourceRequest`,\nthe maximum returned is 1000 regardless if this is set higher.\nWhen set within `InspectContentRequest`, this field is ignored.",
"format":"int32",
"type":"integer"
},
"maxFindingsPerRequest":{
"description":"Max number of findings that will be returned per request/job.\nWhen set within `InspectContentRequest`, the maximum returned is 1000\nregardless if this is set higher.",
"description":"Buckets values based on fixed size ranges. The\nBucketing transformation can provide all of this functionality,\nbut requires more configuration. This message is provided as a convenience to\nthe user for simple bucketing strategies.\n\nThe transformed value will be a hyphenated string of\n\u003clower_bound\u003e-\u003cupper_bound\u003e, i.e if lower_bound = 10 and upper_bound = 20\nall values that are within this bucket will be replaced with \"10-20\".\n\nThis can be used on data of type: double, long.\n\nIf the bound Value type differs from the type of data\nbeing transformed, we will first attempt converting the type of the data to\nbe transformed to match the type of the bound before comparing.",
"description":"Size of each bucket (except for minimum and maximum buckets). So if\n`lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the\nfollowing buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60,\n60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. [Required].",
"format":"double",
"type":"number"
},
"lowerBound":{
"$ref":"GooglePrivacyDlpV2beta2Value",
"description":"Lower bound value of buckets. All values less than `lower_bound` are\ngrouped together into a single bucket; for example if `lower_bound` = 10,\nthen all values less than 10 are replaced with the value “-10”. [Required]."
},
"upperBound":{
"$ref":"GooglePrivacyDlpV2beta2Value",
"description":"Upper bound value of buckets. All values greater than upper_bound are\ngrouped together into a single bucket; for example if `upper_bound` = 89,\nthen all values greater than 89 are replaced with the value “89+”.\n[Required]."
}
},
"type":"object"
},
"GooglePrivacyDlpV2beta2HotwordRule":{
"description":"Detection rule that adjusts the likelihood of findings within a certain\nproximity of hotwords.",
"id":"GooglePrivacyDlpV2beta2HotwordRule",
"properties":{
"hotwordRegex":{
"$ref":"GooglePrivacyDlpV2beta2Regex",
"description":"Regex pattern defining what qualifies as a hotword."
"description":"Likelihood adjustment to apply to all matching findings."
},
"proximity":{
"$ref":"GooglePrivacyDlpV2beta2Proximity",
"description":"Proximity of the finding within which the entire hotword must reside.\nThe total length of the window cannot exceed 1000 characters. Note that\nthe finding itself will be included in the window, so that hotwords may\nbe used to match substrings of the finding itself. For example, the\ncertainty of a phone number regex \"\\(\\d{3}\\) \\d{3}-\\d{4}\" could be\nadjusted upwards if the area code is known to be the local area code of\na company office using the hotword regex \"\\(xxx\\)\", where \"xxx\"\nis the area code in question."
}
},
"type":"object"
},
"GooglePrivacyDlpV2beta2ImageLocation":{
"description":"Bounding box encompassing detected text within an image.",
"id":"GooglePrivacyDlpV2beta2ImageLocation",
"properties":{
"height":{
"description":"Height of the bounding box in pixels.",
"format":"int32",
"type":"integer"
},
"left":{
"description":"Left coordinate of the bounding box. (0,0) is upper left.",
"format":"int32",
"type":"integer"
},
"top":{
"description":"Top coordinate of the bounding box. (0,0) is upper left.",
"format":"int32",
"type":"integer"
},
"width":{
"description":"Width of the bounding box in pixels.",
"format":"int32",
"type":"integer"
}
},
"type":"object"
},
"GooglePrivacyDlpV2beta2ImageRedactionConfig":{
"description":"Configuration for determining how redaction of images should occur.",
"description":"Only one per info_type should be provided per request. If not\nspecified, and redact_all_text is false, the DLP API will redact all\ntext that it matches against all info_types that are found, but not\nspecified in another ImageRedactionConfig."
},
"redactAllText":{
"description":"If true, all text found in the image, regardless whether it matches an\ninfo_type, is redacted.",
"type":"boolean"
},
"redactionColor":{
"$ref":"GooglePrivacyDlpV2beta2Color",
"description":"The color to use when redacting content from an image. If not specified,\nthe default is black."
}
},
"type":"object"
},
"GooglePrivacyDlpV2beta2InfoType":{
"description":"Type of information detected by the API.",
"description":"Human readable form of the infoType name.",
"type":"string"
},
"name":{
"description":"Internal name of the infoType.",
"type":"string"
},
"supportedBy":{
"description":"Which parts of the API supports this InfoType.",
"enumDescriptions":[
"",
"Supported by the inspect operations.",
"Supported by the risk analysis operations."
],
"items":{
"enum":[
"ENUM_TYPE_UNSPECIFIED",
"INSPECT",
"RISK_ANALYSIS"
],
"type":"string"
},
"type":"array"
}
},
"type":"object"
},
"GooglePrivacyDlpV2beta2InfoTypeLimit":{
"description":"Max findings configuration per infoType, per content item or long\nrunning DlpJob.",
"id":"GooglePrivacyDlpV2beta2InfoTypeLimit",
"properties":{
"infoType":{
"$ref":"GooglePrivacyDlpV2beta2InfoType",
"description":"Type of information the findings limit applies to. Only one limit per\ninfo_type should be provided. If InfoTypeLimit does not have an\ninfo_type, the DLP API applies the limit against all info_types that\nare found but not specified in another InfoTypeLimit."
},
"maxFindings":{
"description":"Max findings limit for the given infoType.",
"format":"int32",
"type":"integer"
}
},
"type":"object"
},
"GooglePrivacyDlpV2beta2InfoTypeStatistics":{
"description":"Statistics regarding a specific InfoType.",
"id":"GooglePrivacyDlpV2beta2InfoTypeStatistics",
"properties":{
"count":{
"description":"Number of findings for this infoType.",
"format":"int64",
"type":"string"
},
"infoType":{
"$ref":"GooglePrivacyDlpV2beta2InfoType",
"description":"The type of finding this stat is for."
}
},
"type":"object"
},
"GooglePrivacyDlpV2beta2InfoTypeTransformation":{
"description":"A transformation to apply to text that is identified as a specific\ninfo_type.",
"description":"A type of transformation that will scan unstructured text and\napply various `PrimitiveTransformation`s to each finding, where the\ntransformation is applied to only values that were identified as a specific\ninfo_type.",
"description":"Configuration description of the scanning process.\nWhen used with redactContent only info_types and min_likelihood are currently\nused.",
"id":"GooglePrivacyDlpV2beta2InspectConfig",
"properties":{
"customInfoTypes":{
"description":"Custom infoTypes provided by the user.",
"items":{
"$ref":"GooglePrivacyDlpV2beta2CustomInfoType"
},
"type":"array"
},
"excludeInfoTypes":{
"description":"When true, excludes type information of the findings.",
"type":"boolean"
},
"includeQuote":{
"description":"When true, a contextual quote from the data that triggered a finding is\nincluded in the response; see Finding.quote.",
"type":"boolean"
},
"infoTypes":{
"description":"Restricts what info_types to look for. The values must correspond to\nInfoType values returned by ListInfoTypes or found in documentation.\nEmpty info_types runs all enabled detectors.",
"items":{
"$ref":"GooglePrivacyDlpV2beta2InfoType"
},
"type":"array"
},
"limits":{
"$ref":"GooglePrivacyDlpV2beta2FindingLimits"
},
"minLikelihood":{
"description":"Only returns findings equal or above this threshold. The default is\nPOSSIBLE.",
"enum":[
"LIKELIHOOD_UNSPECIFIED",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"enumDescriptions":[
"Default value; information with all likelihoods is included.",
"Few matching elements.",
"",
"Some matching elements.",
"",
"Many matching elements."
],
"type":"string"
}
},
"type":"object"
},
"GooglePrivacyDlpV2beta2InspectContentRequest":{
"description":"Request to search for potentially sensitive info in a ContentItem.",
"description":"Configuration for the inspector. What specified here will override\nthe template referenced by the inspect_template_name argument."
},
"inspectTemplateName":{
"description":"Optional template to use. Any configuration directly specified in\ninspect_config will override those set in the template. Singular fields\nthat are set in this request will replace their corresponding fields in the\ntemplate. Repeated fields are appended. Singular sub-messages and groups\nare recursively merged.",
"description":"Optional job ID to use for the created job. If not provided, a job ID will\nautomatically be generated. Must be unique within the project. The job ID\ncan contain uppercase and lowercase letters, numbers, and hyphens; that is,\nit must match the regular expression: `[a-zA-Z\\\\d-]+`. The maximum length\nis 100 characters. Can be empty to allow the system to generate one.",
"type":"string"
}
},
"type":"object"
},
"GooglePrivacyDlpV2beta2InspectJobConfig":{
"id":"GooglePrivacyDlpV2beta2InspectJobConfig",
"properties":{
"actions":{
"description":"Actions to execute at the completion of the job. Are executed in the order\nprovided.",
"items":{
"$ref":"GooglePrivacyDlpV2beta2Action"
},
"type":"array"
},
"inspectConfig":{
"$ref":"GooglePrivacyDlpV2beta2InspectConfig",
"description":"How and what to scan for."
},
"inspectTemplateName":{
"description":"If provided, will be used as the default for all values in InspectConfig.\n`inspect_config` will be merged into the values persisted as part of the\ntemplate.",
"description":"All the findings for a single scanned item.",
"id":"GooglePrivacyDlpV2beta2InspectResult",
"properties":{
"findings":{
"description":"List of findings for an item.",
"items":{
"$ref":"GooglePrivacyDlpV2beta2Finding"
},
"type":"array"
},
"findingsTruncated":{
"description":"If true, then this item might have more findings than were returned,\nand the findings returned are an arbitrary subset of all findings.\nThe findings list might be truncated because the input items were too\nlarge, or because the server reached the maximum amount of resources\nallowed for a single API call. For best results, divide the input into\nsmaller batches.",
"type":"boolean"
}
},
"type":"object"
},
"GooglePrivacyDlpV2beta2InspectTemplate":{
"description":"The inspectTemplate contains a configuration (set of types of sensitive data\nto be detected) to be used anywhere you otherwise would normally specify\nInspectConfig.",
"id":"GooglePrivacyDlpV2beta2InspectTemplate",
"properties":{
"createTime":{
"description":"The creation timestamp of a inspectTemplate, output only field.",
"description":"The core content of the template. Configuration of the scanning process."
},
"name":{
"description":"The template name. Output only.\n\nThe template will have one of the following formats:\n`projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID` OR\n`organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID`",
"type":"string"
},
"updateTime":{
"description":"The last update timestamp of a inspectTemplate, output only field.",
"format":"google-datetime",
"type":"string"
}
},
"type":"object"
},
"GooglePrivacyDlpV2beta2JobTrigger":{
"description":"Contains a configuration to make dlp api calls on a repeating basis.",
"id":"GooglePrivacyDlpV2beta2JobTrigger",
"properties":{
"createTime":{
"description":"The creation timestamp of a triggeredJob, output only field.",
"description":"A stream of errors encountered when the trigger was activated. Repeated\nerrors may result in the JobTrigger automaticaly being paused.\nWill return the last 100 errors. Whenever the JobTrigger is modified\nthis list will be cleared. Output only field.",
"items":{
"$ref":"GooglePrivacyDlpV2beta2Error"
},
"type":"array"
},
"inspectJob":{
"$ref":"GooglePrivacyDlpV2beta2InspectJobConfig"
},
"lastRunTime":{
"description":"The timestamp of the last time this trigger executed.",
"format":"google-datetime",
"type":"string"
},
"name":{
"description":"Unique resource name for the triggeredJob, assigned by the service when the\ntriggeredJob is created, for example\n`projects/dlp-test-project/triggeredJobs/53234423`.",
"type":"string"
},
"status":{
"description":"A status for this trigger. [required]",
"enum":[
"STATUS_UNSPECIFIED",
"HEALTHY",
"PAUSED",
"CANCELLED"
],
"enumDescriptions":[
"",
"Trigger is healthy.",
"Trigger is temporarily paused.",
"Trigger is cancelled and can not be resumed."
],
"type":"string"
},
"triggers":{
"description":"A list of triggers which will be OR'ed together. Only one in the list\nneeds to trigger for a job to be started. The list may contain only\na single Schedule trigger and must have at least one object.",
"items":{
"$ref":"GooglePrivacyDlpV2beta2Trigger"
},
"type":"array"
},
"updateTime":{
"description":"The last update timestamp of a triggeredJob, output only field.",
"format":"google-datetime",
"type":"string"
}
},
"type":"object"
},
"GooglePrivacyDlpV2beta2KAnonymityConfig":{
"description":"k-anonymity metric, used for analysis of reidentification risk.",
"id":"GooglePrivacyDlpV2beta2KAnonymityConfig",
"properties":{
"entityId":{
"$ref":"GooglePrivacyDlpV2beta2EntityId",
"description":"Optional message indicating that each distinct entity_id should not\ncontribute to the k-anonymity count more than once per equivalence class.\nIf an entity_id appears on several rows with different quasi-identifier\ntuples, it will contribute to each count exactly once.\n\nThis can lead to unexpected results. Consider a table where ID 1 is\nassociated to quasi-identifier \"foo\", ID 2 to \"bar\", and ID 3 to *both*\nquasi-identifiers \"foo\" and \"bar\" (on separate rows), and where this ID\nis used as entity_id. Then, the anonymity value associated to ID 3 will\nbe 2, even if it is the only ID to be associated to both values \"foo\" and\n\"bar\"."
},
"quasiIds":{
"description":"Set of fields to compute k-anonymity over. When multiple fields are\nspecified, they are considered a single composite key. Structs and\nrepeated data types are not supported; however, nested fields are\nsupported so long as they are not structs themselves or nested within\na repeated field.",
"description":"Size of the equivalence class, for example number of rows with the\nabove set of values.",
"format":"int64",
"type":"string"
},
"quasiIdsValues":{
"description":"Set of values defining the equivalence class. One value per\nquasi-identifier column in the original KAnonymity metric message.\nThe order is always the same as the original request.",
"description":"Reidentifiability metric. This corresponds to a risk model similar to what\nis called \"journalist risk\" in the literature, except the attack dataset is\nstatistically modeled instead of being perfectly known. This can be done\nusing publicly available data (like the US Census), or using a custom\nstatistical model (indicated as one or several BigQuery tables), or by\nextrapolating from the distribution of values in the input dataset.",
"description":"Several auxiliary tables can be used in the analysis. Each custom_tag\nused to tag a quasi-identifiers column must appear in exactly one column\nof one auxiliary table.",
"items":{
"$ref":"GooglePrivacyDlpV2beta2AuxiliaryTable"
},
"type":"array"
},
"quasiIds":{
"description":"Fields considered to be quasi-identifiers. No two columns can have the\nsame tag. [required]",
"items":{
"$ref":"GooglePrivacyDlpV2beta2TaggedField"
},
"type":"array"
},
"regionCode":{
"description":"ISO 3166-1 alpha-2 region code to use in the statistical modeling.\nRequired if no column is tagged with a region-specific InfoType (like\nUS_ZIP_5) or a region code.",
"description":"A KMapEstimationHistogramBucket message with the following values:\n min_anonymity: 3\n max_anonymity: 5\n frequency: 42\nmeans that there are 42 records whose quasi-identifier values correspond\nto 3, 4 or 5 people in the overlying population. An important particular\ncase is when min_anonymity = max_anonymity = 1: the frequency field then\ncorresponds to the number of uniquely identifiable records.",
"description":"The intervals [min_anonymity, max_anonymity] do not overlap. If a value\ndoesn't correspond to any such interval, the associated frequency is\nzero. For example, the following records:\n {min_anonymity: 1, max_anonymity: 1, frequency: 17}\n {min_anonymity: 2, max_anonymity: 3, frequency: 42}\n {min_anonymity: 5, max_anonymity: 10, frequency: 99}\nmean that there are no record with an estimated anonymity of 4, 5, or\nlarger than 10.",
"description":"A unique identifier for a Datastore entity.\nIf a key's partition ID or any of its path kinds or names are\nreserved/read-only, the key is reserved/read-only.\nA reserved/read-only key is forbidden in certain documented contexts.",
"id":"GooglePrivacyDlpV2beta2Key",
"properties":{
"partitionId":{
"$ref":"GooglePrivacyDlpV2beta2PartitionId",
"description":"Entities are partitioned into subsets, currently identified by a project\nID and namespace ID.\nQueries are scoped to a single partition."
},
"path":{
"description":"The entity path.\nAn entity path consists of one or more elements composed of a kind and a\nstring or numerical identifier, which identify entities. The first\nelement identifies a _root entity_, the second element identifies\na _child_ of the root entity, the third element identifies a child of the\nsecond entity, and so forth. The entities identified by all prefixes of\nthe path are called the element's _ancestors_.\n\nA path can never be empty, and a path can have at most 100 elements.",
"items":{
"$ref":"GooglePrivacyDlpV2beta2PathElement"
},
"type":"array"
}
},
"type":"object"
},
"GooglePrivacyDlpV2beta2KindExpression":{
"description":"A representation of a Datastore kind.",
"id":"GooglePrivacyDlpV2beta2KindExpression",
"properties":{
"name":{
"description":"The name of the kind.",
"type":"string"
}
},
"type":"object"
},
"GooglePrivacyDlpV2beta2KmsWrappedCryptoKey":{
"description":"Include to use an existing data crypto key wrapped by KMS.\nAuthorization requires the following IAM permissions when sending a request\nto perform a crypto transformation using a kms-wrapped crypto key:\ndlp.kms.encrypt",
"description":"The resource name of the KMS CryptoKey to use for unwrapping. [required]",
"type":"string"
},
"wrappedKey":{
"description":"The wrapped data crypto key. [required]",
"format":"byte",
"type":"string"
}
},
"type":"object"
},
"GooglePrivacyDlpV2beta2LDiversityConfig":{
"description":"l-diversity metric, used for analysis of reidentification risk.",
"id":"GooglePrivacyDlpV2beta2LDiversityConfig",
"properties":{
"quasiIds":{
"description":"Set of quasi-identifiers indicating how equivalence classes are\ndefined for the l-diversity computation. When multiple fields are\nspecified, they are considered a single composite key.",
"items":{
"$ref":"GooglePrivacyDlpV2beta2FieldId"
},
"type":"array"
},
"sensitiveAttribute":{
"$ref":"GooglePrivacyDlpV2beta2FieldId",
"description":"Sensitive field for computing the l-value."
"description":"Set the likelihood of a finding to a fixed value.",
"enum":[
"LIKELIHOOD_UNSPECIFIED",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"enumDescriptions":[
"Default value; information with all likelihoods is included.",
"Few matching elements.",
"",
"Some matching elements.",
"",
"Many matching elements."
],
"type":"string"
},
"relativeLikelihood":{
"description":"Increase or decrease the likelihood by the specified number of\nlevels. For example, if a finding would be `POSSIBLE` without the\ndetection rule and `relative_likelihood` is 1, then it is upgraded to\n`LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`.\nLikelihood may never drop below `VERY_UNLIKELY` or exceed\n`VERY_LIKELY`, so applying an adjustment of 1 followed by an\nadjustment of -1 when base likelihood is `VERY_LIKELY` will result in\na final likelihood of `LIKELY`.",
"description":"List of triggeredJobs, up to page_size in ListJobTriggersRequest.",
"items":{
"$ref":"GooglePrivacyDlpV2beta2JobTrigger"
},
"type":"array"
},
"nextPageToken":{
"description":"If the next page is available then the next page token to be used\nin following ListJobTriggers request.",
"type":"string"
}
},
"type":"object"
},
"GooglePrivacyDlpV2beta2Location":{
"description":"Specifies the location of the finding.",
"id":"GooglePrivacyDlpV2beta2Location",
"properties":{
"byteRange":{
"$ref":"GooglePrivacyDlpV2beta2Range",
"description":"Zero-based byte offsets delimiting the finding.\nThese are relative to the finding's containing element.\nNote that when the content is not textual, this references\nthe UTF-8 encoded textual representation of the content.\nOmitted if content is an image."
},
"codepointRange":{
"$ref":"GooglePrivacyDlpV2beta2Range",
"description":"Unicode character offsets delimiting the finding.\nThese are relative to the finding's containing element.\nProvided when the content is text."
},
"fieldId":{
"$ref":"GooglePrivacyDlpV2beta2FieldId",
"description":"The pointer to the property or cell that contained the finding.\nProvided when the finding's containing element is a cell in a table\nor a property of storage object."
},
"imageBoxes":{
"description":"The area within the image that contained the finding.\nProvided when the content is an image.",
"items":{
"$ref":"GooglePrivacyDlpV2beta2ImageLocation"
},
"type":"array"
},
"recordKey":{
"$ref":"GooglePrivacyDlpV2beta2RecordKey",
"description":"The pointer to the record in storage that contained the field the\nfinding was found in.\nProvided when the finding's containing element is a property\nof a storage object."
},
"tableLocation":{
"$ref":"GooglePrivacyDlpV2beta2TableLocation",
"description":"The pointer to the row of the table that contained the finding.\nProvided when the finding's containing element is a cell of a table."
}
},
"type":"object"
},
"GooglePrivacyDlpV2beta2NumericalStatsConfig":{
"description":"Compute numerical stats over an individual column, including\nmin, max, and quantiles.",
"description":"Schema used for writing the findings. Columns are derived from the\n`Finding` object. If appending to an existing table, any columns from the\npredefined schema that are missing will be added. No columns in the\nexisting table will be deleted.\n\nIf unspecified, then all available columns will be used for a new table,\nand no changes will be made to an existing table.",
"enum":[
"OUTPUT_SCHEMA_UNSPECIFIED",
"BASIC_COLUMNS",
"GCS_COLUMNS",
"DATASTORE_COLUMNS",
"BIG_QUERY_COLUMNS",
"ALL_COLUMNS"
],
"enumDescriptions":[
"",
"Basic schema including only `info_type`, `quote`, `certainty`, and\n`timestamp`.",
"Schema tailored to findings from scanning Google Cloud Storage.",
"Schema tailored to findings from scanning Google Datastore.",
"Schema tailored to findings from scanning Google BigQuery.",
"Schema containing all columns."
],
"type":"string"
},
"table":{
"$ref":"GooglePrivacyDlpV2beta2BigQueryTable",
"description":"Store findings in an existing table or a new table in an existing\ndataset. Each column in an existing table must have the same name, type,\nand mode of a field in the `Finding` object. If table_id is not set a new\none will be generated for you with the following format:\ndlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific timezone will be used for\ngenerating the date details."
}
},
"type":"object"
},
"GooglePrivacyDlpV2beta2PartitionId":{
"description":"Datastore partition ID.\nA partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty.\n\nA partition ID contains several dimensions:\nproject ID and namespace ID.",
"id":"GooglePrivacyDlpV2beta2PartitionId",
"properties":{
"namespaceId":{
"description":"If not empty, the ID of the namespace to which the entities belong.",
"type":"string"
},
"projectId":{
"description":"The ID of the project to which the entities belong.",
"type":"string"
}
},
"type":"object"
},
"GooglePrivacyDlpV2beta2PathElement":{
"description":"A (kind, ID/name) pair used to construct a key path.\n\nIf either name or ID is set, the element is complete.\nIf neither is set, the element is incomplete.",
"id":"GooglePrivacyDlpV2beta2PathElement",
"properties":{
"id":{
"description":"The auto-allocated ID of the entity.\nNever equal to zero. Values less than zero are discouraged and may not\nbe supported in the future.",
"format":"int64",
"type":"string"
},
"kind":{
"description":"The kind of the entity.\nA kind matching regex `__.*__` is reserved/read-only.\nA kind must not contain more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
"type":"string"
},
"name":{
"description":"The name of the entity.\nA name matching regex `__.*__` is reserved/read-only.\nA name must not be more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
"description":"Message for specifying a window around a finding to apply a detection\nrule.",
"id":"GooglePrivacyDlpV2beta2Proximity",
"properties":{
"windowAfter":{
"description":"Number of characters after the finding to consider.",
"format":"int32",
"type":"integer"
},
"windowBefore":{
"description":"Number of characters before the finding to consider.",
"format":"int32",
"type":"integer"
}
},
"type":"object"
},
"GooglePrivacyDlpV2beta2PublishToPubSub":{
"description":"Publish the results of a DlpJob to a pub sub channel.\nCompatible with: Inpect, Risk",
"id":"GooglePrivacyDlpV2beta2PublishToPubSub",
"properties":{
"topic":{
"description":"Cloud Pub/Sub topic to send notifications to. The topic must have given\npublishing access rights to the DLP API service account executing\nthe long running DlpJob sending the notifications.\nFormat is projects/{project}/topics/{topic}.",
"type":"string"
}
},
"type":"object"
},
"GooglePrivacyDlpV2beta2QuasiIdField":{
"description":"A quasi-identifier column has a custom_tag, used to know which column\nin the data corresponds to which column in the statistical model.",
"id":"GooglePrivacyDlpV2beta2QuasiIdField",
"properties":{
"customTag":{
"type":"string"
},
"field":{
"$ref":"GooglePrivacyDlpV2beta2FieldId"
}
},
"type":"object"
},
"GooglePrivacyDlpV2beta2QuoteInfo":{
"description":"Message for infoType-dependent details parsed from quote.",
"description":"Configuration defining which records get suppressed entirely. Records that\nmatch any suppression rule are omitted from the output [optional].",
"items":{
"$ref":"GooglePrivacyDlpV2beta2RecordSuppression"
},
"type":"array"
}
},
"type":"object"
},
"GooglePrivacyDlpV2beta2RedactConfig":{
"description":"Redact a given value. For example, if used with an `InfoTypeTransformation`\ntransforming PHONE_NUMBER, and input 'My phone number is 206-555-0123', the\noutput would be 'My phone number is '.",
"id":"GooglePrivacyDlpV2beta2RedactConfig",
"properties":{},
"type":"object"
},
"GooglePrivacyDlpV2beta2RedactImageRequest":{
"description":"Request to search for potentially sensitive info in a list of items\nand replace it with a default or provided content.",
"id":"GooglePrivacyDlpV2beta2RedactImageRequest",
"properties":{
"imageData":{
"description":"The bytes of the image to redact.",
"format":"byte",
"type":"string"
},
"imageRedactionConfigs":{
"description":"The configuration for specifying what content to redact from images.",
"description":"If an image was being inspected and the InspectConfig's include_quote was\nset to true, then this field will include all text, if any, that was found\nin the image.",
"type":"string"
},
"redactedImage":{
"description":"The redacted image. The type will be the same as the original image.",
"format":"byte",
"type":"string"
}
},
"type":"object"
},
"GooglePrivacyDlpV2beta2Regex":{
"description":"Message defining a custom regular expression.",
"id":"GooglePrivacyDlpV2beta2Regex",
"properties":{
"pattern":{
"description":"Pattern defining the regular expression.",
"description":"Optional template to use. Any configuration directly specified in\n`inspect_config` will override those set in the template. Singular fields\nthat are set in this request will replace their corresponding fields in the\ntemplate. Repeated fields are appended. Singular sub-messages and groups\nare recursively merged.",
"type":"string"
},
"item":{
"$ref":"GooglePrivacyDlpV2beta2ContentItem",
"description":"The item to re-identify. Will be treated as text."
},
"reidentifyConfig":{
"$ref":"GooglePrivacyDlpV2beta2DeidentifyConfig",
"description":"Configuration for the re-identification of the content item.\nThis field shares the same proto message type that is used for\nde-identification, however its usage here is for the reversal of the\nprevious de-identification. Re-identification is performed by examining\nthe transformations used to de-identify the items and executing the\nreverse. This requires that only reversible transformations\nbe provided here. The reversible transformations are:\n\n - `CryptoReplaceFfxFpeConfig`"
},
"reidentifyTemplateName":{
"description":"Optional template to use. References an instance of `DeidentifyTemplate`.\nAny configuration directly specified in `reidentify_config` or\n`inspect_config` will override those set in the template. Singular fields\nthat are set in this request will replace their corresponding fields in the\ntemplate. Repeated fields are appended. Singular sub-messages and groups\nare recursively merged.",
"description":"With this option a job is started a regular periodic basis. For\nexample: every 10 minutes.\n\nA scheduled start time will be skipped if the previous\nexecution has not ended when its scheduled time occurs.\n\nThis value must be set to a time duration greater than or equal\nto 60 minutes and can be no longer than 60 days.",
"description":"A collection that informs the user the number of times a particular\n`TransformationResultCode` and error details occurred.",
"id":"GooglePrivacyDlpV2beta2SummaryResult",
"properties":{
"code":{
"enum":[
"TRANSFORMATION_RESULT_CODE_UNSPECIFIED",
"SUCCESS",
"ERROR"
],
"enumDescriptions":[
"",
"",
""
],
"type":"string"
},
"count":{
"format":"int64",
"type":"string"
},
"details":{
"description":"A place for warnings or errors to show up if a transformation didn't\nwork as expected.",
"type":"string"
}
},
"type":"object"
},
"GooglePrivacyDlpV2beta2SurrogateType":{
"description":"Message for detecting output from deidentification transformations\nsuch as\n[`CryptoReplaceFfxFpeConfig`](/dlp/docs/reference/rest/v2beta1/content/deidentify#CryptoReplaceFfxFpeConfig).\nThese types of transformations are\nthose that perform pseudonymization, thereby producing a \"surrogate\" as\noutput. This should be used in conjunction with a field on the\ntransformation such as `surrogate_info_type`. This custom info type does\nnot support the use of `detection_rules`.",
"id":"GooglePrivacyDlpV2beta2SurrogateType",
"properties":{},
"type":"object"
},
"GooglePrivacyDlpV2beta2Table":{
"description":"Structured content to inspect. Up to 50,000 `Value`s per request allowed.",
"id":"GooglePrivacyDlpV2beta2Table",
"properties":{
"headers":{
"items":{
"$ref":"GooglePrivacyDlpV2beta2FieldId"
},
"type":"array"
},
"rows":{
"items":{
"$ref":"GooglePrivacyDlpV2beta2Row"
},
"type":"array"
}
},
"type":"object"
},
"GooglePrivacyDlpV2beta2TableLocation":{
"description":"Location of a finding within a table.",
"id":"GooglePrivacyDlpV2beta2TableLocation",
"properties":{
"rowIndex":{
"description":"The zero-based index of the row where the finding is located.",
"format":"int64",
"type":"string"
}
},
"type":"object"
},
"GooglePrivacyDlpV2beta2TaggedField":{
"description":"A column with a semantic tag attached.",
"id":"GooglePrivacyDlpV2beta2TaggedField",
"properties":{
"customTag":{
"description":"A column can be tagged with a custom tag. In this case, the user must\nindicate an auxiliary table that contains statistical information on\nthe possible values of this column (below).",
"description":"If no semantic tag is indicated, we infer the statistical model from\nthe distribution of values in the input data"
},
"infoType":{
"$ref":"GooglePrivacyDlpV2beta2InfoType",
"description":"A column can be tagged with a InfoType to use the relevant public\ndataset as a statistical model of population, if available. We\ncurrently support US ZIP codes, region codes, ages and genders.\nTo programmatically obtain the list of supported InfoTypes, use\nListInfoTypes with the supported_by=RISK_ANALYSIS filter."
}
},
"type":"object"
},
"GooglePrivacyDlpV2beta2TimePartConfig":{
"description":"For use with `Date`, `Timestamp`, and `TimeOfDay`, extract or preserve a\nportion of the value.",
"id":"GooglePrivacyDlpV2beta2TimePartConfig",
"properties":{
"partToExtract":{
"enum":[
"TIME_PART_UNSPECIFIED",
"YEAR",
"MONTH",
"DAY_OF_MONTH",
"DAY_OF_WEEK",
"WEEK_OF_YEAR",
"HOUR_OF_DAY"
],
"enumDescriptions":[
"",
"[0-9999]",
"[1-12]",
"[1-31]",
"[1-7]",
"[1-52]",
"[0-23]"
],
"type":"string"
}
},
"type":"object"
},
"GooglePrivacyDlpV2beta2TimeZone":{
"id":"GooglePrivacyDlpV2beta2TimeZone",
"properties":{
"offsetMinutes":{
"description":"Set only if the offset can be determined. Positive for time ahead of UTC.\nE.g. For \"UTC-9\", this value is -540.",
"format":"int32",
"type":"integer"
}
},
"type":"object"
},
"GooglePrivacyDlpV2beta2TimespanConfig":{
"description":"Configuration of the timespan of the items to include in scanning.\nCurrently only supported when inspecting Google Cloud Storage and BigQuery.",
"id":"GooglePrivacyDlpV2beta2TimespanConfig",
"properties":{
"enableAutoPopulationOfTimespanConfig":{
"description":"When the job is started by a JobTrigger we will automatically figure out\na valid start_time to avoid scanning files that have not been modified\nsince the last time the JobTrigger executed. This will be based on the\ntime of the execution of the last run of the JobTrigger.",
"description":"Set if the transformation was limited to a specific FieldId."
},
"fieldTransformations":{
"description":"The field transformation that was applied.\nIf multiple field transformations are requested for a single field,\nthis list will contain all of them; otherwise, only one is supplied.",
"description":"The specific transformation these stats apply to."
},
"transformedBytes":{
"description":"Total size in bytes that were transformed in some way.",
"format":"int64",
"type":"string"
}
},
"type":"object"
},
"GooglePrivacyDlpV2beta2TransientCryptoKey":{
"description":"Use this to have a random data crypto key generated.\nIt will be discarded after the request finishes.",
"id":"GooglePrivacyDlpV2beta2TransientCryptoKey",
"properties":{
"name":{
"description":"Name of the key. [required]\nThis is an arbitrary string used to differentiate different keys.\nA unique key is generated per name: two separate `TransientCryptoKey`\nprotos share the same generated key if their names are the same.\nWhen the data crypto key is generated, this name is not used in any way\n(repeating the api call will result in a different key being generated).",
"description":"Set of primitive values supported by the system.\nNote that for the purposes of inspection or transformation, the number\nof bytes considered to comprise a 'Value' is based on its representation\nas a UTF-8 encoded string. For example, if 'integer_value' is set to\n123456789, the number of bytes would be counted as 9, even though an\nint64 only holds up to 8 bytes of data.",
"description":"Message defining a list of words or phrases to search for in the data.",
"id":"GooglePrivacyDlpV2beta2WordList",
"properties":{
"words":{
"description":"Words or phrases defining the dictionary. The dictionary must contain\nat least one phrase and every phrase must contain at least 2 characters\nthat are letters or digits. [required]",
"description":"A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
"description":"The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"id":"GoogleRpcStatus",
"properties":{
"code":{
"description":"The status code, which should be an enum value of google.rpc.Code.",
"format":"int32",
"type":"integer"
},
"details":{
"description":"A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"items":{
"additionalProperties":{
"description":"Properties of the object. Contains field @type with type URL.",
"type":"any"
},
"type":"object"
},
"type":"array"
},
"message":{
"description":"A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
"description":"Represents a whole calendar date, e.g. date of birth. The time of day and\ntime zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. The day may be 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independent\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",
"id":"GoogleTypeDate",
"properties":{
"day":{
"description":"Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not significant.",
"format":"int32",
"type":"integer"
},
"month":{
"description":"Month of year. Must be from 1 to 12.",
"format":"int32",
"type":"integer"
},
"year":{
"description":"Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
"description":"Represents a time of day. The date and time zone are either not significant\nor are specified elsewhere. An API may choose to allow leap seconds. Related\ntypes are google.type.Date and `google.protobuf.Timestamp`.",
"id":"GoogleTypeTimeOfDay",
"properties":{
"hours":{
"description":"Hours of day in 24 hour format. Should be from 0 to 23. An API may choose\nto allow the value \"24:00:00\" for scenarios like business closing time.",
"format":"int32",
"type":"integer"
},
"minutes":{
"description":"Minutes of hour of day. Must be from 0 to 59.",
"format":"int32",
"type":"integer"
},
"nanos":{
"description":"Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.",
"format":"int32",
"type":"integer"
},
"seconds":{
"description":"Seconds of minutes of the time. Must normally be from 0 to 59. An API may\nallow the value 60 if it allows leap-seconds.",
