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

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

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

Dan O'Meara

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

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:

93

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

94

body: object, The request body.

Bu Sun Kim

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

Bu Sun Kim

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

[diff] [blame]

99

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

100

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

101

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

102

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

103

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

104

# specified in another ImageRedactionConfig.

105

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

106

# creating a CustomInfoType, or one of the names listed

107

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

108

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

109

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

110

},

111

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

112

# the default is black.

113

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

114

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

115

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

116

},

117

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

118

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

119

},

120

],

121

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

122

# extensions.

123

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

Bu Sun Kim

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

[diff] [blame]

124

"byteItem": { # Container for bytes to inspect or redact. # The content must be PNG, JPEG, SVG or BMP.

Bu Sun Kim

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

[diff] [blame]

125

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

Bu Sun Kim

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

[diff] [blame]

126

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

127

},

Bu Sun Kim

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

[diff] [blame]

128

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

129

# image.

130

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

131

# When used with redactContent only info_types and min_likelihood are currently

132

# used.

Bu Sun Kim

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

[diff] [blame]

133

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

134

# POSSIBLE.

135

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

136

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

137

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

138

"A String",

139

],

140

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

141

# InfoType values returned by ListInfoTypes or listed at

142

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

143

#

144

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

145

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

146

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

147

#

148

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

149

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

150

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

151

{ # Type of information detected by the API.

152

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

153

# creating a CustomInfoType, or one of the names listed

154

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

155

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

156

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

157

},

158

],

159

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

160

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

161

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

162

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

163

# sensitive information configurable to the data in question.

164

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

165

# support reversing.

166

# such as

167

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

168

# These types of transformations are

169

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

170

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

171

# transformation such as `surrogate_info_type`. This CustomInfoType does

172

# not support the use of `detection_rules`.

173

},

174

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

175

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

176

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

177

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

178

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

179

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

180

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

181

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

182

# as a custom info type.

183

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

184

# creating a CustomInfoType, or one of the names listed

185

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

186

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

187

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

188

},

189

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

190

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

191

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

192

42,

193

],

194

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

195

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

196

# google/re2 repository on GitHub.

197

},

198

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

199

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

200

# `surrogate_type` CustomInfoType.

201

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

202

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

203

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

204

# custom infoType.

205

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

206

# proximity of hotwords.

207

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

208

# part of a detection rule.

209

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

210

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

211

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

212

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

213

# Likelihood may never drop below `VERY_UNLIKELY` or exceed

214

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

215

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

216

# a final likelihood of `LIKELY`.

217

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

218

},

219

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

220

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

221

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

222

42,

223

],

224

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

225

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

226

# google/re2 repository on GitHub.

227

},

228

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

229

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

230

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

231

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

232

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

233

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

234

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

235

# is the area code in question.

236

# rule.

237

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

238

"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

244

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

245

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

246

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

247

# of employee IDs or job titles.

248

#

249

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

250

# and digits in the unicode [Basic Multilingual

251

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

252

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

253

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

254

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

255

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

256

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

257

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

258

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

259

# matches for "jennifer".

260

#

261

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

262

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

263

# are treated as whitespace. The

264

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

265

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

266

# these constraints, consider using `LargeCustomDictionaryConfig` in the

267

# `StoredInfoType` API.

268

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

269

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

270

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

271

# 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

276

# is accepted.

277

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

278

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

279

},

280

},

281

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

282

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

283

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

284

# `organizations/433245324/storedInfoTypes/432452342` or

285

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

286

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

287

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

288

},

289

},

290

],

Bu Sun Kim

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

[diff] [blame]

291

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

292

# included in the response; see Finding.quote.

293

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

294

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

295

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

296

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

297

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

298

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

299

{ # Type of information detected by the API.

300

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

301

# creating a CustomInfoType, or one of the names listed

302

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

303

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

304

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

305

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

306

],

Bu Sun Kim

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

[diff] [blame]

307

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

308

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

309

# `InspectionRuleSet`.

Bu Sun Kim

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

[diff] [blame]

310

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

311

# proximity of hotwords.

Bu Sun Kim

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

[diff] [blame]

312

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

313

# part of a detection rule.

Bu Sun Kim

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

[diff] [blame]

314

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

315

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

316

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

317

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

318

# Likelihood may never drop below `VERY_UNLIKELY` or exceed

319

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

320

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

321

# a final likelihood of `LIKELY`.

Bu Sun Kim

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

[diff] [blame]

322

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

323

},

Bu Sun Kim

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

[diff] [blame]

324

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

325

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

326

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

327

42,

328

],

Bu Sun Kim

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

[diff] [blame]

329

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

330

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

331

# google/re2 repository on GitHub.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

332

},

Bu Sun Kim

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

[diff] [blame]

333

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

334

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

335

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

336

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

337

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

338

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

339

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

340

# is the area code in question.

341

# rule.

342

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

343

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

344

},

Bu Sun Kim

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

