| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="dlp_v2.html">Cloud Data Loss Prevention (DLP) API</a> . <a href="dlp_v2.projects.html">projects</a> . <a href="dlp_v2.projects.image.html">image</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 78 | <code><a href="#redact">redact(parent, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 79 | <p class="firstline">Redacts potentially sensitive info from an image.</p> |
| 80 | <h3>Method Details</h3> |
| 81 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 82 | <code class="details" id="redact">redact(parent, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 83 | <pre>Redacts potentially sensitive info from an image. |
| 84 | This method has limits on input size, processing time, and output size. |
| 85 | See https://cloud.google.com/dlp/docs/redacting-sensitive-data-images to |
| 86 | learn more. |
| 87 | |
| 88 | When no InfoTypes or CustomInfoTypes are specified in this request, the |
| 89 | system will automatically choose what detectors to run. By default this may |
| 90 | be all types, but may change over time as detectors are updated. |
| 91 | |
| 92 | Args: |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 93 | parent: string, The parent resource name. |
| 94 | - Format:projects/[PROJECT-ID] |
| 95 | - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 96 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 97 | The object takes the form of: |
| 98 | |
| 99 | { # Request to search for potentially sensitive info in an image and redact it |
| 100 | # by covering it with a colored rectangle. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 101 | "byteItem": { # Container for bytes to inspect or redact. # The content must be PNG, JPEG, SVG or BMP. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 102 | "data": "A String", # Content data to inspect or redact. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 103 | "type": "A String", # The type of data stored in the bytes string. Default will be TEXT_UTF8. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 104 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 105 | "inspectConfig": { # Configuration description of the scanning process. # Configuration for the inspector. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 106 | # When used with redactContent only info_types and min_likelihood are currently |
| 107 | # used. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 108 | "customInfoTypes": [ # CustomInfoTypes provided by the user. See |
| 109 | # https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more. |
| 110 | { # Custom information type provided by the user. Used to find domain-specific |
| 111 | # sensitive information configurable to the data in question. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 112 | "dictionary": { # Custom information type based on a dictionary of words or phrases. This can # A list of phrases to detect as a CustomInfoType. |
| 113 | # be used to match sensitive information specific to the data, such as a list |
| 114 | # of employee IDs or job titles. |
| 115 | # |
| 116 | # Dictionary words are case-insensitive and all characters other than letters |
| 117 | # and digits in the unicode [Basic Multilingual |
| 118 | # Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) |
| 119 | # will be replaced with whitespace when scanning for matches, so the |
| 120 | # dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", |
| 121 | # "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters |
| 122 | # surrounding any match must be of a different type than the adjacent |
| 123 | # characters within the word, so letters must be next to non-letters and |
| 124 | # digits next to non-digits. For example, the dictionary word "jen" will |
| 125 | # match the first three letters of the text "jen123" but will return no |
| 126 | # matches for "jennifer". |
| 127 | # |
| 128 | # Dictionary words containing a large number of characters that are not |
| 129 | # letters or digits may result in unexpected findings because such characters |
| 130 | # are treated as whitespace. The |
| 131 | # [limits](https://cloud.google.com/dlp/limits) page contains details about |
| 132 | # the size limits of dictionaries. For dictionaries that do not fit within |
| 133 | # these constraints, consider using `LargeCustomDictionaryConfig` in the |
| 134 | # `StoredInfoType` API. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 135 | "cloudStoragePath": { # Message representing a single file or path in Cloud Storage. # Newline-delimited file of words in Cloud Storage. Only a single file |
| 136 | # is accepted. |
| 137 | "path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. |
| 138 | # Example: gs://[BUCKET_NAME]/dictionary.txt |
| 139 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 140 | "wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for. |
| 141 | "words": [ # Words or phrases defining the dictionary. The dictionary must contain |
| 142 | # at least one phrase and every phrase must contain at least 2 characters |
| 143 | # that are letters or digits. [required] |
| 144 | "A String", |
| 145 | ], |
| 146 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 147 | }, |
| 148 | "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in |
| 149 | # infoType, when the name matches one of existing infoTypes and that infoType |
| 150 | # is specified in `InspectContent.info_types` field. Specifying the latter |
| 151 | # adds findings to the one detected by the system. If built-in info type is |
| 152 | # not specified in `InspectContent.info_types` list then the name is treated |
| 153 | # as a custom info type. |
| 154 | "name": "A String", # Name of the information type. Either a name of your choosing when |
| 155 | # creating a CustomInfoType, or one of the names listed |
| 156 | # at https://cloud.google.com/dlp/docs/infotypes-reference when specifying |
| 157 | # a built-in type. When sending Cloud DLP results to Data Catalog, infoType |
| 158 | # names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`. |
| 159 | }, |
| 160 | "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be |
| 161 | # altered by a detection rule if the finding meets the criteria specified by |
| 162 | # the rule. Defaults to `VERY_LIKELY` if not specified. |
| 163 | "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. |
| 164 | # Rules are applied in order that they are specified. Not supported for the |
| 165 | # `surrogate_type` CustomInfoType. |
| 166 | { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a |
| 167 | # `CustomInfoType` to alter behavior under certain circumstances, depending |
| 168 | # on the specific details of the rule. Not supported for the `surrogate_type` |
| 169 | # custom infoType. |
| 170 | "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain # Hotword-based detection rule. |
| 171 | # proximity of hotwords. |
| 172 | "proximity": { # Message for specifying a window around a finding to apply a detection # Proximity of the finding within which the entire hotword must reside. |
| 173 | # The total length of the window cannot exceed 1000 characters. Note that |
| 174 | # the finding itself will be included in the window, so that hotwords may |
| 175 | # be used to match substrings of the finding itself. For example, the |
| 176 | # certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be |
| 177 | # adjusted upwards if the area code is known to be the local area code of |
| 178 | # a company office using the hotword regex "\(xxx\)", where "xxx" |
| 179 | # is the area code in question. |
| 180 | # rule. |
| 181 | "windowAfter": 42, # Number of characters after the finding to consider. |
| 182 | "windowBefore": 42, # Number of characters before the finding to consider. |
| 183 | }, |
| 184 | "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as # Likelihood adjustment to apply to all matching findings. |
| 185 | # part of a detection rule. |
| 186 | "fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. |
| 187 | "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of |
| 188 | # levels. For example, if a finding would be `POSSIBLE` without the |
| 189 | # detection rule and `relative_likelihood` is 1, then it is upgraded to |
| 190 | # `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. |
| 191 | # Likelihood may never drop below `VERY_UNLIKELY` or exceed |
| 192 | # `VERY_LIKELY`, so applying an adjustment of 1 followed by an |
| 193 | # adjustment of -1 when base likelihood is `VERY_LIKELY` will result in |
| 194 | # a final likelihood of `LIKELY`. |
| 195 | }, |
| 196 | "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. |
| 197 | "groupIndexes": [ # The index of the submatch to extract as findings. When not |
| 198 | # specified, the entire match is returned. No more than 3 may be included. |
| 199 | 42, |
| 200 | ], |
| 201 | "pattern": "A String", # Pattern defining the regular expression. Its syntax |
| 202 | # (https://github.com/google/re2/wiki/Syntax) can be found under the |
| 203 | # google/re2 repository on GitHub. |
| 204 | }, |
| 205 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 206 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 207 | ], |
| 208 | "surrogateType": { # Message for detecting output from deidentification transformations # Message for detecting output from deidentification transformations that |
| 209 | # support reversing. |
| 210 | # such as |
| 211 | # [`CryptoReplaceFfxFpeConfig`](https://cloud.google.com/dlp/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig). |
| 212 | # These types of transformations are |
| 213 | # those that perform pseudonymization, thereby producing a "surrogate" as |
| 214 | # output. This should be used in conjunction with a field on the |
| 215 | # transformation such as `surrogate_info_type`. This CustomInfoType does |
| 216 | # not support the use of `detection_rules`. |
| 217 | }, |
| 218 | "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. |
| 219 | "groupIndexes": [ # The index of the submatch to extract as findings. When not |
| 220 | # specified, the entire match is returned. No more than 3 may be included. |
| 221 | 42, |
| 222 | ], |
| 223 | "pattern": "A String", # Pattern defining the regular expression. Its syntax |
| 224 | # (https://github.com/google/re2/wiki/Syntax) can be found under the |
| 225 | # google/re2 repository on GitHub. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 226 | }, |
| 227 | "storedType": { # A reference to a StoredInfoType to use with scanning. # Load an existing `StoredInfoType` resource for use in |
| 228 | # `InspectDataSource`. Not currently supported in `InspectContent`. |
| 229 | "name": "A String", # Resource name of the requested `StoredInfoType`, for example |
| 230 | # `organizations/433245324/storedInfoTypes/432452342` or |
| 231 | # `projects/project-id/storedInfoTypes/432452342`. |
| 232 | "createTime": "A String", # Timestamp indicating when the version of the `StoredInfoType` used for |
| 233 | # inspection was created. Output-only field, populated by the system. |
| 234 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 235 | "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding |
| 236 | # to be returned. It still can be used for rules matching. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 237 | }, |
| 238 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 239 | "minLikelihood": "A String", # Only returns findings equal or above this threshold. The default is |
| 240 | # POSSIBLE. |
| 241 | # See https://cloud.google.com/dlp/docs/likelihood to learn more. |
| 242 | "limits": { # Configuration to control the number of findings returned. # Configuration to control the number of findings returned. |
| 243 | "maxFindingsPerRequest": 42, # Max number of findings that will be returned per request/job. |
| 244 | # When set within `InspectContentRequest`, the maximum returned is 2000 |
| 245 | # regardless if this is set higher. |
| 246 | "maxFindingsPerInfoType": [ # Configuration of findings limit given for specified infoTypes. |
| 247 | { # Max findings configuration per infoType, per content item or long |
| 248 | # running DlpJob. |
| 249 | "infoType": { # Type of information detected by the API. # Type of information the findings limit applies to. Only one limit per |
| 250 | # info_type should be provided. If InfoTypeLimit does not have an |
| 251 | # info_type, the DLP API applies the limit against all info_types that |
| 252 | # are found but not specified in another InfoTypeLimit. |
| 253 | "name": "A String", # Name of the information type. Either a name of your choosing when |
| 254 | # creating a CustomInfoType, or one of the names listed |
| 255 | # at https://cloud.google.com/dlp/docs/infotypes-reference when specifying |
| 256 | # a built-in type. When sending Cloud DLP results to Data Catalog, infoType |
| 257 | # names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`. |
| 258 | }, |
| 259 | "maxFindings": 42, # Max findings limit for the given infoType. |
| 260 | }, |
| 261 | ], |
| 262 | "maxFindingsPerItem": 42, # Max number of findings that will be returned for each item scanned. |
| 263 | # When set within `InspectJobConfig`, |
| 264 | # the maximum returned is 2000 regardless if this is set higher. |
| 265 | # When set within `InspectContentRequest`, this field is ignored. |
| 266 | }, |
| 267 | "excludeInfoTypes": True or False, # When true, excludes type information of the findings. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 268 | "includeQuote": True or False, # When true, a contextual quote from the data that triggered a finding is |
| 269 | # included in the response; see Finding.quote. |
| 270 | "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. |
| 271 | # Exclusion rules, contained in the set are executed in the end, other |
| 272 | # rules are executed in the order they are specified for each info type. |
| 273 | { # Rule set for modifying a set of infoTypes to alter behavior under certain |
| 274 | # circumstances, depending on the specific details of the rules within the set. |
| 275 | "infoTypes": [ # List of infoTypes this rule set is applied to. |
| 276 | { # Type of information detected by the API. |
| 277 | "name": "A String", # Name of the information type. Either a name of your choosing when |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 278 | # creating a CustomInfoType, or one of the names listed |
| 279 | # at https://cloud.google.com/dlp/docs/infotypes-reference when specifying |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 280 | # a built-in type. When sending Cloud DLP results to Data Catalog, infoType |
| 281 | # names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 282 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 283 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 284 | "rules": [ # Set of rules to be applied to infoTypes. The rules are applied in order. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 285 | { # A single inspection rule to be applied to infoTypes, specified in |
| 286 | # `InspectionRuleSet`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 287 | "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain # Hotword-based detection rule. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 288 | # proximity of hotwords. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 289 | "proximity": { # Message for specifying a window around a finding to apply a detection # Proximity of the finding within which the entire hotword must reside. |
| 290 | # The total length of the window cannot exceed 1000 characters. Note that |
| 291 | # the finding itself will be included in the window, so that hotwords may |
| 292 | # be used to match substrings of the finding itself. For example, the |
| 293 | # certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be |
| 294 | # adjusted upwards if the area code is known to be the local area code of |
| 295 | # a company office using the hotword regex "\(xxx\)", where "xxx" |
| 296 | # is the area code in question. |
| 297 | # rule. |
| 298 | "windowAfter": 42, # Number of characters after the finding to consider. |
| 299 | "windowBefore": 42, # Number of characters before the finding to consider. |
| 300 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 301 | "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as # Likelihood adjustment to apply to all matching findings. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 302 | # part of a detection rule. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 303 | "fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 304 | "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 305 | # levels. For example, if a finding would be `POSSIBLE` without the |
| 306 | # detection rule and `relative_likelihood` is 1, then it is upgraded to |
| 307 | # `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. |
| 308 | # Likelihood may never drop below `VERY_UNLIKELY` or exceed |
| 309 | # `VERY_LIKELY`, so applying an adjustment of 1 followed by an |
| 310 | # adjustment of -1 when base likelihood is `VERY_LIKELY` will result in |
| 311 | # a final likelihood of `LIKELY`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 312 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 313 | "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. |
| 314 | "groupIndexes": [ # The index of the submatch to extract as findings. When not |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 315 | # specified, the entire match is returned. No more than 3 may be included. |
| 316 | 42, |
| 317 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 318 | "pattern": "A String", # Pattern defining the regular expression. Its syntax |
| 319 | # (https://github.com/google/re2/wiki/Syntax) can be found under the |
| 320 | # google/re2 repository on GitHub. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 321 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 322 | }, |
| 323 | "exclusionRule": { # The rule that specifies conditions when findings of infoTypes specified in # Exclusion rule. |
| 324 | # `InspectionRuleSet` are removed from results. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 325 | "matchingType": "A String", # How the rule is applied, see MatchingType documentation for details. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 326 | "dictionary": { # Custom information type based on a dictionary of words or phrases. This can # Dictionary which defines the rule. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 327 | # be used to match sensitive information specific to the data, such as a list |
| 328 | # of employee IDs or job titles. |
| 329 | # |
| 330 | # Dictionary words are case-insensitive and all characters other than letters |
| 331 | # and digits in the unicode [Basic Multilingual |
| 332 | # Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) |
| 333 | # will be replaced with whitespace when scanning for matches, so the |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 334 | # dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", |
| 335 | # "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 336 | # surrounding any match must be of a different type than the adjacent |
| 337 | # characters within the word, so letters must be next to non-letters and |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 338 | # digits next to non-digits. For example, the dictionary word "jen" will |
| 339 | # match the first three letters of the text "jen123" but will return no |
| 340 | # matches for "jennifer". |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 341 | # |
| 342 | # Dictionary words containing a large number of characters that are not |
| 343 | # letters or digits may result in unexpected findings because such characters |
| 344 | # are treated as whitespace. The |
| 345 | # [limits](https://cloud.google.com/dlp/limits) page contains details about |
| 346 | # the size limits of dictionaries. For dictionaries that do not fit within |
| 347 | # these constraints, consider using `LargeCustomDictionaryConfig` in the |
| 348 | # `StoredInfoType` API. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 349 | "cloudStoragePath": { # Message representing a single file or path in Cloud Storage. # Newline-delimited file of words in Cloud Storage. Only a single file |
| 350 | # is accepted. |
| 351 | "path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. |
| 352 | # Example: gs://[BUCKET_NAME]/dictionary.txt |
| 353 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 354 | "wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for. |
| 355 | "words": [ # Words or phrases defining the dictionary. The dictionary must contain |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 356 | # at least one phrase and every phrase must contain at least 2 characters |
| 357 | # that are letters or digits. [required] |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 358 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 359 | ], |
| 360 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 361 | }, |
| 362 | "excludeInfoTypes": { # List of exclude infoTypes. # Set of infoTypes for which findings would affect this rule. |
| 363 | "infoTypes": [ # InfoType list in ExclusionRule rule drops a finding when it overlaps or |
| 364 | # contained within with a finding of an infoType from this list. For |
| 365 | # example, for `InspectionRuleSet.info_types` containing "PHONE_NUMBER"` and |
| 366 | # `exclusion_rule` containing `exclude_info_types.info_types` with |
| 367 | # "EMAIL_ADDRESS" the phone number findings are dropped if they overlap |
| 368 | # with EMAIL_ADDRESS finding. |
| 369 | # That leads to "555-222-2222@example.org" to generate only a single |
| 370 | # finding, namely email address. |
| 371 | { # Type of information detected by the API. |
| 372 | "name": "A String", # Name of the information type. Either a name of your choosing when |
| 373 | # creating a CustomInfoType, or one of the names listed |
| 374 | # at https://cloud.google.com/dlp/docs/infotypes-reference when specifying |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 375 | # a built-in type. When sending Cloud DLP results to Data Catalog, infoType |
| 376 | # names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 377 | }, |
| 378 | ], |
| 379 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 380 | "regex": { # Message defining a custom regular expression. # Regular expression which defines the rule. |
| 381 | "groupIndexes": [ # The index of the submatch to extract as findings. When not |
| 382 | # specified, the entire match is returned. No more than 3 may be included. |
| 383 | 42, |
| 384 | ], |
| 385 | "pattern": "A String", # Pattern defining the regular expression. Its syntax |
| 386 | # (https://github.com/google/re2/wiki/Syntax) can be found under the |
| 387 | # google/re2 repository on GitHub. |
| 388 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 389 | }, |
| 390 | }, |
| 391 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 392 | }, |
| 393 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 394 | "contentOptions": [ # List of options defining data content to scan. |
| 395 | # If empty, text, images, and other content will be included. |
| 396 | "A String", |
| 397 | ], |
| 398 | "infoTypes": [ # Restricts what info_types to look for. The values must correspond to |
| 399 | # InfoType values returned by ListInfoTypes or listed at |
| 400 | # https://cloud.google.com/dlp/docs/infotypes-reference. |
| 401 | # |
| 402 | # When no InfoTypes or CustomInfoTypes are specified in a request, the |
| 403 | # system may automatically choose what detectors to run. By default this may |
| 404 | # be all types, but may change over time as detectors are updated. |
| 405 | # |
| 406 | # If you need precise control and predictability as to what detectors are |
| 407 | # run you should specify specific InfoTypes listed in the reference, |
| 408 | # otherwise a default list will be used, which may change over time. |
| 409 | { # Type of information detected by the API. |
| 410 | "name": "A String", # Name of the information type. Either a name of your choosing when |
| 411 | # creating a CustomInfoType, or one of the names listed |
| 412 | # at https://cloud.google.com/dlp/docs/infotypes-reference when specifying |
| 413 | # a built-in type. When sending Cloud DLP results to Data Catalog, infoType |
| 414 | # names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`. |
| 415 | }, |
| 416 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 417 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 418 | "imageRedactionConfigs": [ # The configuration for specifying what content to redact from images. |
| 419 | { # Configuration for determining how redaction of images should occur. |
| 420 | "redactAllText": True or False, # If true, all text found in the image, regardless whether it matches an |
| 421 | # info_type, is redacted. Only one should be provided. |
| 422 | "redactionColor": { # Represents a color in the RGB color space. # The color to use when redacting content from an image. If not specified, |
| 423 | # the default is black. |
| 424 | "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1]. |
| 425 | "green": 3.14, # The amount of green in the color as a value in the interval [0, 1]. |
| 426 | "red": 3.14, # The amount of red in the color as a value in the interval [0, 1]. |
| 427 | }, |
| 428 | "infoType": { # Type of information detected by the API. # Only one per info_type should be provided per request. If not |
| 429 | # specified, and redact_all_text is false, the DLP API will redact all |
| 430 | # text that it matches against all info_types that are found, but not |
| 431 | # specified in another ImageRedactionConfig. |
| 432 | "name": "A String", # Name of the information type. Either a name of your choosing when |
| 433 | # creating a CustomInfoType, or one of the names listed |
| 434 | # at https://cloud.google.com/dlp/docs/infotypes-reference when specifying |
| 435 | # a built-in type. When sending Cloud DLP results to Data Catalog, infoType |
| 436 | # names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`. |
| 437 | }, |
| 438 | }, |
| 439 | ], |
| 440 | "includeFindings": True or False, # Whether the response should include findings along with the redacted |
| 441 | # image. |
| 442 | "locationId": "A String", # Deprecated. This field has no effect. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 443 | } |
| 444 | |
| 445 | x__xgafv: string, V1 error format. |
| 446 | Allowed values |
| 447 | 1 - v1 error format |
| 448 | 2 - v2 error format |
| 449 | |
| 450 | Returns: |
| 451 | An object of the form: |
| 452 | |
| 453 | { # Results of redacting an image. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 454 | "extractedText": "A String", # If an image was being inspected and the InspectConfig's include_quote was |
| 455 | # set to true, then this field will include all text, if any, that was found |
| 456 | # in the image. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 457 | "redactedImage": "A String", # The redacted image. The type will be the same as the original image. |
| 458 | "inspectResult": { # All the findings for a single scanned item. # The findings. Populated when include_findings in the request is true. |
| 459 | "findings": [ # List of findings for an item. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 460 | { # Represents a piece of potentially sensitive content. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 461 | "labels": { # The labels associated with this `Finding`. |
| 462 | # |
| 463 | # Label keys must be between 1 and 63 characters long and must conform |
| 464 | # to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. |
| 465 | # |
| 466 | # Label values must be between 0 and 63 characters long and must conform |
| 467 | # to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. |
| 468 | # |
| 469 | # No more than 10 labels can be associated with a given finding. |
| 470 | # |
| 471 | # Examples: |
| 472 | # * `"environment" : "production"` |
| 473 | # * `"pipeline" : "etl"` |
| 474 | "a_key": "A String", |
| 475 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 476 | "triggerName": "A String", # Job trigger name, if applicable, for this finding. |
| 477 | "resourceName": "A String", # The job that stored the finding. |
| 478 | "jobCreateTime": "A String", # Time the job started that produced this finding. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 479 | "likelihood": "A String", # Confidence of how likely it is that the `info_type` is correct. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 480 | "quoteInfo": { # Message for infoType-dependent details parsed from quote. # Contains data parsed from quotes. Only populated if include_quote was set |
| 481 | # to true and a supported infoType was requested. Currently supported |
| 482 | # infoTypes: DATE, DATE_OF_BIRTH and TIME. |
| 483 | "dateTime": { # Message for a date time object. # The date time indicated by the quote. |
| 484 | # e.g. 2018-01-01, 5th August. |
| 485 | "timeZone": { # Time zone of the date time object. # Time zone |
| 486 | "offsetMinutes": 42, # Set only if the offset can be determined. Positive for time ahead of UTC. |
| 487 | # E.g. For "UTC-9", this value is -540. |
| 488 | }, |
| 489 | "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # One or more of the following must be set. |
| 490 | # Must be a valid date or time value. |
| 491 | # and time zone are either specified elsewhere or are not significant. The date |
| 492 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 493 | # |
| 494 | # * A full date, with non-zero year, month and day values |
| 495 | # * A month and day value, with a zero year, e.g. an anniversary |
| 496 | # * A year on its own, with zero month and day values |
| 497 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 498 | # |
| 499 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 500 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 501 | # month and day. |
| 502 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 503 | # a year. |
| 504 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 505 | # if specifying a year by itself or a year and month where the day is not |
| 506 | # significant. |
| 507 | }, |
| 508 | "dayOfWeek": "A String", # Day of week |
| 509 | "time": { # Represents a time of day. The date and time zone are either not significant # Time of day |
| 510 | # or are specified elsewhere. An API may choose to allow leap seconds. Related |
| 511 | # types are google.type.Date and `google.protobuf.Timestamp`. |
| 512 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may |
| 513 | # allow the value 60 if it allows leap-seconds. |
| 514 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 515 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 516 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose |
| 517 | # to allow the value "24:00:00" for scenarios like business closing time. |
| 518 | }, |
| 519 | }, |
| 520 | }, |
| 521 | "infoType": { # Type of information detected by the API. # The type of content that might have been found. |
| 522 | # Provided if `excluded_types` is false. |
| 523 | "name": "A String", # Name of the information type. Either a name of your choosing when |
| 524 | # creating a CustomInfoType, or one of the names listed |
| 525 | # at https://cloud.google.com/dlp/docs/infotypes-reference when specifying |
| 526 | # a built-in type. When sending Cloud DLP results to Data Catalog, infoType |
| 527 | # names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`. |
| 528 | }, |
| 529 | "quote": "A String", # The content that was found. Even if the content is not textual, it |
| 530 | # may be converted to a textual representation here. |
| 531 | # Provided if `include_quote` is true and the finding is |
| 532 | # less than or equal to 4096 bytes long. If the finding exceeds 4096 bytes |
| 533 | # in length, the quote may be omitted. |
| 534 | "jobName": "A String", # The job that stored the finding. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 535 | "location": { # Specifies the location of the finding. # Where the content was found. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 536 | "contentLocations": [ # List of nested objects pointing to the precise location of the finding |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 537 | # within the file or record. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 538 | { # Precise location of the finding within a document, record, image, or metadata |
| 539 | # container. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 540 | "containerTimestamp": "A String", # Findings container modification timestamp, if applicable. |
| 541 | # For Google Cloud Storage contains last file modification timestamp. |
| 542 | # For BigQuery table contains last_modified_time property. |
| 543 | # For Datastore - not populated. |
| 544 | "imageLocation": { # Location of the finding within an image. # Location within an image's pixels. |
| 545 | "boundingBoxes": [ # Bounding boxes locating the pixels within the image containing the finding. |
| 546 | { # Bounding box encompassing detected text within an image. |
| 547 | "left": 42, # Left coordinate of the bounding box. (0,0) is upper left. |
| 548 | "top": 42, # Top coordinate of the bounding box. (0,0) is upper left. |
| 549 | "width": 42, # Width of the bounding box in pixels. |
| 550 | "height": 42, # Height of the bounding box in pixels. |
| 551 | }, |
| 552 | ], |
| 553 | }, |
| 554 | "metadataLocation": { # Metadata Location # Location within the metadata for inspected content. |
| 555 | "type": "A String", # Type of metadata containing the finding. |
| 556 | "storageLabel": { # Storage metadata label to indicate which metadata entry contains findings. # Storage metadata. |
| 557 | "key": "A String", |
| 558 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 559 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 560 | "recordLocation": { # Location of a finding within a row or record. # Location within a row or record of a database table. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 561 | "recordKey": { # Message for a unique key indicating a record that contains a finding. # Key of the finding. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 562 | "bigQueryKey": { # Row key for identifying a record in BigQuery table. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 563 | "rowNumber": "A String", # Row number inferred at the time the table was scanned. This value is |
| 564 | # nondeterministic, cannot be queried, and may be null for inspection |
| 565 | # jobs. To locate findings within a table, specify |
| 566 | # `inspect_job.storage_config.big_query_options.identifying_fields` in |
| 567 | # `CreateDlpJobRequest`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 568 | "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely # Complete BigQuery table reference. |
| 569 | # identified by its project_id, dataset_id, and table_name. Within a query |
| 570 | # a table is often referenced with a string in the format of: |
| 571 | # `<project_id>:<dataset_id>.<table_id>` or |
| 572 | # `<project_id>.<dataset_id>.<table_id>`. |
| 573 | "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. |
| 574 | # If omitted, project ID is inferred from the API call. |
| 575 | "datasetId": "A String", # Dataset ID of the table. |
| 576 | "tableId": "A String", # Name of the table. |
| 577 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 578 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 579 | "idValues": [ # Values of identifying columns in the given row. Order of values matches |
| 580 | # the order of `identifying_fields` specified in the scanning request. |
| 581 | "A String", |
| 582 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 583 | "datastoreKey": { # Record key for a finding in Cloud Datastore. |
| 584 | "entityKey": { # A unique identifier for a Datastore entity. # Datastore entity key. |
| 585 | # If a key's partition ID or any of its path kinds or names are |
| 586 | # reserved/read-only, the key is reserved/read-only. |
| 587 | # A reserved/read-only key is forbidden in certain documented contexts. |
| 588 | "path": [ # The entity path. |
| 589 | # An entity path consists of one or more elements composed of a kind and a |
| 590 | # string or numerical identifier, which identify entities. The first |
| 591 | # element identifies a _root entity_, the second element identifies |
| 592 | # a _child_ of the root entity, the third element identifies a child of the |
| 593 | # second entity, and so forth. The entities identified by all prefixes of |
| 594 | # the path are called the element's _ancestors_. |
| 595 | # |
| 596 | # A path can never be empty, and a path can have at most 100 elements. |
| 597 | { # A (kind, ID/name) pair used to construct a key path. |
| 598 | # |
| 599 | # If either name or ID is set, the element is complete. |
| 600 | # If neither is set, the element is incomplete. |
| 601 | "kind": "A String", # The kind of the entity. |
| 602 | # A kind matching regex `__.*__` is reserved/read-only. |
| 603 | # A kind must not contain more than 1500 bytes when UTF-8 encoded. |
| 604 | # Cannot be `""`. |
| 605 | "name": "A String", # The name of the entity. |
| 606 | # A name matching regex `__.*__` is reserved/read-only. |
| 607 | # A name must not be more than 1500 bytes when UTF-8 encoded. |
| 608 | # Cannot be `""`. |
| 609 | "id": "A String", # The auto-allocated ID of the entity. |
| 610 | # Never equal to zero. Values less than zero are discouraged and may not |
| 611 | # be supported in the future. |
| 612 | }, |
| 613 | ], |
| 614 | "partitionId": { # Datastore partition ID. # Entities are partitioned into subsets, currently identified by a project |
| 615 | # ID and namespace ID. |
| 616 | # Queries are scoped to a single partition. |
| 617 | # A partition ID identifies a grouping of entities. The grouping is always |
| 618 | # by project and namespace, however the namespace ID may be empty. |
| 619 | # |
| 620 | # A partition ID contains several dimensions: |
| 621 | # project ID and namespace ID. |
| 622 | "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. |
| 623 | "projectId": "A String", # The ID of the project to which the entities belong. |
| 624 | }, |
| 625 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 626 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 627 | }, |
| 628 | "tableLocation": { # Location of a finding within a table. # Location within a `ContentItem.Table`. |
| 629 | "rowIndex": "A String", # The zero-based index of the row where the finding is located. Only |
| 630 | # populated for resources that have a natural ordering, not BigQuery. In |
| 631 | # BigQuery, to identify the row a finding came from, populate |
| 632 | # BigQueryOptions.identifying_fields with your primary key column names and |
| 633 | # when you store the findings the value of those columns will be stored |
| 634 | # inside of Finding. |
| 635 | }, |
| 636 | "fieldId": { # General identifier of a data field in a storage service. # Field id of the field containing the finding. |
| 637 | "name": "A String", # Name describing the field. |
| 638 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 639 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 640 | "containerName": "A String", # Name of the container where the finding is located. |
| 641 | # The top level name is the source file name or table name. Names of some |
| 642 | # common storage containers are formatted as follows: |
| 643 | # |
| 644 | # * BigQuery tables: `{project_id}:{dataset_id}.{table_id}` |
| 645 | # * Cloud Storage files: `gs://{bucket}/{path}` |
| 646 | # * Datastore namespace: {namespace} |
| 647 | # |
| 648 | # Nested names could be absent if the embedded object has no string |
| 649 | # identifier (for an example an image contained within a document). |
| 650 | "documentLocation": { # Location of a finding within a document. # Location data for document files. |
| 651 | "fileOffset": "A String", # Offset of the line, from the beginning of the file, where the finding |
| 652 | # is located. |
| 653 | }, |
| 654 | "containerVersion": "A String", # Findings container version, if available |
| 655 | # ("generation" for Google Cloud Storage). |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 656 | }, |
| 657 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 658 | "container": { # Represents a container that may contain DLP findings. # Information about the container where this finding occurred, if available. |
| 659 | # Examples of a container include a file, table, or database record. |
| 660 | "updateTime": "A String", # Findings container modification timestamp, if applicable. |
| 661 | # For Google Cloud Storage contains last file modification timestamp. |
| 662 | # For BigQuery table contains last_modified_time property. |
| 663 | # For Datastore - not populated. |
| 664 | "projectId": "A String", # Project where the finding was found. |
| 665 | # Can be different from the project that owns the finding. |
| 666 | "rootPath": "A String", # The root of the container. |
| 667 | # Examples: |
| 668 | # - For BigQuery table `project_id:dataset_id.table_id`, the root is |
| 669 | # `dataset_id` |
| 670 | # - For Google Cloud Storage file `gs://bucket/folder/filename.txt`, the root |
| 671 | # is `gs://bucket` |
| 672 | "version": "A String", # Findings container version, if available |
| 673 | # ("generation" for Google Cloud Storage). |
| 674 | "fullPath": "A String", # A string representation of the full container name. |
| 675 | # Examples: |
| 676 | # - BigQuery: 'Project:DataSetId.TableId' |
| 677 | # - Google Cloud Storage: 'gs://Bucket/folders/filename.txt' |
| 678 | "type": "A String", # Container type, for example BigQuery or Google Cloud Storage. |
| 679 | "relativePath": "A String", # The rest of the path after the root. |
| 680 | # Examples: |
| 681 | # - For BigQuery table `project_id:dataset_id.table_id`, the relative path is |
| 682 | # `table_id` |
| 683 | # - Google Cloud Storage file `gs://bucket/folder/filename.txt`, the relative |
| 684 | # path is `folder/filename.txt` |
| 685 | }, |
| 686 | "codepointRange": { # Generic half-open interval [start, end) # Unicode character offsets delimiting the finding. |
| 687 | # These are relative to the finding's containing element. |
| 688 | # Provided when the content is text. |
| 689 | "end": "A String", # Index of the last character of the range (exclusive). |
| 690 | "start": "A String", # Index of the first character of the range (inclusive). |
| 691 | }, |
| 692 | "byteRange": { # Generic half-open interval [start, end) # Zero-based byte offsets delimiting the finding. |
| 693 | # These are relative to the finding's containing element. |
| 694 | # Note that when the content is not textual, this references |
| 695 | # the UTF-8 encoded textual representation of the content. |
| 696 | # Omitted if content is an image. |
| 697 | "end": "A String", # Index of the last character of the range (exclusive). |
| 698 | "start": "A String", # Index of the first character of the range (inclusive). |
| 699 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 700 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 701 | "name": "A String", # Resource name in format |
| 702 | # projects/{project}/locations/{location}/findings/{finding} Populated only |
| 703 | # when viewing persisted findings. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 704 | "createTime": "A String", # Timestamp when finding was detected. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 705 | }, |
| 706 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 707 | "findingsTruncated": True or False, # If true, then this item might have more findings than were returned, |
| 708 | # and the findings returned are an arbitrary subset of all findings. |
| 709 | # The findings list might be truncated because the input items were too |
| 710 | # large, or because the server reached the maximum amount of resources |
| 711 | # allowed for a single API call. For best results, divide the input into |
| 712 | # smaller batches. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 713 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 714 | }</pre> |
| 715 | </div> |
| 716 | |
| 717 | </body></html> |