Blame - docs/dyn/dlp_v2.projects.locations.image.html - platform/external/python/google-api-python-client

<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.locations.html">locations</a> . <a href="dlp_v2.projects.locations.image.html">image</a></h1>

76

<h2>Instance Methods</h2>

77

78

<code><a href="#redact">redact(parent, locationId, body=None, x__xgafv=None)</a></code></p>

79

<p class="firstline">Redacts potentially sensitive info from an image.</p>

80

<h3>Method Details</h3>

81

82

<code class="details" id="redact">redact(parent, locationId, body=None, x__xgafv=None)</code>

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:

93

parent: string, The parent resource name, for example projects/my-project-id. (required)

94

locationId: string, The geographic location to process the request. Reserved for future

95

extensions.

96

Location is restricted to 'global', 'us', 'asia', and 'europe'. (required)

97

body: object, The request body.

98

The object takes the form of:

99

100

{ # Request to search for potentially sensitive info in an image and redact it

101

# by covering it with a colored rectangle.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame^]

102

"imageRedactionConfigs": [ # The configuration for specifying what content to redact from images.

103

{ # Configuration for determining how redaction of images should occur.

104

"infoType": { # Type of information detected by the API. # Only one per info_type should be provided per request. If not

105

# specified, and redact_all_text is false, the DLP API will redact all

106

# text that it matches against all info_types that are found, but not

107

# specified in another ImageRedactionConfig.

108

"name": "A String", # Name of the information type. Either a name of your choosing when

109

# creating a CustomInfoType, or one of the names listed

110

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

111

# a built-in type. InfoType names should conform to the pattern

112

# `[a-zA-Z0-9_]{1,64}`.

113

},

114

"redactionColor": { # Represents a color in the RGB color space. # The color to use when redacting content from an image. If not specified,

115

# the default is black.

116

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

117

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

118

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

119

},

120

"redactAllText": True or False, # If true, all text found in the image, regardless whether it matches an

121

# info_type, is redacted. Only one should be provided.

122

},

123

],

124

"locationId": "A String", # The geographic location to process the request. Reserved for future

125

# extensions.

126

# Location is restricted to 'global', 'us', 'asia', and 'europe'.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

127

"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]

128

"data": "A String", # Content data to inspect or redact.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame^]

129

"type": "A String", # The type of data stored in the bytes string. Default will be TEXT_UTF8.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

130

},

131

"includeFindings": True or False, # Whether the response should include findings along with the redacted

132

# image.

133

