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