[diff] [blame]

345

},

346

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

347

# `InspectionRuleSet` are removed from results.

348

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

349

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

350

# of employee IDs or job titles.

351

#

352

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

353

# and digits in the unicode [Basic Multilingual

354

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

355

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

Bu Sun Kim

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

[diff] [blame]

356

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

357

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

358

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

359

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

Bu Sun Kim

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

[diff] [blame]

360

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

361

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

362

# matches for "jennifer".

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

363

#

364

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

365

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

366

# are treated as whitespace. The

367

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

368

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

369

# these constraints, consider using `LargeCustomDictionaryConfig` in the

370

# `StoredInfoType` API.

Bu Sun Kim

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

[diff] [blame]

371

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

372

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

373

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

374

# that are letters or digits. [required]

Bu Sun Kim

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

[diff] [blame]

375

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

376

],

377

},

Bu Sun Kim

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

[diff] [blame]

378

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

379

# is accepted.

Bu Sun Kim

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

[diff] [blame]

380

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

381

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

382

},

383

},

Bu Sun Kim

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

[diff] [blame]

384

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

385

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

386

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

387

42,

388

],

389

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

390

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

391

# google/re2 repository on GitHub.

392

},

393

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

394

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

395

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

396

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

397

# `exclusion_rule` containing `exclude_info_types.info_types` with

398

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

399

# with EMAIL_ADDRESS finding.

400

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

401

# finding, namely email address.

402

{ # Type of information detected by the API.

403

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

404

# creating a CustomInfoType, or one of the names listed

405

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

406

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

407

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

},

],

},

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

412

},

413

},

414

],

Bu Sun Kim

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

[diff] [blame]

415

},

416

],

417

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

418

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

419

# When set within `InspectJobConfig`,

420

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

421

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

422

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

423

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

424

# running DlpJob.

425

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

426

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

427

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

428

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

429

# are found but not specified in another InfoTypeLimit.

430

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

431

# creating a CustomInfoType, or one of the names listed

432

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

433

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

434

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

435

},

Bu Sun Kim

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

[diff] [blame]

436

},

437

],

438

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

439

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

440

# regardless if this is set higher.

441

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

442

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

443

}

444

445

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

452

453

{ # Results of redacting an image.

Bu Sun Kim

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

[diff] [blame]

454

"redactedImage": "A String", # The redacted image. The type will be the same as the original image.

455

"inspectResult": { # All the findings for a single scanned item. # The findings. Populated when include_findings in the request is true.

456

"findings": [ # List of findings for an item.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

457

{ # Represents a piece of potentially sensitive content.

Bu Sun Kim

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

[diff] [blame]

458

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

459

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

460

# infoTypes: DATE, DATE_OF_BIRTH and TIME.

Bu Sun Kim

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

[diff] [blame]

461

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

462

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

Bu Sun Kim

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

[diff] [blame]

463

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

464

# Must be a valid date or time value.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

465

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

466

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

467

#

468

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

469

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

470

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

471

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

472

#

473

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

Bu Sun Kim

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

[diff] [blame]

474

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

475

# a year.

476

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

477

# month and day.

Bu Sun Kim

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

[diff] [blame]

478

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

479

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

480

# significant.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

481

},

Bu Sun Kim

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

[diff] [blame]

482

"timeZone": { # Time zone of the date time object. # Time zone

483

"offsetMinutes": 42, # Set only if the offset can be determined. Positive for time ahead of UTC.

484

# E.g. For "UTC-9", this value is -540.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

485

},

Bu Sun Kim

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

[diff] [blame]

486

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

487

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

488

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

489

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

Bu Sun Kim

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

[diff] [blame]

490

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

491

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

492

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

Bu Sun Kim

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

[diff] [blame]

493

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

494

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

495

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

496

},

497

},

498

},

Bu Sun Kim

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

[diff] [blame]

499

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

500

# Provided if `excluded_types` is false.

501

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

502

# creating a CustomInfoType, or one of the names listed

503

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

504

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

505

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

506

},

Bu Sun Kim

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

[diff] [blame]

507

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

508

#

509

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

510

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

511

#

512

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

513

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

514

#

515

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

516

#

517

# Examples:

518

# * `"environment" : "production"`

519

# * `"pipeline" : "etl"`

520

"a_key": "A String",

521

},

Bu Sun Kim

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

[diff] [blame]

522

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

523

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

524

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

525

# when viewing persisted findings.

526

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

527

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

528

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

529

# Provided when the content is text.

Bu Sun Kim

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

[diff] [blame]

530

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

531

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

532

},

Bu Sun Kim

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

[diff] [blame]

533

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

534

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

535

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

536

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

537

# Omitted if content is an image.

538

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

539

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

540

},

541

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

542

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

Bu Sun Kim

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

[diff] [blame]

543

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

544

# For Google Cloud Storage contains last file modification timestamp.

545

# For BigQuery table contains last_modified_time property.