"inspectConfig": { # Configuration description of the scanning process. # Configuration for the inspector.

134

# When used with redactContent only info_types and min_likelihood are currently

135

# used.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame^]

136

"minLikelihood": "A String", # Only returns findings equal or above this threshold. The default is

137

# POSSIBLE.

138

# See https://cloud.google.com/dlp/docs/likelihood to learn more.

139

"contentOptions": [ # List of options defining data content to scan.

140

# If empty, text, images, and other content will be included.

141

"A String",

142

],

143

"infoTypes": [ # Restricts what info_types to look for. The values must correspond to

144

# InfoType values returned by ListInfoTypes or listed at

145

# https://cloud.google.com/dlp/docs/infotypes-reference.

146

#

147

# When no InfoTypes or CustomInfoTypes are specified in a request, the

148

# system may automatically choose what detectors to run. By default this may

149

# be all types, but may change over time as detectors are updated.

150

#

151

# If you need precise control and predictability as to what detectors are

152

# run you should specify specific InfoTypes listed in the reference,

153

# otherwise a default list will be used, which may change over time.

154

{ # Type of information detected by the API.

155

"name": "A String", # Name of the information type. Either a name of your choosing when

156

# creating a CustomInfoType, or one of the names listed

157

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

158

# a built-in type. InfoType names should conform to the pattern

159

# `[a-zA-Z0-9_]{1,64}`.

160

},

161

],

162

"excludeInfoTypes": True or False, # When true, excludes type information of the findings.

163

"customInfoTypes": [ # CustomInfoTypes provided by the user. See

164

# https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more.

165

{ # Custom information type provided by the user. Used to find domain-specific

166

# sensitive information configurable to the data in question.

167

"surrogateType": { # Message for detecting output from deidentification transformations # Message for detecting output from deidentification transformations that

168

# support reversing.

169

# such as

170

# [`CryptoReplaceFfxFpeConfig`](/dlp/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig).

171

# These types of transformations are

172

# those that perform pseudonymization, thereby producing a "surrogate" as

173

# output. This should be used in conjunction with a field on the

174

# transformation such as `surrogate_info_type`. This CustomInfoType does

175

# not support the use of `detection_rules`.

176

},

177

"likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be

178

# altered by a detection rule if the finding meets the criteria specified by

179

# the rule. Defaults to `VERY_LIKELY` if not specified.

180

"infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in

181

# infoType, when the name matches one of existing infoTypes and that infoType

182

# is specified in `InspectContent.info_types` field. Specifying the latter

183

# adds findings to the one detected by the system. If built-in info type is

184

# not specified in `InspectContent.info_types` list then the name is treated

185

# as a custom info type.

186

"name": "A String", # Name of the information type. Either a name of your choosing when

187

# creating a CustomInfoType, or one of the names listed

188

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

189

# a built-in type. InfoType names should conform to the pattern

190

# `[a-zA-Z0-9_]{1,64}`.

191

},

192

"regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType.

193

"groupIndexes": [ # The index of the submatch to extract as findings. When not

194

# specified, the entire match is returned. No more than 3 may be included.

195

42,

196

],

197

"pattern": "A String", # Pattern defining the regular expression. Its syntax

198

# (https://github.com/google/re2/wiki/Syntax) can be found under the

199

# google/re2 repository on GitHub.

200

},

201

"detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType.

202

# Rules are applied in order that they are specified. Not supported for the

203

# `surrogate_type` CustomInfoType.

204

{ # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a

205

# `CustomInfoType` to alter behavior under certain circumstances, depending

206

# on the specific details of the rule. Not supported for the `surrogate_type`

207

# custom infoType.

208

"hotwordRule": { # The rule that adjusts the likelihood of findings within a certain # Hotword-based detection rule.

209

# proximity of hotwords.

210

"likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as # Likelihood adjustment to apply to all matching findings.

211

# part of a detection rule.

212

"relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of

213

# levels. For example, if a finding would be `POSSIBLE` without the

214

# detection rule and `relative_likelihood` is 1, then it is upgraded to

215

# `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`.

216

# Likelihood may never drop below `VERY_UNLIKELY` or exceed

217

# `VERY_LIKELY`, so applying an adjustment of 1 followed by an

218

# adjustment of -1 when base likelihood is `VERY_LIKELY` will result in

219

# a final likelihood of `LIKELY`.

220

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value.

221

},

222

"hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword.

223

"groupIndexes": [ # The index of the submatch to extract as findings. When not

224

# specified, the entire match is returned. No more than 3 may be included.

225

42,

226

],

227

"pattern": "A String", # Pattern defining the regular expression. Its syntax

228

# (https://github.com/google/re2/wiki/Syntax) can be found under the

229

# google/re2 repository on GitHub.

230

},

231

"proximity": { # Message for specifying a window around a finding to apply a detection # Proximity of the finding within which the entire hotword must reside.

232

# The total length of the window cannot exceed 1000 characters. Note that

233

# the finding itself will be included in the window, so that hotwords may

234

# be used to match substrings of the finding itself. For example, the

235

# certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be

236

# adjusted upwards if the area code is known to be the local area code of

237

# a company office using the hotword regex "\(xxx\)", where "xxx"

238

# is the area code in question.

239

# rule.

240

"windowBefore": 42, # Number of characters before the finding to consider.

241

"windowAfter": 42, # Number of characters after the finding to consider.

},

},

},

],

"exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding

247

# to be returned. It still can be used for rules matching.

248

"dictionary": { # Custom information type based on a dictionary of words or phrases. This can # A list of phrases to detect as a CustomInfoType.

249

# be used to match sensitive information specific to the data, such as a list

250

# of employee IDs or job titles.

251

#

252

# Dictionary words are case-insensitive and all characters other than letters

253

# and digits in the unicode [Basic Multilingual

254

# Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane)

255

# will be replaced with whitespace when scanning for matches, so the

256

# dictionary phrase "Sam Johnson" will match all three phrases "sam johnson",

257

# "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters

258

# surrounding any match must be of a different type than the adjacent

259

# characters within the word, so letters must be next to non-letters and

260

# digits next to non-digits. For example, the dictionary word "jen" will

261

# match the first three letters of the text "jen123" but will return no

262

# matches for "jennifer".

263

#

264

# Dictionary words containing a large number of characters that are not

265

# letters or digits may result in unexpected findings because such characters

266

# are treated as whitespace. The

267

# [limits](https://cloud.google.com/dlp/limits) page contains details about

268

# the size limits of dictionaries. For dictionaries that do not fit within

269

# these constraints, consider using `LargeCustomDictionaryConfig` in the

270

# `StoredInfoType` API.

271

"wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for.

272

"words": [ # Words or phrases defining the dictionary. The dictionary must contain

273

# at least one phrase and every phrase must contain at least 2 characters

274

# that are letters or digits. [required]

"A String",

],

},

"cloudStoragePath": { # Message representing a single file or path in Cloud Storage. # Newline-delimited file of words in Cloud Storage. Only a single file

279

# is accepted.

280

"path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage.

281

# Example: gs://[BUCKET_NAME]/dictionary.txt

282

},

283

},

284

"storedType": { # A reference to a StoredInfoType to use with scanning. # Load an existing `StoredInfoType` resource for use in

285

# `InspectDataSource`. Not currently supported in `InspectContent`.

286

"name": "A String", # Resource name of the requested `StoredInfoType`, for example

287

# `organizations/433245324/storedInfoTypes/432452342` or

288

# `projects/project-id/storedInfoTypes/432452342`.

289

"createTime": "A String", # Timestamp indicating when the version of the `StoredInfoType` used for

290

# inspection was created. Output-only field, populated by the system.

291

},

292

},

293

],

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

294

"includeQuote": True or False, # When true, a contextual quote from the data that triggered a finding is

295

# included in the response; see Finding.quote.

296