546

# For Datastore - not populated.

Bu Sun Kim

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

[diff] [blame]

547

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

548

# Examples:

549

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

550

# `dataset_id`

551

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

552

# is `gs://bucket`

Bu Sun Kim

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

[diff] [blame]

553

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

554

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

Bu Sun Kim

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

[diff] [blame]

555

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

556

# ("generation" for Google Cloud Storage).

Bu Sun Kim

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

[diff] [blame]

557

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

558

# Examples:

Bu Sun Kim

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

[diff] [blame]

559

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

560

# `table_id`

561

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

562

# path is `folder/filename.txt`

Bu Sun Kim

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

[diff] [blame]

563

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

564

# Examples:

565

# - BigQuery: 'Project:DataSetId.TableId'

566

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

567

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

568

},

Bu Sun Kim

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

[diff] [blame]

569

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

570

# within the file or record.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

571

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

572

# container.

Bu Sun Kim

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

[diff] [blame]

573

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

574

# ("generation" for Google Cloud Storage).

Bu Sun Kim

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

[diff] [blame]

575

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

576

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

577

# common storage containers are formatted as follows:

578

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

579

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

580

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

581

# * Datastore namespace: {namespace}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

582

#

583

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

584

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

Bu Sun Kim

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

[diff] [blame]

585

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

586

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

587

# is located.

588

},

Bu Sun Kim

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

[diff] [blame]

589

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

590

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

591

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

592

},

593

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

594

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

595

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

596

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

597

# BigQueryOptions.identifying_fields with your primary key column names and

598

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

599

# inside of Finding.

600

},

Bu Sun Kim

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

[diff] [blame]

601

"recordKey": { # Message for a unique key indicating a record that contains a finding. # Key of the finding.

Bu Sun Kim

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

[diff] [blame]

602

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

603

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

604

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

605

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

606

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

Bu Sun Kim

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

[diff] [blame]

607

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

608

# ID and namespace ID.

609

# Queries are scoped to a single partition.

610

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

611

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

612

#

613

# A partition ID contains several dimensions:

614

# project ID and namespace ID.

615

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

616

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

617

},

Bu Sun Kim

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

[diff] [blame]

618

"path": [ # The entity path.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

619

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

620

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

621

# element identifies a _root entity_, the second element identifies

622

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

623

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

Bu Sun Kim

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

[diff] [blame]

624

# the path are called the element's _ancestors_.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

625

#

626

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

627

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

628

#

629

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

630

# If neither is set, the element is incomplete.

Bu Sun Kim

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

[diff] [blame]

631

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

632

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

633

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

Bu Sun Kim

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

[diff] [blame]

634

# Cannot be `""`.

635

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

636

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

637

# be supported in the future.

Bu Sun Kim

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

[diff] [blame]

638

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

639

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

640

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

641

# Cannot be `""`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

642

},

643

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

644

},

645

},

Bu Sun Kim

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

[diff] [blame]

646

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

Bu Sun Kim

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

[diff] [blame]

647

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

648

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

649

# jobs. To locate findings within a table, specify

650

# `inspect_job.storage_config.big_query_options.identifying_fields` in

651

# `CreateDlpJobRequest`.

Bu Sun Kim

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

[diff] [blame]

652

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

653

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

654

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

655

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

656

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

657

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

658

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

659

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

660

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

661

},

Bu Sun Kim

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

[diff] [blame]

662

},

Bu Sun Kim

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

[diff] [blame]

663

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

664

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

665

"A String",

666

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

667

},

668

},

Bu Sun Kim

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

[diff] [blame]

669

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

670

# For Google Cloud Storage contains last file modification timestamp.

671

# For BigQuery table contains last_modified_time property.

672

# For Datastore - not populated.

673

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

Bu Sun Kim

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

[diff] [blame]

674

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

Bu Sun Kim

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

[diff] [blame]

675

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

676

"key": "A String",

677

},

Bu Sun Kim

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

[diff] [blame]

678

},

679

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

680

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

681

{ # Bounding box encompassing detected text within an image.

682

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

683

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

684

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

685

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

686

},

687

],

688

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

689

},

690

],

691

},

Bu Sun Kim

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

[diff] [blame]

692

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

693

# may be converted to a textual representation here.

694

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

695

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

696

# in length, the quote may be omitted.

697

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

698

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

Bu Sun Kim

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

[diff] [blame]

699

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

700

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

701

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

702

},

703

],

Bu Sun Kim

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

[diff] [blame]

704

"findingsTruncated": True or False, # If true, then this item might have more findings than were returned,

705

# and the findings returned are an arbitrary subset of all findings.

706

# The findings list might be truncated because the input items were too

707

# large, or because the server reached the maximum amount of resources

708

# allowed for a single API call. For best results, divide the input into

709

# smaller batches.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

710

},

Bu Sun Kim

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

[diff] [blame]

711

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

712

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

713

# in the image.

Bu Sun Kim