"ruleSet": [ # Set of rules to apply to the findings for this InspectConfig.

297

# Exclusion rules, contained in the set are executed in the end, other

298

# rules are executed in the order they are specified for each info type.

299

{ # Rule set for modifying a set of infoTypes to alter behavior under certain

300

# circumstances, depending on the specific details of the rules within the set.

301

"infoTypes": [ # List of infoTypes this rule set is applied to.

302

{ # Type of information detected by the API.

303

"name": "A String", # Name of the information type. Either a name of your choosing when

304

# creating a CustomInfoType, or one of the names listed

305

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

306

# a built-in type. InfoType names should conform to the pattern

307

# `[a-zA-Z0-9_]{1,64}`.

308

},

309

],

310

"rules": [ # Set of rules to be applied to infoTypes. The rules are applied in order.

311

{ # A single inspection rule to be applied to infoTypes, specified in

312

# `InspectionRuleSet`.

313

"hotwordRule": { # The rule that adjusts the likelihood of findings within a certain # Hotword-based detection rule.

314

# proximity of hotwords.

315

"likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as # Likelihood adjustment to apply to all matching findings.

316

# part of a detection rule.

317

"relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of

318

# levels. For example, if a finding would be `POSSIBLE` without the

319

# detection rule and `relative_likelihood` is 1, then it is upgraded to

320

# `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`.

321

# Likelihood may never drop below `VERY_UNLIKELY` or exceed

322

# `VERY_LIKELY`, so applying an adjustment of 1 followed by an

323

# adjustment of -1 when base likelihood is `VERY_LIKELY` will result in

324

# a final likelihood of `LIKELY`.

325

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value.

326

},

327

"hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword.

328

"groupIndexes": [ # The index of the submatch to extract as findings. When not

329

# specified, the entire match is returned. No more than 3 may be included.

330

42,

331

],

332

"pattern": "A String", # Pattern defining the regular expression. Its syntax

333

# (https://github.com/google/re2/wiki/Syntax) can be found under the

334

# google/re2 repository on GitHub.

335

},

336

"proximity": { # Message for specifying a window around a finding to apply a detection # Proximity of the finding within which the entire hotword must reside.

337

# The total length of the window cannot exceed 1000 characters. Note that

338

# the finding itself will be included in the window, so that hotwords may

339

# be used to match substrings of the finding itself. For example, the

340

# certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be

341

# adjusted upwards if the area code is known to be the local area code of

342

# a company office using the hotword regex "\(xxx\)", where "xxx"

343

# is the area code in question.

344

# rule.

345

"windowBefore": 42, # Number of characters before the finding to consider.

346

"windowAfter": 42, # Number of characters after the finding to consider.

347

},

348

},

349

"exclusionRule": { # The rule that specifies conditions when findings of infoTypes specified in # Exclusion rule.

350

# `InspectionRuleSet` are removed from results.

351

"dictionary": { # Custom information type based on a dictionary of words or phrases. This can # Dictionary which defines the rule.

352

# be used to match sensitive information specific to the data, such as a list

353

# of employee IDs or job titles.

354

#

355

# Dictionary words are case-insensitive and all characters other than letters

356

# and digits in the unicode [Basic Multilingual

357

# Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane)

358

# will be replaced with whitespace when scanning for matches, so the

359

# dictionary phrase "Sam Johnson" will match all three phrases "sam johnson",

360

# "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters

361

# surrounding any match must be of a different type than the adjacent

362

# characters within the word, so letters must be next to non-letters and

363

# digits next to non-digits. For example, the dictionary word "jen" will

364

# match the first three letters of the text "jen123" but will return no

365

# matches for "jennifer".

366

#

367

# Dictionary words containing a large number of characters that are not

368

# letters or digits may result in unexpected findings because such characters

369

# are treated as whitespace. The

370

# [limits](https://cloud.google.com/dlp/limits) page contains details about

371

# the size limits of dictionaries. For dictionaries that do not fit within

372

# these constraints, consider using `LargeCustomDictionaryConfig` in the

373

# `StoredInfoType` API.

374

"wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for.

375

"words": [ # Words or phrases defining the dictionary. The dictionary must contain

376

# at least one phrase and every phrase must contain at least 2 characters

377

# that are letters or digits. [required]

"A String",

],

},

"cloudStoragePath": { # Message representing a single file or path in Cloud Storage. # Newline-delimited file of words in Cloud Storage. Only a single file

382

# is accepted.

383

"path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage.

384

# Example: gs://[BUCKET_NAME]/dictionary.txt

385

},

386

},

387

"regex": { # Message defining a custom regular expression. # Regular expression which defines the rule.

388

"groupIndexes": [ # The index of the submatch to extract as findings. When not

389

# specified, the entire match is returned. No more than 3 may be included.

390

42,

391

],

392

"pattern": "A String", # Pattern defining the regular expression. Its syntax

393

# (https://github.com/google/re2/wiki/Syntax) can be found under the

394

# google/re2 repository on GitHub.

395

},

396

"excludeInfoTypes": { # List of exclude infoTypes. # Set of infoTypes for which findings would affect this rule.

397

"infoTypes": [ # InfoType list in ExclusionRule rule drops a finding when it overlaps or

398

# contained within with a finding of an infoType from this list. For

399

# example, for `InspectionRuleSet.info_types` containing "PHONE_NUMBER"` and

400

# `exclusion_rule` containing `exclude_info_types.info_types` with

401

# "EMAIL_ADDRESS" the phone number findings are dropped if they overlap

402

# with EMAIL_ADDRESS finding.

403

# That leads to "555-222-2222@example.org" to generate only a single

404

# finding, namely email address.

405

{ # Type of information detected by the API.

406

"name": "A String", # Name of the information type. Either a name of your choosing when

407

# creating a CustomInfoType, or one of the names listed

408

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

409

# a built-in type. InfoType names should conform to the pattern

410

# `[a-zA-Z0-9_]{1,64}`.

},

],

},

"matchingType": "A String", # How the rule is applied, see MatchingType documentation for details.

},

},

],

},

],

"limits": { # Configuration to control the number of findings returned. # Configuration to control the number of findings returned.

421

"maxFindingsPerItem": 42, # Max number of findings that will be returned for each item scanned.

422

# When set within `InspectJobConfig`,

423

# the maximum returned is 2000 regardless if this is set higher.

424

# When set within `InspectContentRequest`, this field is ignored.

425

"maxFindingsPerInfoType": [ # Configuration of findings limit given for specified infoTypes.

426

{ # Max findings configuration per infoType, per content item or long

427

# running DlpJob.

428

"maxFindings": 42, # Max findings limit for the given infoType.

429

"infoType": { # Type of information detected by the API. # Type of information the findings limit applies to. Only one limit per

430

# info_type should be provided. If InfoTypeLimit does not have an

431

# info_type, the DLP API applies the limit against all info_types that

432

# are found but not specified in another InfoTypeLimit.

433

"name": "A String", # Name of the information type. Either a name of your choosing when

434

# creating a CustomInfoType, or one of the names listed

435

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

436

# a built-in type. InfoType names should conform to the pattern

437

# `[a-zA-Z0-9_]{1,64}`.

},

},

],

"maxFindingsPerRequest": 42, # Max number of findings that will be returned per request/job.

442

# When set within `InspectContentRequest`, the maximum returned is 2000

443

# regardless if this is set higher.

444

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

445

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

446

}

447

448

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

455

456

{ # Results of redacting an image.

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.

460

{ # Represents a piece of potentially sensitive content.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

461

"quoteInfo": { # Message for infoType-dependent details parsed from quote. # Contains data parsed from quotes. Only populated if include_quote was set

462

# to true and a supported infoType was requested. Currently supported

463

# infoTypes: DATE, DATE_OF_BIRTH and TIME.

464

"dateTime": { # Message for a date time object. # The date time indicated by the quote.

465

# e.g. 2018-01-01, 5th August.

466

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

467

# Must be a valid date or time value.

468

# and time zone are either specified elsewhere or are not significant. The date

469

# is relative to the Proleptic Gregorian Calendar. This can represent:

470

#

471

# * A full date, with non-zero year, month and day values

472

# * A month and day value, with a zero year, e.g. an anniversary

473

# * A year on its own, with zero month and day values

474

# * A year and month value, with a zero day, e.g. a credit card expiration date

475

#

476

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

477

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

478

# a year.

479

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

480

# month and day.

481

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

482

# if specifying a year by itself or a year and month where the day is not

483

# significant.

484

},

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

"dayOfWeek": "A String", # Day of week

490

"time": { # Represents a time of day. The date and time zone are either not significant # Time of day

491

# or are specified elsewhere. An API may choose to allow leap seconds. Related

492

# types are google.type.Date and `google.protobuf.Timestamp`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

493

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

494

# to allow the value "24:00:00" for scenarios like business closing time.

495

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame^]

496

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

497

# allow the value 60 if it allows leap-seconds.

498

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

499

},

500

},

501

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame^]

502

"infoType": { # Type of information detected by the API. # The type of content that might have been found.

503

# Provided if `excluded_types` is false.

504

"name": "A String", # Name of the information type. Either a name of your choosing when

505

# creating a CustomInfoType, or one of the names listed

506

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

507

# a built-in type. InfoType names should conform to the pattern

508

# `[a-zA-Z0-9_]{1,64}`.

509

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

510

"labels": { # The labels associated with this `Finding`.

511

#

512

# Label keys must be between 1 and 63 characters long and must conform

513

# to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.

514

#

515

# Label values must be between 0 and 63 characters long and must conform

516

# to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.

517

#

518

# No more than 10 labels can be associated with a given finding.

519

#

520

# Examples:

521

# * `"environment" : "production"`

522

# * `"pipeline" : "etl"`

523

"a_key": "A String",

524

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

525

"likelihood": "A String", # Confidence of how likely it is that the `info_type` is correct.

526

"name": "A String", # Resource name in format

527

# projects/{project}/locations/{location}/findings/{finding} Populated only

528

# when viewing persisted findings.

529

"location": { # Specifies the location of the finding. # Where the content was found.

530

"codepointRange": { # Generic half-open interval [start, end) # Unicode character offsets delimiting the finding.

531

# These are relative to the finding's containing element.

532

# Provided when the content is text.

533

"start": "A String", # Index of the first character of the range (inclusive).

534

"end": "A String", # Index of the last character of the range (exclusive).

535

},

536

"byteRange": { # Generic half-open interval [start, end) # Zero-based byte offsets delimiting the finding.

537

# These are relative to the finding's containing element.

538

# Note that when the content is not textual, this references

539

# the UTF-8 encoded textual representation of the content.

540

# Omitted if content is an image.

541

"start": "A String", # Index of the first character of the range (inclusive).

542

"end": "A String", # Index of the last character of the range (exclusive).

543

},

544

"container": { # Represents a container that may contain DLP findings. # Information about the container where this finding occurred, if available.

545

# Examples of a container include a file, table, or database record.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

546

"updateTime": "A String", # Findings container modification timestamp, if applicable.

547

# For Google Cloud Storage contains last file modification timestamp.

548

# For BigQuery table contains last_modified_time property.

549

# For Datastore - not populated.

550

"rootPath": "A String", # The root of the container.

551

# Examples:

552

# - For BigQuery table `project_id:dataset_id.table_id`, the root is

553

# `dataset_id`

554

# - For Google Cloud Storage file `gs://bucket/folder/filename.txt`, the root

555

# is `gs://bucket`

556

"projectId": "A String", # Project where the finding was found.

557

# Can be different from the project that owns the finding.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame^]

558

"version": "A String", # Findings container version, if available

559

# ("generation" for Google Cloud Storage).

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

560

"relativePath": "A String", # The rest of the path after the root.

561

# Examples:

562

# - For BigQuery table `project_id:dataset_id.table_id`, the relative path is

563

# `table_id`

564

# - Google Cloud Storage file `gs://bucket/folder/filename.txt`, the relative

565

# path is `folder/filename.txt`

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame^]

566

"fullPath": "A String", # A string representation of the full container name.

567

# Examples:

568

# - BigQuery: 'Project:DataSetId.TableId'

569

# - Google Cloud Storage: 'gs://Bucket/folders/filename.txt'

570

"type": "A String", # Container type, for example BigQuery or Google Cloud Storage.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

571

},

572

"contentLocations": [ # List of nested objects pointing to the precise location of the finding

573

# within the file or record.

574

{ # Precise location of the finding within a document, record, image, or metadata

575

# container.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame^]

576

"containerVersion": "A String", # Findings container version, if available

577

# ("generation" for Google Cloud Storage).

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

578

"containerName": "A String", # Name of the container where the finding is located.

579

# The top level name is the source file name or table name. Names of some

580

# common storage containers are formatted as follows:

581

#

582

# * BigQuery tables: `{project_id}:{dataset_id}.{table_id}`

583

# * Cloud Storage files: `gs://{bucket}/{path}`

584

# * Datastore namespace: {namespace}

585

#

586

# Nested names could be absent if the embedded object has no string

587

# identifier (for an example an image contained within a document).

588

"documentLocation": { # Location of a finding within a document. # Location data for document files.

589

"fileOffset": "A String", # Offset of the line, from the beginning of the file, where the finding

590

# is located.

591

},

592

"recordLocation": { # Location of a finding within a row or record. # Location within a row or record of a database table.

593

"fieldId": { # General identifier of a data field in a storage service. # Field id of the field containing the finding.

594

"name": "A String", # Name describing the field.

595

},

596

"tableLocation": { # Location of a finding within a table. # Location within a `ContentItem.Table`.

597

"rowIndex": "A String", # The zero-based index of the row where the finding is located. Only

598

# populated for resources that have a natural ordering, not BigQuery. In

599

# BigQuery, to identify the row a finding came from, populate

600

# BigQueryOptions.identifying_fields with your primary key column names and

601

# when you store the findings the value of those columns will be stored

602

# inside of Finding.

603

},

604

"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]

605

"datastoreKey": { # Record key for a finding in Cloud Datastore.

606

"entityKey": { # A unique identifier for a Datastore entity. # Datastore entity key.

607

# If a key's partition ID or any of its path kinds or names are

608

# reserved/read-only, the key is reserved/read-only.

609

# A reserved/read-only key is forbidden in certain documented contexts.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame^]

610

"partitionId": { # Datastore partition ID. # Entities are partitioned into subsets, currently identified by a project

611

# ID and namespace ID.

612

# Queries are scoped to a single partition.

613

# A partition ID identifies a grouping of entities. The grouping is always

614

# by project and namespace, however the namespace ID may be empty.

615

#

616

# A partition ID contains several dimensions:

617

# project ID and namespace ID.

618

"projectId": "A String", # The ID of the project to which the entities belong.

619

"namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.

620

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

621

"path": [ # The entity path.

622

# An entity path consists of one or more elements composed of a kind and a

623

# string or numerical identifier, which identify entities. The first

624

# element identifies a _root entity_, the second element identifies

625

# a _child_ of the root entity, the third element identifies a child of the

626

# second entity, and so forth. The entities identified by all prefixes of

627

# the path are called the element's _ancestors_.

628

#

629

# A path can never be empty, and a path can have at most 100 elements.

630

{ # A (kind, ID/name) pair used to construct a key path.

631

#

632

# If either name or ID is set, the element is complete.

633

# If neither is set, the element is incomplete.

634

"kind": "A String", # The kind of the entity.

635

# A kind matching regex `__.*__` is reserved/read-only.

636

# A kind must not contain more than 1500 bytes when UTF-8 encoded.

637

# Cannot be `""`.

638

"id": "A String", # The auto-allocated ID of the entity.

639

# Never equal to zero. Values less than zero are discouraged and may not

640

# be supported in the future.

641

"name": "A String", # The name of the entity.

642

# A name matching regex `__.*__` is reserved/read-only.

643

# A name must not be more than 1500 bytes when UTF-8 encoded.

644

# Cannot be `""`.

645

},

646

],

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

647

},

648

},

649

"bigQueryKey": { # Row key for identifying a record in BigQuery table.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame^]

650

"rowNumber": "A String", # Row number inferred at the time the table was scanned. This value is

651

# nondeterministic, cannot be queried, and may be null for inspection

652

# jobs. To locate findings within a table, specify

653

# `inspect_job.storage_config.big_query_options.identifying_fields` in

654

# `CreateDlpJobRequest`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

655

"tableReference": { # Message defining the location of a BigQuery table. A table is uniquely # Complete BigQuery table reference.

656

# identified by its project_id, dataset_id, and table_name. Within a query

657

# a table is often referenced with a string in the format of:

658

# `<project_id>:<dataset_id>.<table_id>` or

659

# `<project_id>.<dataset_id>.<table_id>`.

660

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table.

661

# If omitted, project ID is inferred from the API call.

662

"datasetId": "A String", # Dataset ID of the table.

663

"tableId": "A String", # Name of the table.

664

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

665

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame^]

666

"idValues": [ # Values of identifying columns in the given row. Order of values matches

667

# the order of `identifying_fields` specified in the scanning request.

668

"A String",

669

],

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

670

},

671

},

672

"containerTimestamp": "A String", # Findings container modification timestamp, if applicable.

673

# For Google Cloud Storage contains last file modification timestamp.

674

# For BigQuery table contains last_modified_time property.

675

# For Datastore - not populated.

676

"metadataLocation": { # Metadata Location # Location within the metadata for inspected content.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame^]

677

"type": "A String", # Type of metadata containing the finding.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

678

"storageLabel": { # Storage metadata label to indicate which metadata entry contains findings. # Storage metadata.

679

"key": "A String",

680

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

681

},

682

"imageLocation": { # Location of the finding within an image. # Location within an image's pixels.

683

"boundingBoxes": [ # Bounding boxes locating the pixels within the image containing the finding.

684

{ # Bounding box encompassing detected text within an image.

685

"top": 42, # Top coordinate of the bounding box. (0,0) is upper left.

686

"width": 42, # Width of the bounding box in pixels.

687

"height": 42, # Height of the bounding box in pixels.

688

"left": 42, # Left coordinate of the bounding box. (0,0) is upper left.

689

},

690

],

691

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"quote": "A String", # The content that was found. Even if the content is not textual, it

696

# may be converted to a textual representation here.

697

# Provided if `include_quote` is true and the finding is

698

# less than or equal to 4096 bytes long. If the finding exceeds 4096 bytes

699

# in length, the quote may be omitted.

700

"createTime": "A String", # Timestamp when finding was detected.

701

"jobName": "A String", # The job that stored the finding.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame^]

702

"jobCreateTime": "A String", # Time the job started that produced this finding.

703

"triggerName": "A String", # Job trigger name, if applicable, for this finding.

704

"resourceName": "A String", # The job that stored the finding.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

705

},

706

],

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.

713

},

714

"extractedText": "A String", # If an image was being inspected and the InspectConfig's include_quote was

715

# set to true, then this field will include all text, if any, that was found

# in the image.

}</pre>

</div>

</body></html>