Blame - docs/dyn/dlp_v2.projects.locations.jobTriggers.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.jobTriggers.html">jobTriggers</a></h1>

76

<h2>Instance Methods</h2>

77

78

<code><a href="#activate">activate(name, body=None, x__xgafv=None)</a></code></p>

79

<p class="firstline">Activate a job trigger. Causes the immediate execute of a trigger</p>

80

81

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

82

<p class="firstline">Creates a job trigger to run DLP actions such as scanning storage for</p>

83

84

<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>

85

<p class="firstline">Deletes a job trigger.</p>

86

87

<code><a href="#get">get(name, x__xgafv=None)</a></code></p>

88

<p class="firstline">Gets a job trigger.</p>

89

90

<code><a href="#hybridInspect">hybridInspect(name, body=None, x__xgafv=None)</a></code></p>

91

<p class="firstline">Inspect hybrid content and store findings to a trigger. The inspection</p>

92

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

93

<code><a href="#list">list(parent, locationId, orderBy=None, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

6502091

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

[diff] [blame]

94

<p class="firstline">Lists job triggers.</p>

95

96

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

97

<p class="firstline">Retrieves the next page of results.</p>

98

99

<code><a href="#patch">patch(name, body=None, x__xgafv=None)</a></code></p>

100

<p class="firstline">Updates a job trigger.</p>

101

<h3>Method Details</h3>

102

103

<code class="details" id="activate">activate(name, body=None, x__xgafv=None)</code>

104

<pre>Activate a job trigger. Causes the immediate execute of a trigger

105

instead of waiting on the trigger event to occur.

106

107

Args:

108

name: string, Required. Resource name of the trigger to activate, for example

109

`projects/dlp-test-project/jobTriggers/53234423`. (required)

110

body: object, The request body.

111

The object takes the form of:

112

113

{ # Request message for ActivateJobTrigger.

114

}

115

116

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

123

124

{ # Combines all of the information about a DLP job.

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

125

"type": "A String", # The type of job.

126

"endTime": "A String", # Time when the job finished.

127

"startTime": "A String", # Time when the job started.

128

"inspectDetails": { # The results of an inspect DataSource job. # Results from inspecting a data source.

129

"requestedOptions": { # Snapshot of the inspection configuration. # The configuration used for this job.

130

"snapshotInspectTemplate": { # The inspectTemplate contains a configuration (set of types of sensitive data # If run with an InspectTemplate, a snapshot of its state at the time of

131

# this run.

132

# to be detected) to be used anywhere you otherwise would normally specify

133

# InspectConfig. See https://cloud.google.com/dlp/docs/concepts-templates

134

# to learn more.

135

"name": "A String", # Output only. The template name.

Bu Sun Kim

6502091

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

[diff] [blame]

136

#

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

137

# The template will have one of the following formats:

138

# `projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID` OR

139

# `organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID`;

140

"description": "A String", # Short description (max 256 chars).

141

"displayName": "A String", # Display name (max 256 chars).

142

"inspectConfig": { # Configuration description of the scanning process. # The core content of the template. Configuration of the scanning process.

143

# When used with redactContent only info_types and min_likelihood are currently

144

# used.

145

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

146

# POSSIBLE.

147

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

148

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

149

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

150

"A String",

151

],

152

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

153

# InfoType values returned by ListInfoTypes or listed at

154

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

Bu Sun Kim

6502091

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

[diff] [blame]

155

#

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

156

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

157

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

158

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

Bu Sun Kim

6502091

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

[diff] [blame]

159

#

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

160

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

161

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

162

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

163

{ # Type of information detected by the API.

164

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

165

# creating a CustomInfoType, or one of the names listed

166

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

167

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

168

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

169

},

170

],

171

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

172

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

173

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

174

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

175

# sensitive information configurable to the data in question.

176

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

177

# support reversing.

178

# such as

179

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

180

# These types of transformations are

181

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

182

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

183

# transformation such as `surrogate_info_type`. This CustomInfoType does

184

# not support the use of `detection_rules`.

185

},

186

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

187

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

188

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

189

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

190

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

191

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

192

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

193

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

194

# as a custom info type.

195

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

196

# creating a CustomInfoType, or one of the names listed

197

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

198

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

199

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

200

},

201

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

202

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

203

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

204

42,

205

],

206

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

207

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

208

# google/re2 repository on GitHub.

209

},

210

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

211

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

212

# `surrogate_type` CustomInfoType.

213

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

214

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

215

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

216

# custom infoType.

217

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

218

# proximity of hotwords.

219

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

220

# part of a detection rule.

221

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

222

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

223

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

224

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

225

# Likelihood may never drop below `VERY_UNLIKELY` or exceed

226

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

227

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

228

# a final likelihood of `LIKELY`.

229

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

230

},

231

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

232

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

233

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

234

42,

235

],

236

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

237

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

238

# google/re2 repository on GitHub.

239

},

240

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

241

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

242

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

243

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

244

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

245

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

246

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

247

# is the area code in question.

248

# rule.

249

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

250

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

251

},

Bu Sun Kim

6502091

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

[diff] [blame]

252

},

253

},

254

],

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

255

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

256

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

257

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

258

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

259

# of employee IDs or job titles.

260

#

261

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

262

# and digits in the unicode [Basic Multilingual

263

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

264

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

265

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

266

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

267

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

268

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

269

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

270

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

271

# matches for "jennifer".

272

#

273

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

274

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

275

# are treated as whitespace. The

276

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

277

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

278

# these constraints, consider using `LargeCustomDictionaryConfig` in the

279

# `StoredInfoType` API.

280

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

281

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

282

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

283

# 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

288

# is accepted.

289

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

290

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

291

},

292

},

293

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

294

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

295

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

296

# `organizations/433245324/storedInfoTypes/432452342` or

297

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

298

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

299

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

},

},

],

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

304

# included in the response; see Finding.quote.

305

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

306

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

307

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

308

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

309

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

310

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

311

{ # Type of information detected by the API.

312

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

313

# creating a CustomInfoType, or one of the names listed

314

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

315

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

316

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

317

},

318

],

319

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

320

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

321

# `InspectionRuleSet`.

322

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

323

# proximity of hotwords.

324

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

325

# part of a detection rule.

326

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

327

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

328

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

329

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

330

# Likelihood may never drop below `VERY_UNLIKELY` or exceed

331

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

332

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

333

# a final likelihood of `LIKELY`.

334

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

Bu Sun Kim

6502091

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

[diff] [blame]

335

},

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

336

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

337

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

338

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

339

42,

340

],

341

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

342

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

343

# google/re2 repository on GitHub.

344

},

345

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

346

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

347

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

348

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

349

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

350

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

351

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

352

# is the area code in question.

353

# rule.

354

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

355

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

Bu Sun Kim

6502091

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

[diff] [blame]

356

},

357

},

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

358

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

359

# `InspectionRuleSet` are removed from results.

360

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

361

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

362

# of employee IDs or job titles.

363

#

364

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

365

# and digits in the unicode [Basic Multilingual

366

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

367

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

368

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

369

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

370

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

371

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

372

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

373

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

374

# matches for "jennifer".

375

#

376

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

377

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

378

# are treated as whitespace. The

379

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

380

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

381

# these constraints, consider using `LargeCustomDictionaryConfig` in the

382

# `StoredInfoType` API.

383

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

384

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

385

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

386

# 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

391

# is accepted.

392

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

393

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

394

},

395

},

396

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

397

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

398

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

399

42,

400

],

401

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

402

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

403

# google/re2 repository on GitHub.

404

},

405

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

406

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

407

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

408

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

409

# `exclusion_rule` containing `exclude_info_types.info_types` with

410

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

411

# with EMAIL_ADDRESS finding.

412

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

413

# finding, namely email address.

414

{ # Type of information detected by the API.

415

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

416

# creating a CustomInfoType, or one of the names listed

417

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

418

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

419

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

},

],

},

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

424

},

Bu Sun Kim

6502091

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

[diff] [blame]

},

],

},

],

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

429

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

430

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

431

# When set within `InspectJobConfig`,

432

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

433

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

434

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

435

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

436

# running DlpJob.

437

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

438

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

439

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

440

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

441

# are found but not specified in another InfoTypeLimit.

442

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

443

# creating a CustomInfoType, or one of the names listed

444

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

445

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

446

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

},

},

],

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

451

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

452

# regardless if this is set higher.

453

},

454

},

455

"createTime": "A String", # Output only. The creation timestamp of an inspectTemplate.

456

"updateTime": "A String", # Output only. The last update timestamp of an inspectTemplate.

457

},

458

"jobConfig": { # Controls what and how to inspect for findings. # Inspect config.

459

"inspectConfig": { # Configuration description of the scanning process. # How and what to scan for.

460

# When used with redactContent only info_types and min_likelihood are currently

461

# used.

462

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

463

# POSSIBLE.

464

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

465

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

466

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

467

"A String",

468

],

469

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

470

# InfoType values returned by ListInfoTypes or listed at

471

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

472

#

473

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

474

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

475

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

476

#

477

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

478

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

479

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

480

{ # Type of information detected by the API.

481

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

482

# creating a CustomInfoType, or one of the names listed

483

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

484

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

485

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

486

},

487

],

488

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

489

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

490

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

491

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

492

# sensitive information configurable to the data in question.

493

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

494

# support reversing.

495

# such as

496

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

497

# These types of transformations are

498

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

499

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

500

# transformation such as `surrogate_info_type`. This CustomInfoType does

501

# not support the use of `detection_rules`.

502

},

503

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

504

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

505

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

506

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

507

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

508

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

509

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

510

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

511

# as a custom info type.

512

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

513

# creating a CustomInfoType, or one of the names listed

514

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

515

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

516

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

517

},

518

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

519

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

520

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

521

42,

522

],

523

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

524

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

525

# google/re2 repository on GitHub.

526

},

527

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

528

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

529

# `surrogate_type` CustomInfoType.

530

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

531

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

532

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

533

# custom infoType.

534

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

535

# proximity of hotwords.

536

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

537

# part of a detection rule.

538

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

539

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

540

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

541

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

542

# Likelihood may never drop below `VERY_UNLIKELY` or exceed

543

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

544

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

545

# a final likelihood of `LIKELY`.

546

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

547

},

548

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

549

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

550

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

551

42,

552

],

553

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

554

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

555

# google/re2 repository on GitHub.

556

},

557

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

558

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

559

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

560

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

561

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

562

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

563

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

564

# is the area code in question.

565

# rule.

566

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

567

"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

573

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

574

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

575

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

576

# of employee IDs or job titles.

577

#

578

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

579

# and digits in the unicode [Basic Multilingual

580

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

581

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

582

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

583

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

584

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

585

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

586

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

587

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

588

# matches for "jennifer".

589

#

590

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

591

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

592

# are treated as whitespace. The

593

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

594

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

595

# these constraints, consider using `LargeCustomDictionaryConfig` in the

596

# `StoredInfoType` API.

597

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

598

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

599

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

600

# 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

605

# is accepted.

606

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

607

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

608

},

609

},

610

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

611

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

612

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

613

# `organizations/433245324/storedInfoTypes/432452342` or

614

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

615

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

616

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

},

},

],

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

621

# included in the response; see Finding.quote.

622

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

623

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

624

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

625

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

626

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

627

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

628

{ # Type of information detected by the API.

629

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

630

# creating a CustomInfoType, or one of the names listed

631

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

632

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

633

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

634

},

635

],

636

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

637

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

638

# `InspectionRuleSet`.

639

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

640

# proximity of hotwords.

641

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

642

# part of a detection rule.

643

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

644

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

645

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

646

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

647

# Likelihood may never drop below `VERY_UNLIKELY` or exceed

648

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

649

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

650

# a final likelihood of `LIKELY`.

651

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

652

},

653

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

654

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

655

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

656

42,

657

],

658

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

659

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

660

# google/re2 repository on GitHub.

661

},

662

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

663

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

664

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

665

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

666

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

667

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

668

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

669

# is the area code in question.

670

# rule.

671

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

672

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

673

},

674

},

675

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

676

# `InspectionRuleSet` are removed from results.

677

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

678

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

679

# of employee IDs or job titles.

680

#

681

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

682

# and digits in the unicode [Basic Multilingual

683

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

684

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

685

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

686

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

687

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

688

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

689

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

690

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

691

# matches for "jennifer".

692

#

693

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

694

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

695

# are treated as whitespace. The

696

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

697

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

698

# these constraints, consider using `LargeCustomDictionaryConfig` in the

699

# `StoredInfoType` API.

700

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

701

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

702

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

703

# 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

708

# is accepted.

709

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

710

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

711

},

712

},

713

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

714

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

715

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

716

42,

717

],

718

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

719

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

720

# google/re2 repository on GitHub.

721

},

722

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

723

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

724

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

725

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

726

# `exclusion_rule` containing `exclude_info_types.info_types` with

727

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

728

# with EMAIL_ADDRESS finding.

729

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

730

# finding, namely email address.

731

{ # Type of information detected by the API.

732

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

733

# creating a CustomInfoType, or one of the names listed

734

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

735

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

736

# `[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.

747

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

748

# When set within `InspectJobConfig`,

749

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

750

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

751

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

752

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

753

# running DlpJob.

754

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

755

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

756

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

757

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

758

# are found but not specified in another InfoTypeLimit.

759

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

760

# creating a CustomInfoType, or one of the names listed

761

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

762

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

763

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

},

},

],

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

768

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

769

# regardless if this is set higher.

770

},

771

},

772

"actions": [ # Actions to execute at the completion of the job.

773

{ # A task to execute on the completion of a job.

774

# See https://cloud.google.com/dlp/docs/concepts-actions to learn more.

775

"publishSummaryToCscc": { # Publish the result summary of a DlpJob to the Cloud Security # Publish summary to Cloud Security Command Center (Alpha).

776

# Command Center (CSCC Alpha).

777

# This action is only available for projects which are parts of

778

# an organization and whitelisted for the alpha Cloud Security Command

779

# Center.

780

# The action will publish count of finding instances and their info types.

781

# The summary of findings will be persisted in CSCC and are governed by CSCC

782

# service-specific policy, see https://cloud.google.com/terms/service-terms

783

# Only a single instance of this action can be specified.

784

# Compatible with: Inspect

785

},

786

"jobNotificationEmails": { # Enable email notification to project owners and editors on jobs's # Enable email notification for project owners and editors on job's

787

# completion/failure.

788

# completion/failure.

789

},

790

"saveFindings": { # If set, the detailed findings will be persisted to the specified # Save resulting findings in a provided location.

791

# OutputStorageConfig. Only a single instance of this action can be

792

# specified.

793

# Compatible with: Inspect, Risk

794

"outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.

795

"table": { # Message defining the location of a BigQuery table. A table is uniquely # Store findings in an existing table or a new table in an existing

796

# dataset. If table_id is not set a new one will be generated

797

# for you with the following format:

798

# dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific timezone will be used for

799

# generating the date details.

800

#

801

# For Inspect, each column in an existing output table must have the same

802

# name, type, and mode of a field in the `Finding` object.

803

#

804

# For Risk, an existing output table should be the output of a previous

805

# Risk analysis job run on the same source table, with the same privacy

806

# metric and quasi-identifiers. Risk jobs that analyze the same table but

807

# compute a different privacy metric, or use different sets of

808

# quasi-identifiers, cannot store their results in the same table.

809

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

810

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

811

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

812

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

813

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

814

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

815

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

816

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

817

},

818

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only

819

# used for Inspect and must be unspecified for Risk jobs. Columns are derived

820

# from the `Finding` object. If appending to an existing table, any columns

821

# from the predefined schema that are missing will be added. No columns in

822

# the existing table will be deleted.

823

#

824

# If unspecified, then all available columns will be used for a new table or

825

# an (existing) table with no schema, and no changes will be made to an

826

# existing table that has a schema.

827

# Only for use with external storage.

828

},

829

},

830

"pubSub": { # Publish a message into given Pub/Sub topic when DlpJob has completed. The # Publish a notification to a pubsub topic.

831

# message contains a single field, `DlpJobName`, which is equal to the

832

# finished job's

833

# [`DlpJob.name`](/dlp/docs/reference/rest/v2/projects.dlpJobs#DlpJob).

834

# Compatible with: Inspect, Risk

835

"topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given

836

# publishing access rights to the DLP API service account executing

837

# the long running DlpJob sending the notifications.

838

# Format is projects/{project}/topics/{topic}.

839

},

840

"publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Cloud Data Catalog. Labels summarizing the # Publish findings to Cloud Datahub.

841

# results of the DlpJob will be applied to the entry for the resource scanned

842

# in Cloud Data Catalog. Any labels previously written by another DlpJob will

843

# be deleted. InfoType naming patterns are strictly enforced when using this

844

# feature. Note that the findings will be persisted in Cloud Data Catalog

845

# storage and are governed by Data Catalog service-specific policy, see

846

# https://cloud.google.com/terms/service-terms

847

# Only a single instance of this action can be specified and only allowed if

848

# all resources being scanned are BigQuery tables.

849

# Compatible with: Inspect

850

},

851

"publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This # Enable Stackdriver metric dlp.googleapis.com/finding_count.

852

# will publish a metric to stack driver on each infotype requested and

853

# how many findings were found for it. CustomDetectors will be bucketed

854

# as 'Custom' under the Stackdriver label 'info_type'.

},

},

],

"storageConfig": { # Shared message indicating Cloud storage type. # The data to scan.

859

"hybridOptions": { # Configuration to control jobs where the content being inspected is outside # Hybrid inspection options.

860

# Early access feature is in a pre-release state and might change or have

861

# limited support. For more information, see

862

# https://cloud.google.com/products#product-launch-stages.

863

# of Google Cloud Platform.

864

"labels": { # To organize findings, these labels will be added to each finding.

865

#

866

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

867

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

868

#

869

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

870

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

871

#

872

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

873

#

874

# Examples:

875

# * `"environment" : "production"`

876

# * `"pipeline" : "etl"`

877

"a_key": "A String",

878

},

879

"description": "A String", # A short description of where the data is coming from. Will be stored once

880

# in the job. 256 max length.

881

"tableOptions": { # Instructions regarding the table content being inspected. # If the container is a table, additional information to make findings

882

# meaningful such as the columns that are primary keys.

883

"identifyingFields": [ # The columns that are the primary keys for table objects included in

884

# ContentItem. A copy of this cell's value will stored alongside alongside

885

# each finding so that the finding can be traced to the specific row it came

886

# from. No more than 3 may be provided.

887

{ # General identifier of a data field in a storage service.

888

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

},

],

},

"requiredFindingLabelKeys": [ # These are labels that each inspection request must include within their

893

# 'finding_labels' map. Request may contain others, but any missing one of

894

# these will be rejected.

895

#

896

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

897

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

898

#

899

# No more than 10 keys can be required.

"A String",

],

},

"datastoreOptions": { # Options defining a data set within Google Cloud Datastore. # Google Cloud Datastore options.

904

"partitionId": { # Datastore partition ID. # A partition ID identifies a grouping of entities. The grouping is always

905

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

906

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

907

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

908

#

909

# A partition ID contains several dimensions:

910

# project ID and namespace ID.

911

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

912

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

913

},

914

"kind": { # A representation of a Datastore kind. # The kind to process.

915

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

916

},

917

},

918

"timespanConfig": { # Configuration of the timespan of the items to include in scanning.

919

# Currently only supported when inspecting Google Cloud Storage and BigQuery.

920

"timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items.

921

# Used for data sources like Datastore and BigQuery.

922

#

923

# For BigQuery:

924

# Required to filter out rows based on the given start and

925

# end times. If not specified and the table was modified between the given

926

# start and end times, the entire table will be scanned.

927

# The valid data types of the timestamp field are: `INTEGER`, `DATE`,

928

# `TIMESTAMP`, or `DATETIME` BigQuery column.

929

#

930

# For Datastore.

931

# Valid data types of the timestamp field are: `TIMESTAMP`.

932

# Datastore entity will be scanned if the timestamp property does not

933

# exist or its value is empty or invalid.

934

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

935

},

936

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out

937

# a valid start_time to avoid scanning files that have not been modified

938

# since the last time the JobTrigger executed. This will be based on the

939

# time of the execution of the last run of the JobTrigger.

940

"endTime": "A String", # Exclude files or rows newer than this value.

941

# If set to zero, no upper time limit is applied.

942

"startTime": "A String", # Exclude files or rows older than this value.

943

},

944

"cloudStorageOptions": { # Options defining a file or a set of files within a Google Cloud Storage # Google Cloud Storage options.

945

# bucket.

946

"bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger

947

# than this value then the rest of the bytes are omitted. Only one

948

# of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.

949

"fileSet": { # Set of files to scan. # The set of one or more files to scan.

950

"regexFileSet": { # Message representing a set of files in a Cloud Storage bucket. Regular # The regex-filtered set of files to scan. Exactly one of `url` or

951

# `regex_file_set` must be set.

952

# expressions are used to allow fine-grained control over which files in the

953

# bucket to include.

954

#

955

# Included files are those that match at least one item in `include_regex` and

956

# do not match any items in `exclude_regex`. Note that a file that matches

957

# items from both lists will _not_ be included. For a match to occur, the

958

# entire file path (i.e., everything in the url after the bucket name) must

959

# match the regular expression.

960

#

961

# For example, given the input `{bucket_name: "mybucket", include_regex:

962

# ["directory1/.*"], exclude_regex:

963

# ["directory1/excluded.*"]}`:

964

#

965

# * `gs://mybucket/directory1/myfile` will be included

966

# * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches

967

# across `/`)

968

# * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the

969

# full path doesn't match any items in `include_regex`)

970

# * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path

971

# matches an item in `exclude_regex`)

972

#

973

# If `include_regex` is left empty, it will match all files by default

974

# (this is equivalent to setting `include_regex: [".*"]`).

975

#

976

# Some other common use cases:

977

#

978

# * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all

979

# files in `mybucket` except for .pdf files

980

# * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will

981

# include all files directly under `gs://mybucket/directory/`, without matching

982

# across `/`

983

"bucketName": "A String", # The name of a Cloud Storage bucket. Required.

984

"includeRegex": [ # A list of regular expressions matching file paths to include. All files in

985

# the bucket that match at least one of these regular expressions will be

986

# included in the set of files, except for those that also match an item in

987

# `exclude_regex`. Leaving this field empty will match all files by default

988

# (this is equivalent to including `.*` in the list).

989

#

990

# Regular expressions use RE2

991

# [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found

992

# under the google/re2 repository on GitHub.

993

"A String",

994

],

995

"excludeRegex": [ # A list of regular expressions matching file paths to exclude. All files in

996

# the bucket that match at least one of these regular expressions will be

997

# excluded from the scan.

998

#

999

# Regular expressions use RE2

1000

# [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found

1001

# under the google/re2 repository on GitHub.

"A String",

],

},

"url": "A String", # The Cloud Storage url of the file(s) to scan, in the format

1006

# `gs://<bucket>/<path>`. Trailing wildcard in the path is allowed.

1007

#

1008

# If the url ends in a trailing slash, the bucket or directory represented

1009

# by the url will be scanned non-recursively (content in sub-directories

1010

# will not be scanned). This means that `gs://mybucket/` is equivalent to

1011

# `gs://mybucket/*`, and `gs://mybucket/directory/` is equivalent to

1012

# `gs://mybucket/directory/*`.

1013

#

1014

# Exactly one of `url` or `regex_file_set` must be set.

1015

},

1016

"filesLimitPercent": 42, # Limits the number of files to scan to this percentage of the input FileSet.

1017

# Number of files scanned is rounded down. Must be between 0 and 100,

1018

# inclusively. Both 0 and 100 means no limit. Defaults to 0.

1019

"fileTypes": [ # List of file type groups to include in the scan.

1020

# If empty, all files are scanned and available data format processors

1021

# are applied. In addition, the binary content of the selected files

1022

# is always scanned as well.

1023

# Images are scanned only as binary if the specified region

1024

# does not support image inspection and no file_types were specified.

1025

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

1026

"A String",

1027

],

1028

"sampleMethod": "A String",

1029

"bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The

1030

# number of bytes scanned is rounded down. Must be between 0 and 100,

1031

# inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one

1032

# of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.

1033

},

1034

"bigQueryOptions": { # Options defining BigQuery table and row identifiers. # BigQuery options.

1035

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

1036

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

1037

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

1038

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

1039

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

1040

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

1041

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

1042

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

1043

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

1044

},

1045

"identifyingFields": [ # Table fields that may uniquely identify a row within the table. When

1046

# `actions.saveFindings.outputConfig.table` is specified, the values of

1047

# columns specified here are available in the output table under

1048

# `location.content_locations.record_location.record_key.id_values`. Nested

1049

# fields such as `person.birthdate.year` are allowed.

1050

{ # General identifier of a data field in a storage service.

1051

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

1052

},

1053

],

1054

"rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows

1055

# scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and

1056

# 100 means no limit. Defaults to 0. Only one of rows_limit and

1057

# rows_limit_percent can be specified. Cannot be used in conjunction with

1058

# TimespanConfig.

1059

"rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the

1060

# rest of the rows are omitted. If not set, or if set to 0, all rows will be

1061

# scanned. Only one of rows_limit and rows_limit_percent can be specified.

1062

# Cannot be used in conjunction with TimespanConfig.

1063

"excludedFields": [ # References to fields excluded from scanning. This allows you to skip

1064

# inspection of entire columns which you know have no findings.

1065

{ # General identifier of a data field in a storage service.

1066

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

1067

},

1068

],

1069

"sampleMethod": "A String",

1070

},

1071

},

1072

"inspectTemplateName": "A String", # If provided, will be used as the default for all values in InspectConfig.

1073

# `inspect_config` will be merged into the values persisted as part of the

# template.

},

},

"result": { # All result fields mentioned below are updated while the job is processing. # A summary of the outcome of this inspect job.

1078

"processedBytes": "A String", # Total size in bytes that were processed.

1079

"hybridStats": { # Statistics related to processing hybrid inspect requests. # Statistics related to the processing of hybrid inspect.

1080

# Early access feature is in a pre-release state and might change or have

1081

# limited support. For more information, see

1082

# https://cloud.google.com/products#product-launch-stages.

1083

"pendingCount": "A String", # The number of hybrid requests currently being processed. Only populated

1084

# when called via method `getDlpJob`.

1085

# A burst of traffic may cause hybrid inspect requests to be enqueued.

1086

# Processing will take place as quickly as possible, but resource limitations

1087

# may impact how long a request is enqueued for.

1088

"processedCount": "A String", # The number of hybrid inspection requests processed within this job.

1089

"abortedCount": "A String", # The number of hybrid inspection requests aborted because the job ran

1090

# out of quota or was ended before they could be processed.

1091

},

1092

"infoTypeStats": [ # Statistics of how many instances of each info type were found during

1093

# inspect job.

1094

{ # Statistics regarding a specific InfoType.

1095

"infoType": { # Type of information detected by the API. # The type of finding this stat is for.

1096

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

1097

# creating a CustomInfoType, or one of the names listed

1098

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

1099

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

1100

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

1101

},

1102

"count": "A String", # Number of findings for this infoType.

Bu Sun Kim

6502091

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

[diff] [blame]

1103

},

1104

],

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

1105

"totalEstimatedBytes": "A String", # Estimate of the number of bytes to process.

Bu Sun Kim

6502091

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

[diff] [blame]

1106

},

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

1107

},

1108

"createTime": "A String", # Time when the job was created.

1109

"state": "A String", # State of a job.

1110

"jobTriggerName": "A String", # If created by a job trigger, the resource name of the trigger that

1111

# instantiated the job.

1112

"riskDetails": { # Result of a risk analysis operation request. # Results from analyzing risk of a data source.

Bu Sun Kim

6502091

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

[diff] [blame]

1113

"requestedPrivacyMetric": { # Privacy metric to compute for reidentification risk analysis. # Privacy metric to compute.

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

1114

"deltaPresenceEstimationConfig": { # δ-presence metric, used to estimate how likely it is for an attacker to # delta-presence

1115

# figure out that one given individual appears in a de-identified dataset.

1116

# Similarly to the k-map metric, we cannot compute δ-presence exactly without

1117

# knowing the attack dataset, so we use a statistical model instead.

1118

"regionCode": "A String", # ISO 3166-1 alpha-2 region code to use in the statistical modeling.

1119

# Set if no column is tagged with a region-specific InfoType (like

1120

# US_ZIP_5) or a region code.

1121

"auxiliaryTables": [ # Several auxiliary tables can be used in the analysis. Each custom_tag

1122

# used to tag a quasi-identifiers field must appear in exactly one

1123

# field of one auxiliary table.

1124

{ # An auxiliary table containing statistical information on the relative

1125

# frequency of different quasi-identifiers values. It has one or several

1126

# quasi-identifiers columns, and one column that indicates the relative

1127

# frequency of each quasi-identifier tuple.

1128

# If a tuple is present in the data but not in the auxiliary table, the

1129

# corresponding relative frequency is assumed to be zero (and thus, the

1130

# tuple is highly reidentifiable).

1131

"quasiIds": [ # Required. Quasi-identifier columns.

1132

{ # A quasi-identifier column has a custom_tag, used to know which column

1133

# in the data corresponds to which column in the statistical model.

1134

"customTag": "A String", # A column can be tagged with a custom tag. In this case, the user must

1135

# indicate an auxiliary table that contains statistical information on

1136

# the possible values of this column (below).

1137

"field": { # General identifier of a data field in a storage service. # Identifies the column.

1138

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

},

},

],

"table": { # Message defining the location of a BigQuery table. A table is uniquely # Required. Auxiliary table location.

1143

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

1144

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

1145

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

1146

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

1147

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

1148

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

1149

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

1150

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

1151

},

1152

"relativeFrequency": { # General identifier of a data field in a storage service. # Required. The relative frequency column must contain a floating-point number

1153

# between 0 and 1 (inclusive). Null values are assumed to be zero.

1154

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

},

},

],

"quasiIds": [ # Required. Fields considered to be quasi-identifiers. No two fields can have the

1159

# same tag.

1160

{ # A column with a semantic tag attached.

1161

"field": { # General identifier of a data field in a storage service. # Required. Identifies the column.

1162

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

1163

},

1164

"infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public

1165

# dataset as a statistical model of population, if available. We

1166

# currently support US ZIP codes, region codes, ages and genders.

1167

# To programmatically obtain the list of supported InfoTypes, use

1168

# ListInfoTypes with the supported_by=RISK_ANALYSIS filter.

1169

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

1170

# creating a CustomInfoType, or one of the names listed

1171

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

1172

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

1173

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

1174

},

1175

"customTag": "A String", # A column can be tagged with a custom tag. In this case, the user must

1176

# indicate an auxiliary table that contains statistical information on

1177

# the possible values of this column (below).

1178

"inferred": { # A generic empty message that you can re-use to avoid defining duplicated # If no semantic tag is indicated, we infer the statistical model from

1179

# the distribution of values in the input data

1180

# empty messages in your APIs. A typical example is to use it as the request

1181

# or the response type of an API method. For instance:

1182

#

1183

# service Foo {

1184

# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

1185

# }

1186

#

1187

# The JSON representation for `Empty` is empty JSON object `{}`.

},

},

],

},

Bu Sun Kim

6502091

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

[diff] [blame]

1192

"categoricalStatsConfig": { # Compute numerical stats over an individual column, including # Categorical stats

1193

# number of distinct values and value count distribution.

1194

"field": { # General identifier of a data field in a storage service. # Field to compute categorical stats on. All column types are

1195

# supported except for arrays and structs. However, it may be more

1196

# informative to use NumericalStats when the field type is supported,

1197

# depending on the data.

1198

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

1199

},

1200

},

1201

"kAnonymityConfig": { # k-anonymity metric, used for analysis of reidentification risk. # K-anonymity

Bu Sun Kim

6502091

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

[diff] [blame]

1202

"entityId": { # An entity in a dataset is a field or set of fields that correspond to a # Message indicating that multiple rows might be associated to a

1203

# single individual. If the same entity_id is associated to multiple

1204

# quasi-identifier tuples over distinct rows, we consider the entire

1205

# collection of tuples as the composite quasi-identifier. This collection

1206

# is a multiset: the order in which the different tuples appear in the

1207

# dataset is ignored, but their frequency is taken into account.

1208

#

1209

# Important note: a maximum of 1000 rows can be associated to a single

1210

# entity ID. If more rows are associated with the same entity ID, some

1211

# might be ignored.

1212

# single person. For example, in medical records the `EntityId` might be a

1213

# patient identifier, or for financial records it might be an account

1214

# identifier. This message is used when generalizations or analysis must take

1215

# into account that multiple rows correspond to the same entity.

1216

"field": { # General identifier of a data field in a storage service. # Composite key indicating which field contains the entity identifier.

1217

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

1218

},

1219

},

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

1220

"quasiIds": [ # Set of fields to compute k-anonymity over. When multiple fields are

1221

# specified, they are considered a single composite key. Structs and

1222

# repeated data types are not supported; however, nested fields are

1223

# supported so long as they are not structs themselves or nested within

1224

# a repeated field.

1225

{ # General identifier of a data field in a storage service.

1226

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

1227

},

1228

],

Bu Sun Kim

6502091

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

[diff] [blame]

1229

},

1230

"numericalStatsConfig": { # Compute numerical stats over an individual column, including # Numerical stats

1231

# min, max, and quantiles.

1232

"field": { # General identifier of a data field in a storage service. # Field to compute numerical stats on. Supported types are

1233

# integer, float, date, datetime, timestamp, time.

1234

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

1235

},

1236

},

1237

"kMapEstimationConfig": { # Reidentifiability metric. This corresponds to a risk model similar to what # k-map

1238

# is called "journalist risk" in the literature, except the attack dataset is

1239

# statistically modeled instead of being perfectly known. This can be done

1240

# using publicly available data (like the US Census), or using a custom

1241

# statistical model (indicated as one or several BigQuery tables), or by

1242

# extrapolating from the distribution of values in the input dataset.

1243

"regionCode": "A String", # ISO 3166-1 alpha-2 region code to use in the statistical modeling.

1244

# Set if no column is tagged with a region-specific InfoType (like

1245

# US_ZIP_5) or a region code.

1246

"auxiliaryTables": [ # Several auxiliary tables can be used in the analysis. Each custom_tag

1247

# used to tag a quasi-identifiers column must appear in exactly one column

1248

# of one auxiliary table.

1249

{ # An auxiliary table contains statistical information on the relative

1250

# frequency of different quasi-identifiers values. It has one or several

1251

# quasi-identifiers columns, and one column that indicates the relative

1252

# frequency of each quasi-identifier tuple.

1253

# If a tuple is present in the data but not in the auxiliary table, the

1254

# corresponding relative frequency is assumed to be zero (and thus, the

1255

# tuple is highly reidentifiable).

1256

"table": { # Message defining the location of a BigQuery table. A table is uniquely # Required. Auxiliary table location.

1257

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

1258

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

1259

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

1260

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

1261

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

1262

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

1263

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

1264

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

1265

},

1266

"relativeFrequency": { # General identifier of a data field in a storage service. # Required. The relative frequency column must contain a floating-point number

1267

# between 0 and 1 (inclusive). Null values are assumed to be zero.

1268

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

1269

},

1270

"quasiIds": [ # Required. Quasi-identifier columns.

1271

{ # A quasi-identifier column has a custom_tag, used to know which column

1272

# in the data corresponds to which column in the statistical model.

1273

"customTag": "A String", # A auxiliary field.

1274

"field": { # General identifier of a data field in a storage service. # Identifies the column.

1275

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

},

},

],

},

],

"quasiIds": [ # Required. Fields considered to be quasi-identifiers. No two columns can have the

1282

# same tag.

1283

{ # A column with a semantic tag attached.

Bu Sun Kim

6502091

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

[diff] [blame]

1284

"customTag": "A String", # A column can be tagged with a custom tag. In this case, the user must

1285

# indicate an auxiliary table that contains statistical information on

1286

# the possible values of this column (below).

1287

"inferred": { # A generic empty message that you can re-use to avoid defining duplicated # If no semantic tag is indicated, we infer the statistical model from

1288

# the distribution of values in the input data

1289

# empty messages in your APIs. A typical example is to use it as the request

1290

# or the response type of an API method. For instance:

1291

#

1292

# service Foo {

1293

# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

1294

# }

1295

#

1296

# The JSON representation for `Empty` is empty JSON object `{}`.

1297

},

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

1298

"field": { # General identifier of a data field in a storage service. # Required. Identifies the column.

1299

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

1300

},

1301

"infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public

1302

# dataset as a statistical model of population, if available. We

1303

# currently support US ZIP codes, region codes, ages and genders.

1304

# To programmatically obtain the list of supported InfoTypes, use

1305

# ListInfoTypes with the supported_by=RISK_ANALYSIS filter.

1306

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

1307

# creating a CustomInfoType, or one of the names listed

1308

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

1309

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

1310

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

1311

},

Bu Sun Kim

6502091

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

[diff] [blame]

},

],

},

"lDiversityConfig": { # l-diversity metric, used for analysis of reidentification risk. # l-diversity

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

1316

"sensitiveAttribute": { # General identifier of a data field in a storage service. # Sensitive field for computing the l-value.

1317

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

1318

},

Bu Sun Kim

6502091

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

[diff] [blame]

1319

"quasiIds": [ # Set of quasi-identifiers indicating how equivalence classes are

1320

# defined for the l-diversity computation. When multiple fields are

1321

# specified, they are considered a single composite key.

1322

{ # General identifier of a data field in a storage service.

1323

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

1324

},

1325

],

Bu Sun Kim

6502091

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

[diff] [blame]

1326

},

1327

},

1328

"categoricalStatsResult": { # Result of the categorical stats computation. # Categorical stats result

1329

"valueFrequencyHistogramBuckets": [ # Histogram of value frequencies in the column.

1330

{ # Histogram of value frequencies in the column.

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

1331

"valueFrequencyLowerBound": "A String", # Lower bound on the value frequency of the values in this bucket.

1332

"valueFrequencyUpperBound": "A String", # Upper bound on the value frequency of the values in this bucket.

1333

"bucketSize": "A String", # Total number of values in this bucket.

1334

"bucketValueCount": "A String", # Total number of distinct values in this bucket.

Bu Sun Kim

6502091

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

[diff] [blame]

1335

"bucketValues": [ # Sample of value frequencies in this bucket. The total number of

1336

# values returned per bucket is capped at 20.

1337

{ # A value of a field, including its frequency.

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

1338

"count": "A String", # How many times the value is contained in the field.

Bu Sun Kim

6502091

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

[diff] [blame]

1339

"value": { # Set of primitive values supported by the system. # A value contained in the field in question.

1340

# Note that for the purposes of inspection or transformation, the number

1341

# of bytes considered to comprise a 'Value' is based on its representation

1342

# as a UTF-8 encoded string. For example, if 'integer_value' is set to

1343

# 123456789, the number of bytes would be counted as 9, even though an

1344

# int64 only holds up to 8 bytes of data.

Bu Sun Kim

6502091

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

[diff] [blame]

1345

"timestampValue": "A String", # timestamp

1346

"dateValue": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # date

1347

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

1348

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

1349

#

1350

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

1351

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

1352

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

1353

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

1354

#

1355

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

1356

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

1357

# a year.

1358

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

1359

# month and day.

1360

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

1361

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

1362

# significant.

1363

},

1364

"stringValue": "A String", # string

1365

"integerValue": "A String", # integer

1366

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

1367

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

1368

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

Bu Sun Kim

6502091

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

[diff] [blame]

1369

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

1370

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

1371

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

1372

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

1373

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

1374

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

1375

},

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

1376

"booleanValue": True or False, # boolean

1377

"floatValue": 3.14, # float

1378

"dayOfWeekValue": "A String", # day of week

Bu Sun Kim

6502091

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

[diff] [blame]

1379

},

Bu Sun Kim

6502091

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

[diff] [blame]

1380

},

1381

],

Bu Sun Kim

6502091

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

[diff] [blame]

},

],

},

"kMapEstimationResult": { # Result of the reidentifiability analysis. Note that these results are an # K-map result

1386

# estimation, not exact values.

1387

"kMapEstimationHistogram": [ # The intervals [min_anonymity, max_anonymity] do not overlap. If a value

1388

# doesn't correspond to any such interval, the associated frequency is

1389

# zero. For example, the following records:

1390

# {min_anonymity: 1, max_anonymity: 1, frequency: 17}

1391

# {min_anonymity: 2, max_anonymity: 3, frequency: 42}

1392

# {min_anonymity: 5, max_anonymity: 10, frequency: 99}

1393

# mean that there are no record with an estimated anonymity of 4, 5, or

1394

# larger than 10.

1395

{ # A KMapEstimationHistogramBucket message with the following values:

# min_anonymity: 3

# max_anonymity: 5

# frequency: 42

# means that there are 42 records whose quasi-identifier values correspond

1400

# to 3, 4 or 5 people in the overlying population. An important particular

1401

# case is when min_anonymity = max_anonymity = 1: the frequency field then

1402

# corresponds to the number of uniquely identifiable records.

Bu Sun Kim

6502091

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

[diff] [blame]

1403

"minAnonymity": "A String", # Always positive.

1404

"bucketValues": [ # Sample of quasi-identifier tuple values in this bucket. The total

1405

# number of classes returned per bucket is capped at 20.

1406

{ # A tuple of values for the quasi-identifier columns.

Bu Sun Kim

6502091

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

[diff] [blame]

1407

"quasiIdsValues": [ # The quasi-identifier values.

1408

{ # Set of primitive values supported by the system.

1409

# Note that for the purposes of inspection or transformation, the number

1410

# of bytes considered to comprise a 'Value' is based on its representation

1411

# as a UTF-8 encoded string. For example, if 'integer_value' is set to

1412

# 123456789, the number of bytes would be counted as 9, even though an

1413

# int64 only holds up to 8 bytes of data.

Bu Sun Kim

6502091

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

[diff] [blame]

1414

"timestampValue": "A String", # timestamp

1415

"dateValue": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # date

1416

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

1417

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

1418

#

1419

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

1420

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

1421

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

1422

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

1423

#

1424

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

1425

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

1426

# a year.

1427

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

1428

# month and day.

1429

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

1430

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

1431

# significant.

1432

},

1433

"stringValue": "A String", # string

1434

"integerValue": "A String", # integer

1435

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

1436

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

1437

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

Bu Sun Kim

6502091

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

[diff] [blame]

1438

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

1439

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

1440

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

1441

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

1442

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

1443

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

1444

},

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

1445

"booleanValue": True or False, # boolean

1446

"floatValue": 3.14, # float

1447

"dayOfWeekValue": "A String", # day of week

Bu Sun Kim

6502091

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

[diff] [blame]

1448

},

1449

],

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

1450

"estimatedAnonymity": "A String", # The estimated anonymity for these quasi-identifier values.

Bu Sun Kim

6502091

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

[diff] [blame]

1451

},

1452

],

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

1453

"bucketSize": "A String", # Number of records within these anonymity bounds.

1454

"bucketValueCount": "A String", # Total number of distinct quasi-identifier tuple values in this bucket.

1455

"maxAnonymity": "A String", # Always greater than or equal to min_anonymity.

Bu Sun Kim

6502091

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

[diff] [blame]

},

],

},

"kAnonymityResult": { # Result of the k-anonymity computation. # K-anonymity result

1460

"equivalenceClassHistogramBuckets": [ # Histogram of k-anonymity equivalence classes.

1461

{ # Histogram of k-anonymity equivalence classes.

Bu Sun Kim

6502091

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

[diff] [blame]

1462

"equivalenceClassSizeLowerBound": "A String", # Lower bound on the size of the equivalence classes in this bucket.

1463

"equivalenceClassSizeUpperBound": "A String", # Upper bound on the size of the equivalence classes in this bucket.

1464

"bucketValues": [ # Sample of equivalence classes in this bucket. The total number of

1465

# classes returned per bucket is capped at 20.

1466

{ # The set of columns' values that share the same ldiversity value

1467

"quasiIdsValues": [ # Set of values defining the equivalence class. One value per

1468

# quasi-identifier column in the original KAnonymity metric message.

1469

# The order is always the same as the original request.

1470

{ # Set of primitive values supported by the system.

1471

# Note that for the purposes of inspection or transformation, the number

1472

# of bytes considered to comprise a 'Value' is based on its representation

1473

# as a UTF-8 encoded string. For example, if 'integer_value' is set to

1474

# 123456789, the number of bytes would be counted as 9, even though an

1475

# int64 only holds up to 8 bytes of data.

Bu Sun Kim

6502091

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

[diff] [blame]

1476

"timestampValue": "A String", # timestamp

1477

"dateValue": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # date

1478

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

1479

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

1480

#

1481

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

1482

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

1483

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

1484

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

1485

#

1486

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

1487

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

1488

# a year.

1489

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

1490

# month and day.

1491

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

1492

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

1493

# significant.

1494

},

1495

"stringValue": "A String", # string

1496

"integerValue": "A String", # integer

1497

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

1498

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

1499

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

Bu Sun Kim

6502091

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

[diff] [blame]

1500

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

1501

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

1502

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

1503

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

1504

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

1505

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

1506

},

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

1507

"booleanValue": True or False, # boolean

1508

"floatValue": 3.14, # float

1509

"dayOfWeekValue": "A String", # day of week

Bu Sun Kim

6502091

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

[diff] [blame]

1510

},

1511

],

1512

"equivalenceClassSize": "A String", # Size of the equivalence class, for example number of rows with the

1513

# above set of values.

1514

},

1515

],

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

1516

"bucketSize": "A String", # Total number of equivalence classes in this bucket.

1517

"bucketValueCount": "A String", # Total number of distinct equivalence classes in this bucket.

Bu Sun Kim

6502091

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

[diff] [blame]

},

],

},

"deltaPresenceEstimationResult": { # Result of the δ-presence computation. Note that these results are an # Delta-presence result

1522

# estimation, not exact values.

1523

"deltaPresenceEstimationHistogram": [ # The intervals [min_probability, max_probability) do not overlap. If a

1524

# value doesn't correspond to any such interval, the associated frequency

1525

# is zero. For example, the following records:

1526

# {min_probability: 0, max_probability: 0.1, frequency: 17}

1527

# {min_probability: 0.2, max_probability: 0.3, frequency: 42}

1528

# {min_probability: 0.3, max_probability: 0.4, frequency: 99}

1529

# mean that there are no record with an estimated probability in [0.1, 0.2)

1530

# nor larger or equal to 0.4.

1531

{ # A DeltaPresenceEstimationHistogramBucket message with the following

1532

# values:

1533

# min_probability: 0.1

1534

# max_probability: 0.2

1535

# frequency: 42

1536

# means that there are 42 records for which δ is in [0.1, 0.2). An

1537

# important particular case is when min_probability = max_probability = 1:

1538

# then, every individual who shares this quasi-identifier combination is in

1539

# the dataset.

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

1540

"minProbability": 3.14, # Between 0 and 1.

1541

"maxProbability": 3.14, # Always greater than or equal to min_probability.

1542

"bucketSize": "A String", # Number of records within these probability bounds.

1543

"bucketValueCount": "A String", # Total number of distinct quasi-identifier tuple values in this bucket.

Bu Sun Kim

6502091

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

[diff] [blame]

1544

"bucketValues": [ # Sample of quasi-identifier tuple values in this bucket. The total

1545

# number of classes returned per bucket is capped at 20.

1546

{ # A tuple of values for the quasi-identifier columns.

1547

"quasiIdsValues": [ # The quasi-identifier values.

1548

{ # Set of primitive values supported by the system.

1549

# Note that for the purposes of inspection or transformation, the number

1550

# of bytes considered to comprise a 'Value' is based on its representation

1551

# as a UTF-8 encoded string. For example, if 'integer_value' is set to

1552

# 123456789, the number of bytes would be counted as 9, even though an

1553

# int64 only holds up to 8 bytes of data.

Bu Sun Kim

6502091

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

[diff] [blame]

1554

"timestampValue": "A String", # timestamp

1555

"dateValue": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # date

1556

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

1557

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

1558

#

1559

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

1560

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

1561

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

1562

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

1563

#

1564

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

1565

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

1566

# a year.

1567

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

1568

# month and day.

1569

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

1570

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

1571

# significant.

1572

},

1573

"stringValue": "A String", # string

1574

"integerValue": "A String", # integer

1575

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

1576

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

1577

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

Bu Sun Kim

6502091

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

[diff] [blame]

1578

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

1579

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

1580

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

1581

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

1582

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

1583

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

1584

},

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

1585

"booleanValue": True or False, # boolean

1586

"floatValue": 3.14, # float

1587

"dayOfWeekValue": "A String", # day of week

Bu Sun Kim

6502091

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

[diff] [blame]

1588

},

1589

],

1590

"estimatedProbability": 3.14, # The estimated probability that a given individual sharing these

1591

# quasi-identifier values is in the dataset. This value, typically called

1592

# δ, is the ratio between the number of records in the dataset with these

1593

# quasi-identifier values, and the total number of individuals (inside

1594

# *and* outside the dataset) with these quasi-identifier values.

1595

# For example, if there are 15 individuals in the dataset who share the

1596

# same quasi-identifier values, and an estimated 100 people in the entire

1597

# population with these values, then δ is 0.15.

1598

},

1599

],

Bu Sun Kim

6502091

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

[diff] [blame]

},

],

},

"requestedSourceTable": { # Message defining the location of a BigQuery table. A table is uniquely # Input dataset to compute metrics over.

1604

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

1605

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

1606

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

1607

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

1608

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

1609

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

1610

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

1611

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

1612

},

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

1613

"numericalStatsResult": { # Result of the numerical stats computation. # Numerical stats result

1614

"minValue": { # Set of primitive values supported by the system. # Minimum value appearing in the column.

1615

# Note that for the purposes of inspection or transformation, the number

1616

# of bytes considered to comprise a 'Value' is based on its representation

1617

# as a UTF-8 encoded string. For example, if 'integer_value' is set to

1618

# 123456789, the number of bytes would be counted as 9, even though an

1619

# int64 only holds up to 8 bytes of data.

1620

"timestampValue": "A String", # timestamp

1621

"dateValue": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # date

1622

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

1623

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

1624

#

1625

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

1626

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

1627

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

1628

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

1629

#

1630

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

1631

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

1632

# a year.

1633

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

1634

# month and day.

1635

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

1636

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

1637

# significant.

1638

},

1639

"stringValue": "A String", # string

1640

"integerValue": "A String", # integer

1641

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

1642

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

1643

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

1644

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

1645

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

1646

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

1647

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

1648

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

1649

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

1650

},

1651

"booleanValue": True or False, # boolean

1652

"floatValue": 3.14, # float

1653

"dayOfWeekValue": "A String", # day of week

1654

},

1655

"maxValue": { # Set of primitive values supported by the system. # Maximum value appearing in the column.

1656

# Note that for the purposes of inspection or transformation, the number

1657

# of bytes considered to comprise a 'Value' is based on its representation

1658

# as a UTF-8 encoded string. For example, if 'integer_value' is set to

1659

# 123456789, the number of bytes would be counted as 9, even though an

1660

# int64 only holds up to 8 bytes of data.

1661

"timestampValue": "A String", # timestamp

1662

"dateValue": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # date

1663

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

1664

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

1665

#

1666

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

1667

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

1668

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

1669

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

1670

#

1671

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

1672

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

1673

# a year.

1674

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

1675

# month and day.

1676

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

1677

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

1678

# significant.

1679

},

1680

"stringValue": "A String", # string

1681

"integerValue": "A String", # integer

1682

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

1683

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

1684

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

1685

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

1686

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

1687

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

1688

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

1689

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

1690

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

1691

},

1692

"booleanValue": True or False, # boolean

1693

"floatValue": 3.14, # float

1694

"dayOfWeekValue": "A String", # day of week

1695

},

1696

"quantileValues": [ # List of 99 values that partition the set of field values into 100 equal

1697

# sized buckets.

1698

{ # Set of primitive values supported by the system.

1699

# Note that for the purposes of inspection or transformation, the number

1700

# of bytes considered to comprise a 'Value' is based on its representation

1701

# as a UTF-8 encoded string. For example, if 'integer_value' is set to

1702

# 123456789, the number of bytes would be counted as 9, even though an

1703

# int64 only holds up to 8 bytes of data.

1704

"timestampValue": "A String", # timestamp

1705

"dateValue": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # date

1706

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

1707

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

1708

#

1709

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

1710

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

1711

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

1712

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

1713

#

1714

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

1715

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

1716

# a year.

1717

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

1718

# month and day.

1719

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

1720

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

1721

# significant.

1722

},

1723

"stringValue": "A String", # string

1724

"integerValue": "A String", # integer

1725

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

1726

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

1727

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

1728

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

1729

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

1730

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

1731

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

1732

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

1733

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

1734

},

1735

"booleanValue": True or False, # boolean

1736

"floatValue": 3.14, # float

1737

"dayOfWeekValue": "A String", # day of week

},

],

},

"lDiversityResult": { # Result of the l-diversity computation. # L-divesity result

1742

"sensitiveValueFrequencyHistogramBuckets": [ # Histogram of l-diversity equivalence class sensitive value frequencies.

1743

{ # Histogram of l-diversity equivalence class sensitive value frequencies.

1744

"bucketValues": [ # Sample of equivalence classes in this bucket. The total number of

1745

# classes returned per bucket is capped at 20.

1746

{ # The set of columns' values that share the same ldiversity value.

1747

"numDistinctSensitiveValues": "A String", # Number of distinct sensitive values in this equivalence class.

1748

"topSensitiveValues": [ # Estimated frequencies of top sensitive values.

1749

{ # A value of a field, including its frequency.

1750

"count": "A String", # How many times the value is contained in the field.

1751

"value": { # Set of primitive values supported by the system. # A value contained in the field in question.

1752

# Note that for the purposes of inspection or transformation, the number

1753

# of bytes considered to comprise a 'Value' is based on its representation

1754

# as a UTF-8 encoded string. For example, if 'integer_value' is set to

1755

# 123456789, the number of bytes would be counted as 9, even though an

1756

# int64 only holds up to 8 bytes of data.

1757

"timestampValue": "A String", # timestamp

1758

"dateValue": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # date

1759

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

1760

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

1761

#

1762

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

1763

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

1764

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

1765

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

1766

#

1767

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

1768

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

1769

# a year.

1770

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

1771

# month and day.

1772

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

1773

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

1774

# significant.

1775

},

1776

"stringValue": "A String", # string

1777

"integerValue": "A String", # integer

1778

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

1779

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

1780

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

1781

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

1782

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

1783

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

1784

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

1785

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

1786

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

1787

},

1788

"booleanValue": True or False, # boolean

1789

"floatValue": 3.14, # float

1790

"dayOfWeekValue": "A String", # day of week

},

},

],

"quasiIdsValues": [ # Quasi-identifier values defining the k-anonymity equivalence

1795

# class. The order is always the same as the original request.

1796

{ # Set of primitive values supported by the system.

1797

# Note that for the purposes of inspection or transformation, the number

1798

# of bytes considered to comprise a 'Value' is based on its representation

1799

# as a UTF-8 encoded string. For example, if 'integer_value' is set to

1800

# 123456789, the number of bytes would be counted as 9, even though an

1801

# int64 only holds up to 8 bytes of data.

1802

"timestampValue": "A String", # timestamp

1803

"dateValue": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # date

1804

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

1805

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

1806

#

1807

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

1808

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

1809

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

1810

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

1811

#

1812

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

1813

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

1814

# a year.

1815

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

1816

# month and day.

1817

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

1818

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

1819

# significant.

1820

},

1821

"stringValue": "A String", # string

1822

"integerValue": "A String", # integer

1823

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

1824

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

1825

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

1826

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

1827

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

1828

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

1829

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

1830

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

1831

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

1832

},

1833

"booleanValue": True or False, # boolean

1834

"floatValue": 3.14, # float

1835

"dayOfWeekValue": "A String", # day of week

1836

},

1837

],

1838

"equivalenceClassSize": "A String", # Size of the k-anonymity equivalence class.

1839

},

1840

],

1841

"sensitiveValueFrequencyLowerBound": "A String", # Lower bound on the sensitive value frequencies of the equivalence

1842

# classes in this bucket.

1843

"sensitiveValueFrequencyUpperBound": "A String", # Upper bound on the sensitive value frequencies of the equivalence

1844

# classes in this bucket.

1845

"bucketSize": "A String", # Total number of equivalence classes in this bucket.

1846

"bucketValueCount": "A String", # Total number of distinct equivalence classes in this bucket.

1847

},

1848

],

1849

},

Bu Sun Kim

6502091

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

[diff] [blame]

1850

},

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

1851

"name": "A String", # The server-assigned name.

Bu Sun Kim

6502091

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

[diff] [blame]

1852

"errors": [ # A stream of errors encountered running the job.

1853

{ # Details information about an error encountered during job execution or

1854

# the results of an unsuccessful activation of the JobTrigger.

1855

"details": { # The `Status` type defines a logical error model that is suitable for # Detailed error codes and messages.

1856

# different programming environments, including REST APIs and RPC APIs. It is

1857

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

1858

# three pieces of data: error code, error message, and error details.

1859

#

1860

# You can find out more about this error model and how to work with it in the

1861

# [API Design Guide](https://cloud.google.com/apis/design/errors).

Bu Sun Kim

6502091

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

[diff] [blame]

1862

"message": "A String", # A developer-facing error message, which should be in English. Any

1863

# user-facing error message should be localized and sent in the

1864

# google.rpc.Status.details field, or localized by the client.

1865

"details": [ # A list of messages that carry the error details. There is a common set of

1866

# message types for APIs to use.

1867

{

1868

"a_key": "", # Properties of the object. Contains field @type with type URL.

1869

},

1870

],

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

1871

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Bu Sun Kim

6502091

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

[diff] [blame]

1872

},

1873

"timestamps": [ # The times the error occurred.

"A String",

],

},

],

Bu Sun Kim

6502091

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

[diff] [blame]

}</pre>

</div>

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

1883

<pre>Creates a job trigger to run DLP actions such as scanning storage for

1884

sensitive information on a set schedule.

1885

See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.

1886

1887

Args:

1888

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

1889

locationId: string, The geographic location to store the job trigger. Reserved for

1890

future extensions. (required)

1891

body: object, The request body.

1892

The object takes the form of:

1893

1894

{ # Request message for CreateJobTrigger.

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

1895

"locationId": "A String", # The geographic location to store the job trigger. Reserved for

1896

# future extensions.

Bu Sun Kim

6502091

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

[diff] [blame]

1897

"jobTrigger": { # Contains a configuration to make dlp api calls on a repeating basis. # Required. The JobTrigger to create.

1898

# See https://cloud.google.com/dlp/docs/concepts-job-triggers to learn more.

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

1899

"lastRunTime": "A String", # Output only. The timestamp of the last time this trigger executed.

1900

"name": "A String", # Unique resource name for the triggeredJob, assigned by the service when the

1901

# triggeredJob is created, for example

1902

# `projects/dlp-test-project/jobTriggers/53234423`.

1903

"errors": [ # Output only. A stream of errors encountered when the trigger was activated. Repeated

1904

# errors may result in the JobTrigger automatically being paused.

1905

# Will return the last 100 errors. Whenever the JobTrigger is modified

1906

# this list will be cleared.

1907

{ # Details information about an error encountered during job execution or

1908

# the results of an unsuccessful activation of the JobTrigger.

1909

"details": { # The `Status` type defines a logical error model that is suitable for # Detailed error codes and messages.

1910

# different programming environments, including REST APIs and RPC APIs. It is

1911

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

1912

# three pieces of data: error code, error message, and error details.

1913

#

1914

# You can find out more about this error model and how to work with it in the

1915

# [API Design Guide](https://cloud.google.com/apis/design/errors).

1916

"message": "A String", # A developer-facing error message, which should be in English. Any

1917

# user-facing error message should be localized and sent in the

1918

# google.rpc.Status.details field, or localized by the client.

1919

"details": [ # A list of messages that carry the error details. There is a common set of

1920

# message types for APIs to use.

1921

{

1922

"a_key": "", # Properties of the object. Contains field @type with type URL.

1923

},

1924

],

1925

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

1926

},

1927

"timestamps": [ # The times the error occurred.

"A String",

],

},

],

"description": "A String", # User provided description (max 256 chars)

Bu Sun Kim

6502091

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

[diff] [blame]

1933

"triggers": [ # A list of triggers which will be OR'ed together. Only one in the list

1934

# needs to trigger for a job to be started. The list may contain only

1935

# a single Schedule trigger and must have at least one object.

1936

{ # What event needs to occur for a new job to be started.

1937

"schedule": { # Schedule for triggeredJobs. # Create a job on a repeating basis based on the elapse of time.

1938

"recurrencePeriodDuration": "A String", # With this option a job is started a regular periodic basis. For

1939

# example: every day (86400 seconds).

1940

#

1941

# A scheduled start time will be skipped if the previous

1942

# execution has not ended when its scheduled time occurs.

1943

#

1944

# This value must be set to a time duration greater than or equal

1945

# to 1 day and can be no longer than 60 days.

1946

},

1947

"manual": { # Job trigger option for hybrid jobs. Jobs must be manually created # For use with hybrid jobs. Jobs must be manually created and finished.

1948

# Early access feature is in a pre-release state and might change or have

1949

# limited support. For more information, see

1950

# https://cloud.google.com/products#product-launch-stages.

# and finished.

},

},

],

"displayName": "A String", # Display name (max 100 chars)

1956

"createTime": "A String", # Output only. The creation timestamp of a triggeredJob.

1957

"updateTime": "A String", # Output only. The last update timestamp of a triggeredJob.

1958

"inspectJob": { # Controls what and how to inspect for findings. # For inspect jobs, a snapshot of the configuration.

1959

"inspectConfig": { # Configuration description of the scanning process. # How and what to scan for.

1960

# When used with redactContent only info_types and min_likelihood are currently

1961

# used.

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

1962

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

1963

# POSSIBLE.

1964

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

1965

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

1966

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

1967

"A String",

1968

],

1969

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

1970

# InfoType values returned by ListInfoTypes or listed at

1971

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

1972

#

1973

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

1974

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

1975

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

1976

#

1977

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

1978

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

1979

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

1980

{ # Type of information detected by the API.

1981

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

1982

# creating a CustomInfoType, or one of the names listed

1983

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

1984

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

1985

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

1986

},

1987

],

1988

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

1989

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

1990

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

1991

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

1992

# sensitive information configurable to the data in question.

1993

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

1994

# support reversing.

1995

# such as

1996

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

1997

# These types of transformations are

1998

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

1999

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

2000

# transformation such as `surrogate_info_type`. This CustomInfoType does

2001

# not support the use of `detection_rules`.

2002

},

2003

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

2004

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

2005

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

2006

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

2007

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

2008

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

2009

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

2010

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

2011

# as a custom info type.

2012

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

2013

# creating a CustomInfoType, or one of the names listed

2014

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

2015

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

2016

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

2017

},

2018

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

2019

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

2020

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

2021

42,

2022

],

2023

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

2024

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

2025

# google/re2 repository on GitHub.

2026

},

2027

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

2028

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

2029

# `surrogate_type` CustomInfoType.

2030

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

2031

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

2032

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

2033

# custom infoType.

2034

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

2035

# proximity of hotwords.

2036

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

2037

# part of a detection rule.

2038

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

2039

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

2040

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

2041

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

2042

# Likelihood may never drop below `VERY_UNLIKELY` or exceed

2043

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

2044

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

2045

# a final likelihood of `LIKELY`.

2046

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

2047

},

2048

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

2049

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

2050

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

2051

42,

2052

],

2053

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

2054

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

2055

# google/re2 repository on GitHub.

2056

},

2057

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

2058

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

2059

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

2060

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

2061

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

2062

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

2063

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

2064

# is the area code in question.

2065

# rule.

2066

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

2067

"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

2073

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

2074

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

2075

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

2076

# of employee IDs or job titles.

2077

#

2078

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

2079

# and digits in the unicode [Basic Multilingual

2080

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

2081

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

2082

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

2083

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

2084

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

2085

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

2086

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

2087

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

2088

# matches for "jennifer".

2089

#

2090

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

2091

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

2092

# are treated as whitespace. The

2093

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

2094

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

2095

# these constraints, consider using `LargeCustomDictionaryConfig` in the

2096

# `StoredInfoType` API.

2097

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

2098

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

2099

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

2100

# 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

2105

# is accepted.

2106

"path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage.

2107

# Example: gs://[BUCKET_NAME]/dictionary.txt

2108

},

2109

},

2110

"storedType": { # A reference to a StoredInfoType to use with scanning. # Load an existing `StoredInfoType` resource for use in

2111

# `InspectDataSource`. Not currently supported in `InspectContent`.

2112

"name": "A String", # Resource name of the requested `StoredInfoType`, for example

2113

# `organizations/433245324/storedInfoTypes/432452342` or

2114

# `projects/project-id/storedInfoTypes/432452342`.

2115

"createTime": "A String", # Timestamp indicating when the version of the `StoredInfoType` used for

2116

# inspection was created. Output-only field, populated by the system.

2117

},

2118

},

2119

],

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

2120

"includeQuote": True or False, # When true, a contextual quote from the data that triggered a finding is

2121

# included in the response; see Finding.quote.

2122

"ruleSet": [ # Set of rules to apply to the findings for this InspectConfig.

2123

# Exclusion rules, contained in the set are executed in the end, other

2124

# rules are executed in the order they are specified for each info type.

2125

{ # Rule set for modifying a set of infoTypes to alter behavior under certain

2126

# circumstances, depending on the specific details of the rules within the set.

2127

"infoTypes": [ # List of infoTypes this rule set is applied to.

2128

{ # Type of information detected by the API.

2129

"name": "A String", # Name of the information type. Either a name of your choosing when

2130

# creating a CustomInfoType, or one of the names listed

2131

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

2132

# a built-in type. InfoType names should conform to the pattern

2133

# `[a-zA-Z0-9_]{1,64}`.

2134

},

2135

],

2136

"rules": [ # Set of rules to be applied to infoTypes. The rules are applied in order.

2137

{ # A single inspection rule to be applied to infoTypes, specified in

2138

# `InspectionRuleSet`.

2139

"hotwordRule": { # The rule that adjusts the likelihood of findings within a certain # Hotword-based detection rule.

2140

# proximity of hotwords.

2141

"likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as # Likelihood adjustment to apply to all matching findings.

2142

# part of a detection rule.

2143

"relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of

2144

# levels. For example, if a finding would be `POSSIBLE` without the

2145

# detection rule and `relative_likelihood` is 1, then it is upgraded to

2146

# `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`.

2147

# Likelihood may never drop below `VERY_UNLIKELY` or exceed

2148

# `VERY_LIKELY`, so applying an adjustment of 1 followed by an

2149

# adjustment of -1 when base likelihood is `VERY_LIKELY` will result in

2150

# a final likelihood of `LIKELY`.

2151

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value.

2152

},

2153

"hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword.

2154

"groupIndexes": [ # The index of the submatch to extract as findings. When not

2155

# specified, the entire match is returned. No more than 3 may be included.

2156

42,

2157

],

2158

"pattern": "A String", # Pattern defining the regular expression. Its syntax

2159

# (https://github.com/google/re2/wiki/Syntax) can be found under the

2160

# google/re2 repository on GitHub.

2161

},

2162

"proximity": { # Message for specifying a window around a finding to apply a detection # Proximity of the finding within which the entire hotword must reside.

2163

# The total length of the window cannot exceed 1000 characters. Note that

2164

# the finding itself will be included in the window, so that hotwords may

2165

# be used to match substrings of the finding itself. For example, the

2166

# certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be

2167

# adjusted upwards if the area code is known to be the local area code of

2168

# a company office using the hotword regex "\(xxx\)", where "xxx"

2169

# is the area code in question.

2170

# rule.

2171

"windowBefore": 42, # Number of characters before the finding to consider.

2172

"windowAfter": 42, # Number of characters after the finding to consider.

2173

},

2174

},

2175

"exclusionRule": { # The rule that specifies conditions when findings of infoTypes specified in # Exclusion rule.

2176

# `InspectionRuleSet` are removed from results.

2177

"dictionary": { # Custom information type based on a dictionary of words or phrases. This can # Dictionary which defines the rule.

2178

# be used to match sensitive information specific to the data, such as a list

2179

# of employee IDs or job titles.

2180

#

2181

# Dictionary words are case-insensitive and all characters other than letters

2182

# and digits in the unicode [Basic Multilingual

2183

# Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane)

2184

# will be replaced with whitespace when scanning for matches, so the

2185

# dictionary phrase "Sam Johnson" will match all three phrases "sam johnson",

2186

# "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters

2187

# surrounding any match must be of a different type than the adjacent

2188

# characters within the word, so letters must be next to non-letters and

2189

# digits next to non-digits. For example, the dictionary word "jen" will

2190

# match the first three letters of the text "jen123" but will return no

2191

# matches for "jennifer".

2192

#

2193

# Dictionary words containing a large number of characters that are not

2194

# letters or digits may result in unexpected findings because such characters

2195

# are treated as whitespace. The

2196

# [limits](https://cloud.google.com/dlp/limits) page contains details about

2197

# the size limits of dictionaries. For dictionaries that do not fit within

2198

# these constraints, consider using `LargeCustomDictionaryConfig` in the

2199

# `StoredInfoType` API.

2200

"wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for.

2201

"words": [ # Words or phrases defining the dictionary. The dictionary must contain

2202

# at least one phrase and every phrase must contain at least 2 characters

2203

# 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

2208

# is accepted.

2209

"path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage.

2210

# Example: gs://[BUCKET_NAME]/dictionary.txt

2211

},

2212

},

2213

"regex": { # Message defining a custom regular expression. # Regular expression which defines the rule.

2214

"groupIndexes": [ # The index of the submatch to extract as findings. When not

2215

# specified, the entire match is returned. No more than 3 may be included.

2216

42,

2217

],

2218

"pattern": "A String", # Pattern defining the regular expression. Its syntax

2219

# (https://github.com/google/re2/wiki/Syntax) can be found under the

2220

# google/re2 repository on GitHub.

2221

},

2222

"excludeInfoTypes": { # List of exclude infoTypes. # Set of infoTypes for which findings would affect this rule.

2223

"infoTypes": [ # InfoType list in ExclusionRule rule drops a finding when it overlaps or

2224

# contained within with a finding of an infoType from this list. For

2225

# example, for `InspectionRuleSet.info_types` containing "PHONE_NUMBER"` and

2226

# `exclusion_rule` containing `exclude_info_types.info_types` with

2227

# "EMAIL_ADDRESS" the phone number findings are dropped if they overlap

2228

# with EMAIL_ADDRESS finding.

2229

# That leads to "555-222-2222@example.org" to generate only a single

2230

# finding, namely email address.

2231

{ # Type of information detected by the API.

2232

"name": "A String", # Name of the information type. Either a name of your choosing when

2233

# creating a CustomInfoType, or one of the names listed

2234

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

2235

# a built-in type. InfoType names should conform to the pattern

2236

# `[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.

2247

"maxFindingsPerItem": 42, # Max number of findings that will be returned for each item scanned.

2248

# When set within `InspectJobConfig`,

2249

# the maximum returned is 2000 regardless if this is set higher.

2250

# When set within `InspectContentRequest`, this field is ignored.

2251

"maxFindingsPerInfoType": [ # Configuration of findings limit given for specified infoTypes.

2252

{ # Max findings configuration per infoType, per content item or long

2253

# running DlpJob.

2254

"maxFindings": 42, # Max findings limit for the given infoType.

2255

"infoType": { # Type of information detected by the API. # Type of information the findings limit applies to. Only one limit per

2256

# info_type should be provided. If InfoTypeLimit does not have an

2257

# info_type, the DLP API applies the limit against all info_types that

2258

# are found but not specified in another InfoTypeLimit.

2259

"name": "A String", # Name of the information type. Either a name of your choosing when

2260

# creating a CustomInfoType, or one of the names listed

2261

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

2262

# a built-in type. InfoType names should conform to the pattern

2263

# `[a-zA-Z0-9_]{1,64}`.

},

},

],

"maxFindingsPerRequest": 42, # Max number of findings that will be returned per request/job.

2268

# When set within `InspectContentRequest`, the maximum returned is 2000

2269

# regardless if this is set higher.

2270

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

2271

},

2272

"actions": [ # Actions to execute at the completion of the job.

2273

{ # A task to execute on the completion of a job.

2274

# See https://cloud.google.com/dlp/docs/concepts-actions to learn more.

2275

"publishSummaryToCscc": { # Publish the result summary of a DlpJob to the Cloud Security # Publish summary to Cloud Security Command Center (Alpha).

2276

# Command Center (CSCC Alpha).

2277

# This action is only available for projects which are parts of

2278

# an organization and whitelisted for the alpha Cloud Security Command

2279

# Center.

2280

# The action will publish count of finding instances and their info types.

2281

# The summary of findings will be persisted in CSCC and are governed by CSCC

2282

# service-specific policy, see https://cloud.google.com/terms/service-terms

2283

# Only a single instance of this action can be specified.

2284

# Compatible with: Inspect

2285

},

2286

"jobNotificationEmails": { # Enable email notification to project owners and editors on jobs's # Enable email notification for project owners and editors on job's

2287

# completion/failure.

2288

# completion/failure.

2289

},

2290

"saveFindings": { # If set, the detailed findings will be persisted to the specified # Save resulting findings in a provided location.

2291

# OutputStorageConfig. Only a single instance of this action can be

2292

# specified.

2293

# Compatible with: Inspect, Risk

2294

"outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

2295

"table": { # Message defining the location of a BigQuery table. A table is uniquely # Store findings in an existing table or a new table in an existing

2296

# dataset. If table_id is not set a new one will be generated

2297

# for you with the following format:

2298

# dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific timezone will be used for

2299

# generating the date details.

2300

#

2301

# For Inspect, each column in an existing output table must have the same

2302

# name, type, and mode of a field in the `Finding` object.

2303

#

2304

# For Risk, an existing output table should be the output of a previous

2305

# Risk analysis job run on the same source table, with the same privacy

2306

# metric and quasi-identifiers. Risk jobs that analyze the same table but

2307

# compute a different privacy metric, or use different sets of

2308

# quasi-identifiers, cannot store their results in the same table.

2309

# identified by its project_id, dataset_id, and table_name. Within a query

2310

# a table is often referenced with a string in the format of:

2311

# `<project_id>:<dataset_id>.<table_id>` or

2312

# `<project_id>.<dataset_id>.<table_id>`.

2313

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table.

2314

# If omitted, project ID is inferred from the API call.

2315

"datasetId": "A String", # Dataset ID of the table.

2316

"tableId": "A String", # Name of the table.

2317

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

2318

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only

2319

# used for Inspect and must be unspecified for Risk jobs. Columns are derived

2320

# from the `Finding` object. If appending to an existing table, any columns

2321

# from the predefined schema that are missing will be added. No columns in

2322

# the existing table will be deleted.

2323

#

2324

# If unspecified, then all available columns will be used for a new table or

2325

# an (existing) table with no schema, and no changes will be made to an

2326

# existing table that has a schema.

2327

# Only for use with external storage.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

2328

},

2329

},

2330

"pubSub": { # Publish a message into given Pub/Sub topic when DlpJob has completed. The # Publish a notification to a pubsub topic.

2331

# message contains a single field, `DlpJobName`, which is equal to the

2332

# finished job's

2333

# [`DlpJob.name`](/dlp/docs/reference/rest/v2/projects.dlpJobs#DlpJob).

2334

# Compatible with: Inspect, Risk

2335

"topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given

2336

# publishing access rights to the DLP API service account executing

2337

# the long running DlpJob sending the notifications.

2338

# Format is projects/{project}/topics/{topic}.

2339

},

2340

"publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Cloud Data Catalog. Labels summarizing the # Publish findings to Cloud Datahub.

2341

# results of the DlpJob will be applied to the entry for the resource scanned

2342

# in Cloud Data Catalog. Any labels previously written by another DlpJob will

2343

# be deleted. InfoType naming patterns are strictly enforced when using this

2344

# feature. Note that the findings will be persisted in Cloud Data Catalog

2345

# storage and are governed by Data Catalog service-specific policy, see

2346

# https://cloud.google.com/terms/service-terms

2347

# Only a single instance of this action can be specified and only allowed if

2348

# all resources being scanned are BigQuery tables.

2349

# Compatible with: Inspect

2350

},

2351

"publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This # Enable Stackdriver metric dlp.googleapis.com/finding_count.

2352

# will publish a metric to stack driver on each infotype requested and

2353

# how many findings were found for it. CustomDetectors will be bucketed

2354

# as 'Custom' under the Stackdriver label 'info_type'.

},

},

],

"storageConfig": { # Shared message indicating Cloud storage type. # The data to scan.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

2359

"hybridOptions": { # Configuration to control jobs where the content being inspected is outside # Hybrid inspection options.

2360

# Early access feature is in a pre-release state and might change or have

2361

# limited support. For more information, see

2362

# https://cloud.google.com/products#product-launch-stages.

2363

# of Google Cloud Platform.

2364

"labels": { # To organize findings, these labels will be added to each finding.

2365

#

2366

# Label keys must be between 1 and 63 characters long and must conform

2367

# to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.

2368

#

2369

# Label values must be between 0 and 63 characters long and must conform

2370

# to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.

2371

#

2372

# No more than 10 labels can be associated with a given finding.

2373

#

2374

# Examples:

2375

# * `"environment" : "production"`

2376

# * `"pipeline" : "etl"`

2377

"a_key": "A String",

2378

},

2379

"description": "A String", # A short description of where the data is coming from. Will be stored once

2380

# in the job. 256 max length.

2381

"tableOptions": { # Instructions regarding the table content being inspected. # If the container is a table, additional information to make findings

2382

# meaningful such as the columns that are primary keys.

2383

"identifyingFields": [ # The columns that are the primary keys for table objects included in

2384

# ContentItem. A copy of this cell's value will stored alongside alongside

2385

# each finding so that the finding can be traced to the specific row it came

2386

# from. No more than 3 may be provided.

2387

{ # General identifier of a data field in a storage service.

2388

"name": "A String", # Name describing the field.

},

],

},

"requiredFindingLabelKeys": [ # These are labels that each inspection request must include within their

2393

# 'finding_labels' map. Request may contain others, but any missing one of

2394

# these will be rejected.

2395

#

2396

# Label keys must be between 1 and 63 characters long and must conform

2397

# to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.

2398

#

2399

# No more than 10 keys can be required.

2400

"A String",

2401

],

2402

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

2403

"datastoreOptions": { # Options defining a data set within Google Cloud Datastore. # Google Cloud Datastore options.

2404

"partitionId": { # Datastore partition ID. # A partition ID identifies a grouping of entities. The grouping is always

2405

# by project and namespace, however the namespace ID may be empty.

2406

# A partition ID identifies a grouping of entities. The grouping is always

2407

# by project and namespace, however the namespace ID may be empty.

2408

#

2409

# A partition ID contains several dimensions:

2410

# project ID and namespace ID.

2411

"projectId": "A String", # The ID of the project to which the entities belong.

2412

"namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.

2413

},

2414

"kind": { # A representation of a Datastore kind. # The kind to process.

2415

"name": "A String", # The name of the kind.

2416

},

2417

},

2418

"timespanConfig": { # Configuration of the timespan of the items to include in scanning.

2419

# Currently only supported when inspecting Google Cloud Storage and BigQuery.

2420

"timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items.

2421

# Used for data sources like Datastore and BigQuery.

2422

#

2423

# For BigQuery:

2424

# Required to filter out rows based on the given start and

2425

# end times. If not specified and the table was modified between the given

2426

# start and end times, the entire table will be scanned.

2427

# The valid data types of the timestamp field are: `INTEGER`, `DATE`,

2428

# `TIMESTAMP`, or `DATETIME` BigQuery column.

2429

#

2430

# For Datastore.

2431

# Valid data types of the timestamp field are: `TIMESTAMP`.

2432

# Datastore entity will be scanned if the timestamp property does not

2433

# exist or its value is empty or invalid.

2434

"name": "A String", # Name describing the field.

2435

},

2436

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out

2437

# a valid start_time to avoid scanning files that have not been modified

2438

# since the last time the JobTrigger executed. This will be based on the

2439

# time of the execution of the last run of the JobTrigger.

2440

"endTime": "A String", # Exclude files or rows newer than this value.

2441

# If set to zero, no upper time limit is applied.

2442

"startTime": "A String", # Exclude files or rows older than this value.

2443

},

2444

"cloudStorageOptions": { # Options defining a file or a set of files within a Google Cloud Storage # Google Cloud Storage options.

2445

# bucket.

2446

"bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger

2447

# than this value then the rest of the bytes are omitted. Only one

2448

# of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.

2449

"fileSet": { # Set of files to scan. # The set of one or more files to scan.

2450

"regexFileSet": { # Message representing a set of files in a Cloud Storage bucket. Regular # The regex-filtered set of files to scan. Exactly one of `url` or

2451

# `regex_file_set` must be set.

2452

# expressions are used to allow fine-grained control over which files in the

2453

# bucket to include.

2454

#

2455

# Included files are those that match at least one item in `include_regex` and

2456

# do not match any items in `exclude_regex`. Note that a file that matches

2457

# items from both lists will _not_ be included. For a match to occur, the

2458

# entire file path (i.e., everything in the url after the bucket name) must

2459

# match the regular expression.

2460

#

2461

# For example, given the input `{bucket_name: "mybucket", include_regex:

2462

# ["directory1/.*"], exclude_regex:

2463

# ["directory1/excluded.*"]}`:

2464

#

2465

# * `gs://mybucket/directory1/myfile` will be included

2466

# * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches

2467

# across `/`)

2468

# * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the

2469

# full path doesn't match any items in `include_regex`)

2470

# * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path

2471

# matches an item in `exclude_regex`)

2472

#

2473

# If `include_regex` is left empty, it will match all files by default

2474

# (this is equivalent to setting `include_regex: [".*"]`).

2475

#

2476

# Some other common use cases:

2477

#

2478

# * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all

2479

# files in `mybucket` except for .pdf files

2480

# * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will

2481

# include all files directly under `gs://mybucket/directory/`, without matching

2482

# across `/`

2483

"bucketName": "A String", # The name of a Cloud Storage bucket. Required.

2484

"includeRegex": [ # A list of regular expressions matching file paths to include. All files in

2485

# the bucket that match at least one of these regular expressions will be

2486

# included in the set of files, except for those that also match an item in

2487

# `exclude_regex`. Leaving this field empty will match all files by default

2488

# (this is equivalent to including `.*` in the list).

2489

#

2490

# Regular expressions use RE2

2491

# [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found

2492

# under the google/re2 repository on GitHub.

2493

"A String",

2494

],

2495

"excludeRegex": [ # A list of regular expressions matching file paths to exclude. All files in

2496

# the bucket that match at least one of these regular expressions will be

2497

# excluded from the scan.

2498

#

2499

# Regular expressions use RE2

2500

# [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found

2501

# under the google/re2 repository on GitHub.

"A String",

],

},

"url": "A String", # The Cloud Storage url of the file(s) to scan, in the format

2506

# `gs://<bucket>/<path>`. Trailing wildcard in the path is allowed.

2507

#

2508

# If the url ends in a trailing slash, the bucket or directory represented

2509

# by the url will be scanned non-recursively (content in sub-directories

2510

# will not be scanned). This means that `gs://mybucket/` is equivalent to

2511

# `gs://mybucket/*`, and `gs://mybucket/directory/` is equivalent to

2512

# `gs://mybucket/directory/*`.

2513

#

2514

# Exactly one of `url` or `regex_file_set` must be set.

2515

},

2516

"filesLimitPercent": 42, # Limits the number of files to scan to this percentage of the input FileSet.

2517

# Number of files scanned is rounded down. Must be between 0 and 100,

2518

# inclusively. Both 0 and 100 means no limit. Defaults to 0.

2519

"fileTypes": [ # List of file type groups to include in the scan.

2520

# If empty, all files are scanned and available data format processors

2521

# are applied. In addition, the binary content of the selected files

2522

# is always scanned as well.

2523

# Images are scanned only as binary if the specified region

2524

# does not support image inspection and no file_types were specified.

2525

# Image inspection is restricted to 'global', 'us', 'asia', and 'europe'.

2526

"A String",

2527

],

2528

"sampleMethod": "A String",

2529

"bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The

2530

# number of bytes scanned is rounded down. Must be between 0 and 100,

2531

# inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one

2532

# of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.

2533

},

2534

"bigQueryOptions": { # Options defining BigQuery table and row identifiers. # BigQuery options.

2535

"tableReference": { # Message defining the location of a BigQuery table. A table is uniquely # Complete BigQuery table reference.

2536

# identified by its project_id, dataset_id, and table_name. Within a query

2537

# a table is often referenced with a string in the format of:

2538

# `<project_id>:<dataset_id>.<table_id>` or

2539

# `<project_id>.<dataset_id>.<table_id>`.

2540

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table.

2541

# If omitted, project ID is inferred from the API call.

2542

"datasetId": "A String", # Dataset ID of the table.

2543

"tableId": "A String", # Name of the table.

2544

},

2545

"identifyingFields": [ # Table fields that may uniquely identify a row within the table. When

2546

# `actions.saveFindings.outputConfig.table` is specified, the values of

2547

# columns specified here are available in the output table under

2548

# `location.content_locations.record_location.record_key.id_values`. Nested

2549

# fields such as `person.birthdate.year` are allowed.

2550

{ # General identifier of a data field in a storage service.

2551

"name": "A String", # Name describing the field.

2552

},

2553

],

2554

"rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows

2555

# scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and

2556

# 100 means no limit. Defaults to 0. Only one of rows_limit and

2557

# rows_limit_percent can be specified. Cannot be used in conjunction with

2558

# TimespanConfig.

2559

"rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the

2560

# rest of the rows are omitted. If not set, or if set to 0, all rows will be

2561

# scanned. Only one of rows_limit and rows_limit_percent can be specified.

2562

# Cannot be used in conjunction with TimespanConfig.

2563

"excludedFields": [ # References to fields excluded from scanning. This allows you to skip

2564

# inspection of entire columns which you know have no findings.

2565

{ # General identifier of a data field in a storage service.

2566

"name": "A String", # Name describing the field.

2567

},

2568

],

2569

"sampleMethod": "A String",

2570

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

2571

},

2572

"inspectTemplateName": "A String", # If provided, will be used as the default for all values in InspectConfig.

2573

# `inspect_config` will be merged into the values persisted as part of the

2574

# template.

2575

},

2576

"status": "A String", # Required. A status for this trigger.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

2577

},

2578

"triggerId": "A String", # The trigger id can contain uppercase and lowercase letters,

2579

# numbers, and hyphens; that is, it must match the regular

2580

# expression: `[a-zA-Z\\d-_]+`. The maximum length is 100

2581

# characters. Can be empty to allow the system to generate one.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

2582

}

2583

2584

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2591

2592

{ # Contains a configuration to make dlp api calls on a repeating basis.

2593

# See https://cloud.google.com/dlp/docs/concepts-job-triggers to learn more.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

2594

"lastRunTime": "A String", # Output only. The timestamp of the last time this trigger executed.

2595

"name": "A String", # Unique resource name for the triggeredJob, assigned by the service when the

2596

# triggeredJob is created, for example

2597

# `projects/dlp-test-project/jobTriggers/53234423`.

2598

"errors": [ # Output only. A stream of errors encountered when the trigger was activated. Repeated

2599

# errors may result in the JobTrigger automatically being paused.

2600

# Will return the last 100 errors. Whenever the JobTrigger is modified

2601

# this list will be cleared.

2602

{ # Details information about an error encountered during job execution or

2603

# the results of an unsuccessful activation of the JobTrigger.

2604

"details": { # The `Status` type defines a logical error model that is suitable for # Detailed error codes and messages.

2605

# different programming environments, including REST APIs and RPC APIs. It is

2606

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

2607

# three pieces of data: error code, error message, and error details.

2608

#

2609

# You can find out more about this error model and how to work with it in the

2610

# [API Design Guide](https://cloud.google.com/apis/design/errors).

2611

"message": "A String", # A developer-facing error message, which should be in English. Any

2612

# user-facing error message should be localized and sent in the

2613

# google.rpc.Status.details field, or localized by the client.

2614

"details": [ # A list of messages that carry the error details. There is a common set of

2615

# message types for APIs to use.

2616

{

2617

"a_key": "", # Properties of the object. Contains field @type with type URL.

2618

},

2619

],

2620

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

2621

},

2622

"timestamps": [ # The times the error occurred.

"A String",

],

},

],

"description": "A String", # User provided description (max 256 chars)

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

2628

"triggers": [ # A list of triggers which will be OR'ed together. Only one in the list

2629

# needs to trigger for a job to be started. The list may contain only

2630

# a single Schedule trigger and must have at least one object.

2631

{ # What event needs to occur for a new job to be started.

2632

"schedule": { # Schedule for triggeredJobs. # Create a job on a repeating basis based on the elapse of time.

2633

"recurrencePeriodDuration": "A String", # With this option a job is started a regular periodic basis. For

2634

# example: every day (86400 seconds).

2635

#

2636

# A scheduled start time will be skipped if the previous

2637

# execution has not ended when its scheduled time occurs.

2638

#

2639

# This value must be set to a time duration greater than or equal

2640

# to 1 day and can be no longer than 60 days.

2641

},

2642

"manual": { # Job trigger option for hybrid jobs. Jobs must be manually created # For use with hybrid jobs. Jobs must be manually created and finished.

2643

# Early access feature is in a pre-release state and might change or have

2644

# limited support. For more information, see

2645

# https://cloud.google.com/products#product-launch-stages.

# and finished.

},

},

],

"displayName": "A String", # Display name (max 100 chars)

2651

"createTime": "A String", # Output only. The creation timestamp of a triggeredJob.

2652

"updateTime": "A String", # Output only. The last update timestamp of a triggeredJob.

2653

"inspectJob": { # Controls what and how to inspect for findings. # For inspect jobs, a snapshot of the configuration.

2654

"inspectConfig": { # Configuration description of the scanning process. # How and what to scan for.

2655

# When used with redactContent only info_types and min_likelihood are currently

2656

# used.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

2657

"minLikelihood": "A String", # Only returns findings equal or above this threshold. The default is

2658

# POSSIBLE.

2659

# See https://cloud.google.com/dlp/docs/likelihood to learn more.

2660

"contentOptions": [ # List of options defining data content to scan.

2661

# If empty, text, images, and other content will be included.

2662

"A String",

2663

],

2664

"infoTypes": [ # Restricts what info_types to look for. The values must correspond to

2665

# InfoType values returned by ListInfoTypes or listed at

2666

# https://cloud.google.com/dlp/docs/infotypes-reference.

2667

#

2668

# When no InfoTypes or CustomInfoTypes are specified in a request, the

2669

# system may automatically choose what detectors to run. By default this may

2670

# be all types, but may change over time as detectors are updated.

2671

#

2672

# If you need precise control and predictability as to what detectors are

2673

# run you should specify specific InfoTypes listed in the reference,

2674

# otherwise a default list will be used, which may change over time.

2675

{ # Type of information detected by the API.

2676

"name": "A String", # Name of the information type. Either a name of your choosing when

2677

# creating a CustomInfoType, or one of the names listed

2678

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

2679

# a built-in type. InfoType names should conform to the pattern

2680

# `[a-zA-Z0-9_]{1,64}`.

2681

},

2682

],

2683

"excludeInfoTypes": True or False, # When true, excludes type information of the findings.

2684

"customInfoTypes": [ # CustomInfoTypes provided by the user. See

2685

# https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more.

2686

{ # Custom information type provided by the user. Used to find domain-specific

2687

# sensitive information configurable to the data in question.

2688

"surrogateType": { # Message for detecting output from deidentification transformations # Message for detecting output from deidentification transformations that

2689

# support reversing.

2690

# such as

2691

# [`CryptoReplaceFfxFpeConfig`](/dlp/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig).

2692

# These types of transformations are

2693

# those that perform pseudonymization, thereby producing a "surrogate" as

2694

# output. This should be used in conjunction with a field on the

2695

# transformation such as `surrogate_info_type`. This CustomInfoType does

2696

# not support the use of `detection_rules`.

2697

},

2698

"likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be

2699

# altered by a detection rule if the finding meets the criteria specified by

2700

# the rule. Defaults to `VERY_LIKELY` if not specified.

2701

"infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in

2702

# infoType, when the name matches one of existing infoTypes and that infoType

2703

# is specified in `InspectContent.info_types` field. Specifying the latter

2704

# adds findings to the one detected by the system. If built-in info type is

2705

# not specified in `InspectContent.info_types` list then the name is treated

2706

# as a custom info type.

2707

"name": "A String", # Name of the information type. Either a name of your choosing when

2708

# creating a CustomInfoType, or one of the names listed

2709

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

2710

# a built-in type. InfoType names should conform to the pattern

2711

# `[a-zA-Z0-9_]{1,64}`.

2712

},

2713

"regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType.

2714

"groupIndexes": [ # The index of the submatch to extract as findings. When not

2715

# specified, the entire match is returned. No more than 3 may be included.

2716

42,

2717

],

2718

"pattern": "A String", # Pattern defining the regular expression. Its syntax

2719

# (https://github.com/google/re2/wiki/Syntax) can be found under the

2720

# google/re2 repository on GitHub.

2721

},

2722

"detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType.

2723

# Rules are applied in order that they are specified. Not supported for the

2724

# `surrogate_type` CustomInfoType.

2725

{ # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a

2726

# `CustomInfoType` to alter behavior under certain circumstances, depending

2727

# on the specific details of the rule. Not supported for the `surrogate_type`

2728

# custom infoType.

2729

"hotwordRule": { # The rule that adjusts the likelihood of findings within a certain # Hotword-based detection rule.

2730

# proximity of hotwords.

2731

"likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as # Likelihood adjustment to apply to all matching findings.

2732

# part of a detection rule.

2733

"relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of

2734

# levels. For example, if a finding would be `POSSIBLE` without the

2735

# detection rule and `relative_likelihood` is 1, then it is upgraded to

2736

# `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`.

2737

# Likelihood may never drop below `VERY_UNLIKELY` or exceed

2738

# `VERY_LIKELY`, so applying an adjustment of 1 followed by an

2739

# adjustment of -1 when base likelihood is `VERY_LIKELY` will result in

2740

# a final likelihood of `LIKELY`.

2741

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value.

2742

},

2743

"hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword.

2744

"groupIndexes": [ # The index of the submatch to extract as findings. When not

2745

# specified, the entire match is returned. No more than 3 may be included.

2746

42,

2747

],

2748

"pattern": "A String", # Pattern defining the regular expression. Its syntax

2749

# (https://github.com/google/re2/wiki/Syntax) can be found under the

2750

# google/re2 repository on GitHub.

2751

},

2752

"proximity": { # Message for specifying a window around a finding to apply a detection # Proximity of the finding within which the entire hotword must reside.

2753

# The total length of the window cannot exceed 1000 characters. Note that

2754

# the finding itself will be included in the window, so that hotwords may

2755

# be used to match substrings of the finding itself. For example, the

2756

# certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be

2757

# adjusted upwards if the area code is known to be the local area code of

2758

# a company office using the hotword regex "\(xxx\)", where "xxx"

2759

# is the area code in question.

2760

# rule.

2761

"windowBefore": 42, # Number of characters before the finding to consider.

2762

"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

2768

# to be returned. It still can be used for rules matching.

2769

"dictionary": { # Custom information type based on a dictionary of words or phrases. This can # A list of phrases to detect as a CustomInfoType.

2770

# be used to match sensitive information specific to the data, such as a list

2771

# of employee IDs or job titles.

2772

#

2773

# Dictionary words are case-insensitive and all characters other than letters

2774

# and digits in the unicode [Basic Multilingual

2775

# Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane)

2776

# will be replaced with whitespace when scanning for matches, so the

2777

# dictionary phrase "Sam Johnson" will match all three phrases "sam johnson",

2778

# "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters

2779

# surrounding any match must be of a different type than the adjacent

2780

# characters within the word, so letters must be next to non-letters and

2781

# digits next to non-digits. For example, the dictionary word "jen" will

2782

# match the first three letters of the text "jen123" but will return no

2783

# matches for "jennifer".

2784

#

2785

# Dictionary words containing a large number of characters that are not

2786

# letters or digits may result in unexpected findings because such characters

2787

# are treated as whitespace. The

2788

# [limits](https://cloud.google.com/dlp/limits) page contains details about

2789

# the size limits of dictionaries. For dictionaries that do not fit within

2790

# these constraints, consider using `LargeCustomDictionaryConfig` in the

2791

# `StoredInfoType` API.

2792

"wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for.

2793

"words": [ # Words or phrases defining the dictionary. The dictionary must contain

2794

# at least one phrase and every phrase must contain at least 2 characters

2795

# 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

2800

# is accepted.

2801

"path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage.

2802

# Example: gs://[BUCKET_NAME]/dictionary.txt

2803

},

2804

},

2805

"storedType": { # A reference to a StoredInfoType to use with scanning. # Load an existing `StoredInfoType` resource for use in

2806

# `InspectDataSource`. Not currently supported in `InspectContent`.

2807

"name": "A String", # Resource name of the requested `StoredInfoType`, for example

2808

# `organizations/433245324/storedInfoTypes/432452342` or

2809

# `projects/project-id/storedInfoTypes/432452342`.

2810

"createTime": "A String", # Timestamp indicating when the version of the `StoredInfoType` used for

2811

# inspection was created. Output-only field, populated by the system.

2812

},

2813

},

2814

],

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

2815

"includeQuote": True or False, # When true, a contextual quote from the data that triggered a finding is

2816

# included in the response; see Finding.quote.

2817

"ruleSet": [ # Set of rules to apply to the findings for this InspectConfig.

2818

# Exclusion rules, contained in the set are executed in the end, other

2819

# rules are executed in the order they are specified for each info type.

2820

{ # Rule set for modifying a set of infoTypes to alter behavior under certain

2821

# circumstances, depending on the specific details of the rules within the set.

2822

"infoTypes": [ # List of infoTypes this rule set is applied to.

2823

{ # Type of information detected by the API.

2824

"name": "A String", # Name of the information type. Either a name of your choosing when

2825

# creating a CustomInfoType, or one of the names listed

2826

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

2827

# a built-in type. InfoType names should conform to the pattern

2828

# `[a-zA-Z0-9_]{1,64}`.

2829

},

2830

],

2831

"rules": [ # Set of rules to be applied to infoTypes. The rules are applied in order.

2832

{ # A single inspection rule to be applied to infoTypes, specified in

2833

# `InspectionRuleSet`.

2834

"hotwordRule": { # The rule that adjusts the likelihood of findings within a certain # Hotword-based detection rule.

2835

# proximity of hotwords.

2836

"likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as # Likelihood adjustment to apply to all matching findings.

2837

# part of a detection rule.

2838

"relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of

2839

# levels. For example, if a finding would be `POSSIBLE` without the

2840

# detection rule and `relative_likelihood` is 1, then it is upgraded to

2841

# `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`.

2842

# Likelihood may never drop below `VERY_UNLIKELY` or exceed

2843

# `VERY_LIKELY`, so applying an adjustment of 1 followed by an

2844

# adjustment of -1 when base likelihood is `VERY_LIKELY` will result in

2845

# a final likelihood of `LIKELY`.

2846

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value.

2847

},

2848

"hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword.

2849

"groupIndexes": [ # The index of the submatch to extract as findings. When not

2850

# specified, the entire match is returned. No more than 3 may be included.

2851

42,

2852

],

2853

"pattern": "A String", # Pattern defining the regular expression. Its syntax

2854

# (https://github.com/google/re2/wiki/Syntax) can be found under the

2855

# google/re2 repository on GitHub.

2856

},

2857

"proximity": { # Message for specifying a window around a finding to apply a detection # Proximity of the finding within which the entire hotword must reside.

2858

# The total length of the window cannot exceed 1000 characters. Note that

2859

# the finding itself will be included in the window, so that hotwords may

2860

# be used to match substrings of the finding itself. For example, the

2861

# certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be

2862

# adjusted upwards if the area code is known to be the local area code of

2863

# a company office using the hotword regex "\(xxx\)", where "xxx"

2864

# is the area code in question.

2865

# rule.

2866

"windowBefore": 42, # Number of characters before the finding to consider.

2867

"windowAfter": 42, # Number of characters after the finding to consider.

2868

},

2869

},

2870

"exclusionRule": { # The rule that specifies conditions when findings of infoTypes specified in # Exclusion rule.

2871

# `InspectionRuleSet` are removed from results.

2872

"dictionary": { # Custom information type based on a dictionary of words or phrases. This can # Dictionary which defines the rule.

2873

# be used to match sensitive information specific to the data, such as a list

2874

# of employee IDs or job titles.

2875

#

2876

# Dictionary words are case-insensitive and all characters other than letters

2877

# and digits in the unicode [Basic Multilingual

2878

# Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane)

2879

# will be replaced with whitespace when scanning for matches, so the

2880

# dictionary phrase "Sam Johnson" will match all three phrases "sam johnson",

2881

# "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters

2882

# surrounding any match must be of a different type than the adjacent

2883

# characters within the word, so letters must be next to non-letters and

2884

# digits next to non-digits. For example, the dictionary word "jen" will

2885

# match the first three letters of the text "jen123" but will return no

2886

# matches for "jennifer".

2887

#

2888

# Dictionary words containing a large number of characters that are not

2889

# letters or digits may result in unexpected findings because such characters

2890

# are treated as whitespace. The

2891

# [limits](https://cloud.google.com/dlp/limits) page contains details about

2892

# the size limits of dictionaries. For dictionaries that do not fit within

2893

# these constraints, consider using `LargeCustomDictionaryConfig` in the

2894

# `StoredInfoType` API.

2895

"wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for.

2896

"words": [ # Words or phrases defining the dictionary. The dictionary must contain

2897

# at least one phrase and every phrase must contain at least 2 characters

2898

# 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

2903

# is accepted.

2904

"path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage.

2905

# Example: gs://[BUCKET_NAME]/dictionary.txt

2906

},

2907

},

2908

"regex": { # Message defining a custom regular expression. # Regular expression which defines the rule.

2909

"groupIndexes": [ # The index of the submatch to extract as findings. When not

2910

# specified, the entire match is returned. No more than 3 may be included.

2911

42,

2912

],

2913

"pattern": "A String", # Pattern defining the regular expression. Its syntax

2914

# (https://github.com/google/re2/wiki/Syntax) can be found under the

2915

# google/re2 repository on GitHub.

2916

},

2917

"excludeInfoTypes": { # List of exclude infoTypes. # Set of infoTypes for which findings would affect this rule.

2918

"infoTypes": [ # InfoType list in ExclusionRule rule drops a finding when it overlaps or

2919

# contained within with a finding of an infoType from this list. For

2920

# example, for `InspectionRuleSet.info_types` containing "PHONE_NUMBER"` and

2921

# `exclusion_rule` containing `exclude_info_types.info_types` with

2922

# "EMAIL_ADDRESS" the phone number findings are dropped if they overlap

2923

# with EMAIL_ADDRESS finding.

2924

# That leads to "555-222-2222@example.org" to generate only a single

2925

# finding, namely email address.

2926

{ # Type of information detected by the API.

2927

"name": "A String", # Name of the information type. Either a name of your choosing when

2928

# creating a CustomInfoType, or one of the names listed

2929

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

2930

# a built-in type. InfoType names should conform to the pattern

2931

# `[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.

2942

"maxFindingsPerItem": 42, # Max number of findings that will be returned for each item scanned.

2943

# When set within `InspectJobConfig`,

2944

# the maximum returned is 2000 regardless if this is set higher.

2945

# When set within `InspectContentRequest`, this field is ignored.

2946

"maxFindingsPerInfoType": [ # Configuration of findings limit given for specified infoTypes.

2947

{ # Max findings configuration per infoType, per content item or long

2948

# running DlpJob.

2949

"maxFindings": 42, # Max findings limit for the given infoType.

2950

"infoType": { # Type of information detected by the API. # Type of information the findings limit applies to. Only one limit per

2951

# info_type should be provided. If InfoTypeLimit does not have an

2952

# info_type, the DLP API applies the limit against all info_types that

2953

# are found but not specified in another InfoTypeLimit.

2954

"name": "A String", # Name of the information type. Either a name of your choosing when

2955

# creating a CustomInfoType, or one of the names listed

2956

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

2957

# a built-in type. InfoType names should conform to the pattern

2958

# `[a-zA-Z0-9_]{1,64}`.

},

},

],

"maxFindingsPerRequest": 42, # Max number of findings that will be returned per request/job.

2963

# When set within `InspectContentRequest`, the maximum returned is 2000

2964

# regardless if this is set higher.

2965

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

2966

},

2967

"actions": [ # Actions to execute at the completion of the job.

2968

{ # A task to execute on the completion of a job.

2969

# See https://cloud.google.com/dlp/docs/concepts-actions to learn more.

2970

"publishSummaryToCscc": { # Publish the result summary of a DlpJob to the Cloud Security # Publish summary to Cloud Security Command Center (Alpha).

2971

# Command Center (CSCC Alpha).

2972

# This action is only available for projects which are parts of

2973

# an organization and whitelisted for the alpha Cloud Security Command

2974

# Center.

2975

# The action will publish count of finding instances and their info types.

2976

# The summary of findings will be persisted in CSCC and are governed by CSCC

2977

# service-specific policy, see https://cloud.google.com/terms/service-terms

2978

# Only a single instance of this action can be specified.

2979

# Compatible with: Inspect

2980

},

2981

"jobNotificationEmails": { # Enable email notification to project owners and editors on jobs's # Enable email notification for project owners and editors on job's

2982

# completion/failure.

2983

# completion/failure.

2984

},

2985

"saveFindings": { # If set, the detailed findings will be persisted to the specified # Save resulting findings in a provided location.

2986

# OutputStorageConfig. Only a single instance of this action can be

2987

# specified.

2988

# Compatible with: Inspect, Risk

2989

"outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

2990

"table": { # Message defining the location of a BigQuery table. A table is uniquely # Store findings in an existing table or a new table in an existing

2991

# dataset. If table_id is not set a new one will be generated

2992

# for you with the following format:

2993

# dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific timezone will be used for

2994

# generating the date details.

2995

#

2996

# For Inspect, each column in an existing output table must have the same

2997

# name, type, and mode of a field in the `Finding` object.

2998

#

2999

# For Risk, an existing output table should be the output of a previous

3000

# Risk analysis job run on the same source table, with the same privacy

3001

# metric and quasi-identifiers. Risk jobs that analyze the same table but

3002

# compute a different privacy metric, or use different sets of

3003

# quasi-identifiers, cannot store their results in the same table.

3004

# identified by its project_id, dataset_id, and table_name. Within a query

3005

# a table is often referenced with a string in the format of:

3006

# `<project_id>:<dataset_id>.<table_id>` or

3007

# `<project_id>.<dataset_id>.<table_id>`.

3008

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table.

3009

# If omitted, project ID is inferred from the API call.

3010

"datasetId": "A String", # Dataset ID of the table.

3011

"tableId": "A String", # Name of the table.

3012

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

3013

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only

3014

# used for Inspect and must be unspecified for Risk jobs. Columns are derived

3015

# from the `Finding` object. If appending to an existing table, any columns

3016

# from the predefined schema that are missing will be added. No columns in

3017

# the existing table will be deleted.

3018

#

3019

# If unspecified, then all available columns will be used for a new table or

3020

# an (existing) table with no schema, and no changes will be made to an

3021

# existing table that has a schema.

3022

# Only for use with external storage.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

3023

},

3024

},

3025

"pubSub": { # Publish a message into given Pub/Sub topic when DlpJob has completed. The # Publish a notification to a pubsub topic.

3026

# message contains a single field, `DlpJobName`, which is equal to the

3027

# finished job's

3028

# [`DlpJob.name`](/dlp/docs/reference/rest/v2/projects.dlpJobs#DlpJob).

3029

# Compatible with: Inspect, Risk

3030

"topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given

3031

# publishing access rights to the DLP API service account executing

3032

# the long running DlpJob sending the notifications.

3033

# Format is projects/{project}/topics/{topic}.

3034

},

3035

"publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Cloud Data Catalog. Labels summarizing the # Publish findings to Cloud Datahub.

3036

# results of the DlpJob will be applied to the entry for the resource scanned

3037

# in Cloud Data Catalog. Any labels previously written by another DlpJob will

3038

# be deleted. InfoType naming patterns are strictly enforced when using this

3039

# feature. Note that the findings will be persisted in Cloud Data Catalog

3040

# storage and are governed by Data Catalog service-specific policy, see

3041

# https://cloud.google.com/terms/service-terms

3042

# Only a single instance of this action can be specified and only allowed if

3043

# all resources being scanned are BigQuery tables.

3044

# Compatible with: Inspect

3045

},

3046

"publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This # Enable Stackdriver metric dlp.googleapis.com/finding_count.

3047

# will publish a metric to stack driver on each infotype requested and

3048

# how many findings were found for it. CustomDetectors will be bucketed

3049

# as 'Custom' under the Stackdriver label 'info_type'.

},

},

],

"storageConfig": { # Shared message indicating Cloud storage type. # The data to scan.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

3054

"hybridOptions": { # Configuration to control jobs where the content being inspected is outside # Hybrid inspection options.

3055

# Early access feature is in a pre-release state and might change or have

3056

# limited support. For more information, see

3057

# https://cloud.google.com/products#product-launch-stages.

3058

# of Google Cloud Platform.

3059

"labels": { # To organize findings, these labels will be added to each finding.

3060

#

3061

# Label keys must be between 1 and 63 characters long and must conform

3062

# to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.

3063

#

3064

# Label values must be between 0 and 63 characters long and must conform

3065

# to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.

3066

#

3067

# No more than 10 labels can be associated with a given finding.

3068

#

3069

# Examples:

3070

# * `"environment" : "production"`

3071

# * `"pipeline" : "etl"`

3072

"a_key": "A String",

3073

},

3074

"description": "A String", # A short description of where the data is coming from. Will be stored once

3075

# in the job. 256 max length.

3076

"tableOptions": { # Instructions regarding the table content being inspected. # If the container is a table, additional information to make findings

3077

# meaningful such as the columns that are primary keys.

3078

"identifyingFields": [ # The columns that are the primary keys for table objects included in

3079

# ContentItem. A copy of this cell's value will stored alongside alongside

3080

# each finding so that the finding can be traced to the specific row it came

3081

# from. No more than 3 may be provided.

3082

{ # General identifier of a data field in a storage service.

3083

"name": "A String", # Name describing the field.

},

],

},

"requiredFindingLabelKeys": [ # These are labels that each inspection request must include within their

3088

# 'finding_labels' map. Request may contain others, but any missing one of

3089

# these will be rejected.

3090

#

3091

# Label keys must be between 1 and 63 characters long and must conform

3092

# to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.

3093

#

3094

# No more than 10 keys can be required.

3095

"A String",

3096

],

3097

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

3098

"datastoreOptions": { # Options defining a data set within Google Cloud Datastore. # Google Cloud Datastore options.

3099

"partitionId": { # Datastore partition ID. # A partition ID identifies a grouping of entities. The grouping is always

3100

# by project and namespace, however the namespace ID may be empty.

3101

# A partition ID identifies a grouping of entities. The grouping is always

3102

# by project and namespace, however the namespace ID may be empty.

3103

#

3104

# A partition ID contains several dimensions:

3105

# project ID and namespace ID.

3106

"projectId": "A String", # The ID of the project to which the entities belong.

3107

"namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.

3108

},

3109

"kind": { # A representation of a Datastore kind. # The kind to process.

3110

"name": "A String", # The name of the kind.

3111

},

3112

},

3113

"timespanConfig": { # Configuration of the timespan of the items to include in scanning.

3114

# Currently only supported when inspecting Google Cloud Storage and BigQuery.

3115

"timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items.

3116

# Used for data sources like Datastore and BigQuery.

3117

#

3118

# For BigQuery:

3119

# Required to filter out rows based on the given start and

3120

# end times. If not specified and the table was modified between the given

3121

# start and end times, the entire table will be scanned.

3122

# The valid data types of the timestamp field are: `INTEGER`, `DATE`,

3123

# `TIMESTAMP`, or `DATETIME` BigQuery column.

3124

#

3125

# For Datastore.

3126

# Valid data types of the timestamp field are: `TIMESTAMP`.

3127

# Datastore entity will be scanned if the timestamp property does not

3128

# exist or its value is empty or invalid.

3129

"name": "A String", # Name describing the field.

3130

},

3131

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out

3132

# a valid start_time to avoid scanning files that have not been modified

3133

# since the last time the JobTrigger executed. This will be based on the

3134

# time of the execution of the last run of the JobTrigger.

3135

"endTime": "A String", # Exclude files or rows newer than this value.

3136

# If set to zero, no upper time limit is applied.

3137

"startTime": "A String", # Exclude files or rows older than this value.

3138

},

3139

"cloudStorageOptions": { # Options defining a file or a set of files within a Google Cloud Storage # Google Cloud Storage options.

3140

# bucket.

3141

"bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger

3142

# than this value then the rest of the bytes are omitted. Only one

3143

# of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.

3144

"fileSet": { # Set of files to scan. # The set of one or more files to scan.

3145

"regexFileSet": { # Message representing a set of files in a Cloud Storage bucket. Regular # The regex-filtered set of files to scan. Exactly one of `url` or

3146

# `regex_file_set` must be set.

3147

# expressions are used to allow fine-grained control over which files in the

3148

# bucket to include.

3149

#

3150

# Included files are those that match at least one item in `include_regex` and

3151

# do not match any items in `exclude_regex`. Note that a file that matches

3152

# items from both lists will _not_ be included. For a match to occur, the

3153

# entire file path (i.e., everything in the url after the bucket name) must

3154

# match the regular expression.

3155

#

3156

# For example, given the input `{bucket_name: "mybucket", include_regex:

3157

# ["directory1/.*"], exclude_regex:

3158

# ["directory1/excluded.*"]}`:

3159

#

3160

# * `gs://mybucket/directory1/myfile` will be included

3161

# * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches

3162

# across `/`)

3163

# * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the

3164

# full path doesn't match any items in `include_regex`)

3165

# * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path

3166

# matches an item in `exclude_regex`)

3167

#

3168

# If `include_regex` is left empty, it will match all files by default

3169

# (this is equivalent to setting `include_regex: [".*"]`).

3170

#

3171

# Some other common use cases:

3172

#

3173

# * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all

3174

# files in `mybucket` except for .pdf files

3175

# * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will

3176

# include all files directly under `gs://mybucket/directory/`, without matching

3177

# across `/`

3178

"bucketName": "A String", # The name of a Cloud Storage bucket. Required.

3179

"includeRegex": [ # A list of regular expressions matching file paths to include. All files in

3180

# the bucket that match at least one of these regular expressions will be

3181

# included in the set of files, except for those that also match an item in

3182

# `exclude_regex`. Leaving this field empty will match all files by default

3183

# (this is equivalent to including `.*` in the list).

3184

#

3185

# Regular expressions use RE2

3186

# [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found

3187

# under the google/re2 repository on GitHub.

3188

"A String",

3189

],

3190

"excludeRegex": [ # A list of regular expressions matching file paths to exclude. All files in

3191

# the bucket that match at least one of these regular expressions will be

3192

# excluded from the scan.

3193

#

3194

# Regular expressions use RE2

3195

# [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found

3196

# under the google/re2 repository on GitHub.

"A String",

],

},

"url": "A String", # The Cloud Storage url of the file(s) to scan, in the format

3201

# `gs://<bucket>/<path>`. Trailing wildcard in the path is allowed.

3202

#

3203

# If the url ends in a trailing slash, the bucket or directory represented

3204

# by the url will be scanned non-recursively (content in sub-directories

3205

# will not be scanned). This means that `gs://mybucket/` is equivalent to

3206

# `gs://mybucket/*`, and `gs://mybucket/directory/` is equivalent to

3207

# `gs://mybucket/directory/*`.

3208

#

3209

# Exactly one of `url` or `regex_file_set` must be set.

3210

},

3211

"filesLimitPercent": 42, # Limits the number of files to scan to this percentage of the input FileSet.

3212

# Number of files scanned is rounded down. Must be between 0 and 100,

3213

# inclusively. Both 0 and 100 means no limit. Defaults to 0.

3214

"fileTypes": [ # List of file type groups to include in the scan.

3215

# If empty, all files are scanned and available data format processors

3216

# are applied. In addition, the binary content of the selected files

3217

# is always scanned as well.

3218

# Images are scanned only as binary if the specified region

3219

# does not support image inspection and no file_types were specified.

3220

# Image inspection is restricted to 'global', 'us', 'asia', and 'europe'.

3221

"A String",

3222

],

3223

"sampleMethod": "A String",

3224

"bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The

3225

# number of bytes scanned is rounded down. Must be between 0 and 100,

3226

# inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one

3227

# of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.

3228

},

3229

"bigQueryOptions": { # Options defining BigQuery table and row identifiers. # BigQuery options.

3230

"tableReference": { # Message defining the location of a BigQuery table. A table is uniquely # Complete BigQuery table reference.

3231

# identified by its project_id, dataset_id, and table_name. Within a query

3232

# a table is often referenced with a string in the format of:

3233

# `<project_id>:<dataset_id>.<table_id>` or

3234

# `<project_id>.<dataset_id>.<table_id>`.

3235

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table.

3236

# If omitted, project ID is inferred from the API call.

3237

"datasetId": "A String", # Dataset ID of the table.

3238

"tableId": "A String", # Name of the table.

3239

},

3240

"identifyingFields": [ # Table fields that may uniquely identify a row within the table. When

3241

# `actions.saveFindings.outputConfig.table` is specified, the values of

3242

# columns specified here are available in the output table under

3243

# `location.content_locations.record_location.record_key.id_values`. Nested

3244

# fields such as `person.birthdate.year` are allowed.

3245

{ # General identifier of a data field in a storage service.

3246

"name": "A String", # Name describing the field.

3247

},

3248

],

3249

"rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows

3250

# scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and

3251

# 100 means no limit. Defaults to 0. Only one of rows_limit and

3252

# rows_limit_percent can be specified. Cannot be used in conjunction with

3253

# TimespanConfig.

3254

"rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the

3255

# rest of the rows are omitted. If not set, or if set to 0, all rows will be

3256

# scanned. Only one of rows_limit and rows_limit_percent can be specified.

3257

# Cannot be used in conjunction with TimespanConfig.

3258

"excludedFields": [ # References to fields excluded from scanning. This allows you to skip

3259

# inspection of entire columns which you know have no findings.

3260

{ # General identifier of a data field in a storage service.

3261

"name": "A String", # Name describing the field.

3262

},

3263

],

3264

"sampleMethod": "A String",

3265

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

3266

},

3267

"inspectTemplateName": "A String", # If provided, will be used as the default for all values in InspectConfig.

3268

# `inspect_config` will be merged into the values persisted as part of the

3269

# template.

3270

},

3271

"status": "A String", # Required. A status for this trigger.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="delete">delete(name, x__xgafv=None)</code>

3277

<pre>Deletes a job trigger.

3278

See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.

3279

3280

Args:

3281

name: string, Required. Resource name of the project and the triggeredJob, for example

3282

`projects/dlp-test-project/jobTriggers/53234423`. (required)

3283

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3290

3291

{ # A generic empty message that you can re-use to avoid defining duplicated

3292

# empty messages in your APIs. A typical example is to use it as the request

3293

# or the response type of an API method. For instance:

3294

#

3295

# service Foo {

3296

# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

3297

# }

3298

#

3299

# The JSON representation for `Empty` is empty JSON object `{}`.

}</pre>

</div>

<code class="details" id="get">get(name, x__xgafv=None)</code>

3305

<pre>Gets a job trigger.

3306

See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.

3307

3308

Args:

3309

name: string, Required. Resource name of the project and the triggeredJob, for example

3310

`projects/dlp-test-project/jobTriggers/53234423`. (required)

3311

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3318

3319

{ # Contains a configuration to make dlp api calls on a repeating basis.

3320

# See https://cloud.google.com/dlp/docs/concepts-job-triggers to learn more.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

3321

"lastRunTime": "A String", # Output only. The timestamp of the last time this trigger executed.

3322

"name": "A String", # Unique resource name for the triggeredJob, assigned by the service when the

3323

# triggeredJob is created, for example

3324

# `projects/dlp-test-project/jobTriggers/53234423`.

3325

"errors": [ # Output only. A stream of errors encountered when the trigger was activated. Repeated

3326

# errors may result in the JobTrigger automatically being paused.

3327

# Will return the last 100 errors. Whenever the JobTrigger is modified

3328

# this list will be cleared.

3329

{ # Details information about an error encountered during job execution or

3330

# the results of an unsuccessful activation of the JobTrigger.

3331

"details": { # The `Status` type defines a logical error model that is suitable for # Detailed error codes and messages.

3332

# different programming environments, including REST APIs and RPC APIs. It is

3333

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

3334

# three pieces of data: error code, error message, and error details.

3335

#

3336

# You can find out more about this error model and how to work with it in the

3337

# [API Design Guide](https://cloud.google.com/apis/design/errors).

3338

"message": "A String", # A developer-facing error message, which should be in English. Any

3339

# user-facing error message should be localized and sent in the

3340

# google.rpc.Status.details field, or localized by the client.

3341

"details": [ # A list of messages that carry the error details. There is a common set of

3342

# message types for APIs to use.

3343

{

3344

"a_key": "", # Properties of the object. Contains field @type with type URL.

3345

},

3346

],

3347

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

3348

},

3349

"timestamps": [ # The times the error occurred.

"A String",

],

},

],

"description": "A String", # User provided description (max 256 chars)

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

3355

"triggers": [ # A list of triggers which will be OR'ed together. Only one in the list

3356

# needs to trigger for a job to be started. The list may contain only

3357

# a single Schedule trigger and must have at least one object.

3358

{ # What event needs to occur for a new job to be started.

3359

"schedule": { # Schedule for triggeredJobs. # Create a job on a repeating basis based on the elapse of time.

3360

"recurrencePeriodDuration": "A String", # With this option a job is started a regular periodic basis. For

3361

# example: every day (86400 seconds).

3362

#

3363

# A scheduled start time will be skipped if the previous

3364

# execution has not ended when its scheduled time occurs.

3365

#

3366

# This value must be set to a time duration greater than or equal

3367

# to 1 day and can be no longer than 60 days.

3368

},

3369

"manual": { # Job trigger option for hybrid jobs. Jobs must be manually created # For use with hybrid jobs. Jobs must be manually created and finished.

3370

# Early access feature is in a pre-release state and might change or have

3371

# limited support. For more information, see

3372

# https://cloud.google.com/products#product-launch-stages.

# and finished.

},

},

],

"displayName": "A String", # Display name (max 100 chars)

3378

"createTime": "A String", # Output only. The creation timestamp of a triggeredJob.

3379

"updateTime": "A String", # Output only. The last update timestamp of a triggeredJob.

3380

"inspectJob": { # Controls what and how to inspect for findings. # For inspect jobs, a snapshot of the configuration.

3381

"inspectConfig": { # Configuration description of the scanning process. # How and what to scan for.

3382

# When used with redactContent only info_types and min_likelihood are currently

3383

# used.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

3384

"minLikelihood": "A String", # Only returns findings equal or above this threshold. The default is

3385

# POSSIBLE.

3386

# See https://cloud.google.com/dlp/docs/likelihood to learn more.

3387

"contentOptions": [ # List of options defining data content to scan.

3388

# If empty, text, images, and other content will be included.

3389

"A String",

3390

],

3391

"infoTypes": [ # Restricts what info_types to look for. The values must correspond to

3392

# InfoType values returned by ListInfoTypes or listed at

3393

# https://cloud.google.com/dlp/docs/infotypes-reference.

3394

#

3395

# When no InfoTypes or CustomInfoTypes are specified in a request, the

3396

# system may automatically choose what detectors to run. By default this may

3397

# be all types, but may change over time as detectors are updated.

3398

#

3399

# If you need precise control and predictability as to what detectors are

3400

# run you should specify specific InfoTypes listed in the reference,

3401

# otherwise a default list will be used, which may change over time.

3402

{ # Type of information detected by the API.

3403

"name": "A String", # Name of the information type. Either a name of your choosing when

3404

# creating a CustomInfoType, or one of the names listed

3405

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

3406

# a built-in type. InfoType names should conform to the pattern

3407

# `[a-zA-Z0-9_]{1,64}`.

3408

},

3409

],

3410

"excludeInfoTypes": True or False, # When true, excludes type information of the findings.

3411

"customInfoTypes": [ # CustomInfoTypes provided by the user. See

3412

# https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more.

3413

{ # Custom information type provided by the user. Used to find domain-specific

3414

# sensitive information configurable to the data in question.

3415

"surrogateType": { # Message for detecting output from deidentification transformations # Message for detecting output from deidentification transformations that

3416

# support reversing.

3417

# such as

3418

# [`CryptoReplaceFfxFpeConfig`](/dlp/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig).

3419

# These types of transformations are

3420

# those that perform pseudonymization, thereby producing a "surrogate" as

3421

# output. This should be used in conjunction with a field on the

3422

# transformation such as `surrogate_info_type`. This CustomInfoType does

3423

# not support the use of `detection_rules`.

3424

},

3425

"likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be

3426

# altered by a detection rule if the finding meets the criteria specified by

3427

# the rule. Defaults to `VERY_LIKELY` if not specified.

3428

"infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in

3429

# infoType, when the name matches one of existing infoTypes and that infoType

3430

# is specified in `InspectContent.info_types` field. Specifying the latter

3431

# adds findings to the one detected by the system. If built-in info type is

3432

# not specified in `InspectContent.info_types` list then the name is treated

3433

# as a custom info type.

3434

"name": "A String", # Name of the information type. Either a name of your choosing when

3435

# creating a CustomInfoType, or one of the names listed

3436

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

3437

# a built-in type. InfoType names should conform to the pattern

3438

# `[a-zA-Z0-9_]{1,64}`.

3439

},

3440

"regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType.

3441

"groupIndexes": [ # The index of the submatch to extract as findings. When not

3442

# specified, the entire match is returned. No more than 3 may be included.

3443

42,

3444

],

3445

"pattern": "A String", # Pattern defining the regular expression. Its syntax

3446

# (https://github.com/google/re2/wiki/Syntax) can be found under the

3447

# google/re2 repository on GitHub.

3448

},

3449

"detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType.

3450

# Rules are applied in order that they are specified. Not supported for the

3451

# `surrogate_type` CustomInfoType.

3452

{ # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a

3453

# `CustomInfoType` to alter behavior under certain circumstances, depending

3454

# on the specific details of the rule. Not supported for the `surrogate_type`

3455

# custom infoType.

3456

"hotwordRule": { # The rule that adjusts the likelihood of findings within a certain # Hotword-based detection rule.

3457

# proximity of hotwords.

3458

"likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as # Likelihood adjustment to apply to all matching findings.

3459

# part of a detection rule.

3460

"relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of

3461

# levels. For example, if a finding would be `POSSIBLE` without the

3462

# detection rule and `relative_likelihood` is 1, then it is upgraded to

3463

# `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`.

3464

# Likelihood may never drop below `VERY_UNLIKELY` or exceed

3465

# `VERY_LIKELY`, so applying an adjustment of 1 followed by an

3466

# adjustment of -1 when base likelihood is `VERY_LIKELY` will result in

3467

# a final likelihood of `LIKELY`.

3468

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value.

3469

},

3470

"hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword.

3471

"groupIndexes": [ # The index of the submatch to extract as findings. When not

3472

# specified, the entire match is returned. No more than 3 may be included.

3473

42,

3474

],

3475

"pattern": "A String", # Pattern defining the regular expression. Its syntax

3476

# (https://github.com/google/re2/wiki/Syntax) can be found under the

3477

# google/re2 repository on GitHub.

3478

},

3479

"proximity": { # Message for specifying a window around a finding to apply a detection # Proximity of the finding within which the entire hotword must reside.

3480

# The total length of the window cannot exceed 1000 characters. Note that

3481

# the finding itself will be included in the window, so that hotwords may

3482

# be used to match substrings of the finding itself. For example, the

3483

# certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be

3484

# adjusted upwards if the area code is known to be the local area code of

3485

# a company office using the hotword regex "\(xxx\)", where "xxx"

3486

# is the area code in question.

3487

# rule.

3488

"windowBefore": 42, # Number of characters before the finding to consider.

3489

"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

3495

# to be returned. It still can be used for rules matching.

3496

"dictionary": { # Custom information type based on a dictionary of words or phrases. This can # A list of phrases to detect as a CustomInfoType.

3497

# be used to match sensitive information specific to the data, such as a list

3498

# of employee IDs or job titles.

3499

#

3500

# Dictionary words are case-insensitive and all characters other than letters

3501

# and digits in the unicode [Basic Multilingual

3502

# Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane)

3503

# will be replaced with whitespace when scanning for matches, so the

3504

# dictionary phrase "Sam Johnson" will match all three phrases "sam johnson",

3505

# "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters

3506

# surrounding any match must be of a different type than the adjacent

3507

# characters within the word, so letters must be next to non-letters and

3508

# digits next to non-digits. For example, the dictionary word "jen" will

3509

# match the first three letters of the text "jen123" but will return no

3510

# matches for "jennifer".

3511

#

3512

# Dictionary words containing a large number of characters that are not

3513

# letters or digits may result in unexpected findings because such characters

3514

# are treated as whitespace. The

3515

# [limits](https://cloud.google.com/dlp/limits) page contains details about

3516

# the size limits of dictionaries. For dictionaries that do not fit within

3517

# these constraints, consider using `LargeCustomDictionaryConfig` in the

3518

# `StoredInfoType` API.

3519

"wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for.

3520

"words": [ # Words or phrases defining the dictionary. The dictionary must contain

3521

# at least one phrase and every phrase must contain at least 2 characters

3522

# 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

3527

# is accepted.

3528

"path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage.

3529

# Example: gs://[BUCKET_NAME]/dictionary.txt

3530

},

3531

},

3532

"storedType": { # A reference to a StoredInfoType to use with scanning. # Load an existing `StoredInfoType` resource for use in

3533

# `InspectDataSource`. Not currently supported in `InspectContent`.

3534

"name": "A String", # Resource name of the requested `StoredInfoType`, for example

3535

# `organizations/433245324/storedInfoTypes/432452342` or

3536

# `projects/project-id/storedInfoTypes/432452342`.

3537

"createTime": "A String", # Timestamp indicating when the version of the `StoredInfoType` used for

3538

# inspection was created. Output-only field, populated by the system.

3539

},

3540

},

3541

],

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

3542

"includeQuote": True or False, # When true, a contextual quote from the data that triggered a finding is

3543

# included in the response; see Finding.quote.

3544

"ruleSet": [ # Set of rules to apply to the findings for this InspectConfig.

3545

# Exclusion rules, contained in the set are executed in the end, other

3546

# rules are executed in the order they are specified for each info type.

3547

{ # Rule set for modifying a set of infoTypes to alter behavior under certain

3548

# circumstances, depending on the specific details of the rules within the set.

3549

"infoTypes": [ # List of infoTypes this rule set is applied to.

3550

{ # Type of information detected by the API.

3551

"name": "A String", # Name of the information type. Either a name of your choosing when

3552

# creating a CustomInfoType, or one of the names listed

3553

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

3554

# a built-in type. InfoType names should conform to the pattern

3555

# `[a-zA-Z0-9_]{1,64}`.

3556

},

3557

],

3558

"rules": [ # Set of rules to be applied to infoTypes. The rules are applied in order.

3559

{ # A single inspection rule to be applied to infoTypes, specified in

3560

# `InspectionRuleSet`.

3561

"hotwordRule": { # The rule that adjusts the likelihood of findings within a certain # Hotword-based detection rule.

3562

# proximity of hotwords.

3563

"likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as # Likelihood adjustment to apply to all matching findings.

3564

# part of a detection rule.

3565

"relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of

3566

# levels. For example, if a finding would be `POSSIBLE` without the

3567

# detection rule and `relative_likelihood` is 1, then it is upgraded to

3568

# `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`.

3569

# Likelihood may never drop below `VERY_UNLIKELY` or exceed

3570

# `VERY_LIKELY`, so applying an adjustment of 1 followed by an

3571

# adjustment of -1 when base likelihood is `VERY_LIKELY` will result in

3572

# a final likelihood of `LIKELY`.

3573

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value.

3574

},

3575

"hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword.

3576

"groupIndexes": [ # The index of the submatch to extract as findings. When not

3577

# specified, the entire match is returned. No more than 3 may be included.

3578

42,

3579

],

3580

"pattern": "A String", # Pattern defining the regular expression. Its syntax

3581

# (https://github.com/google/re2/wiki/Syntax) can be found under the

3582

# google/re2 repository on GitHub.

3583

},

3584

"proximity": { # Message for specifying a window around a finding to apply a detection # Proximity of the finding within which the entire hotword must reside.

3585

# The total length of the window cannot exceed 1000 characters. Note that

3586

# the finding itself will be included in the window, so that hotwords may

3587

# be used to match substrings of the finding itself. For example, the

3588

# certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be

3589

# adjusted upwards if the area code is known to be the local area code of

3590

# a company office using the hotword regex "\(xxx\)", where "xxx"

3591

# is the area code in question.

3592

# rule.

3593

"windowBefore": 42, # Number of characters before the finding to consider.

3594

"windowAfter": 42, # Number of characters after the finding to consider.

3595

},

3596

},

3597

"exclusionRule": { # The rule that specifies conditions when findings of infoTypes specified in # Exclusion rule.

3598

# `InspectionRuleSet` are removed from results.

3599

"dictionary": { # Custom information type based on a dictionary of words or phrases. This can # Dictionary which defines the rule.

3600

# be used to match sensitive information specific to the data, such as a list

3601

# of employee IDs or job titles.

3602

#

3603

# Dictionary words are case-insensitive and all characters other than letters

3604

# and digits in the unicode [Basic Multilingual

3605

# Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane)

3606

# will be replaced with whitespace when scanning for matches, so the

3607

# dictionary phrase "Sam Johnson" will match all three phrases "sam johnson",

3608

# "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters

3609

# surrounding any match must be of a different type than the adjacent

3610

# characters within the word, so letters must be next to non-letters and

3611

# digits next to non-digits. For example, the dictionary word "jen" will

3612

# match the first three letters of the text "jen123" but will return no

3613

# matches for "jennifer".

3614

#

3615

# Dictionary words containing a large number of characters that are not

3616

# letters or digits may result in unexpected findings because such characters

3617

# are treated as whitespace. The

3618

# [limits](https://cloud.google.com/dlp/limits) page contains details about

3619

# the size limits of dictionaries. For dictionaries that do not fit within

3620

# these constraints, consider using `LargeCustomDictionaryConfig` in the

3621

# `StoredInfoType` API.

3622

"wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for.

3623

"words": [ # Words or phrases defining the dictionary. The dictionary must contain

3624

# at least one phrase and every phrase must contain at least 2 characters

3625

# 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

3630

# is accepted.

3631

"path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage.

3632

# Example: gs://[BUCKET_NAME]/dictionary.txt

3633

},

3634

},

3635

"regex": { # Message defining a custom regular expression. # Regular expression which defines the rule.

3636

"groupIndexes": [ # The index of the submatch to extract as findings. When not

3637

# specified, the entire match is returned. No more than 3 may be included.

3638

42,

3639

],

3640

"pattern": "A String", # Pattern defining the regular expression. Its syntax

3641

# (https://github.com/google/re2/wiki/Syntax) can be found under the

3642

# google/re2 repository on GitHub.

3643

},

3644

"excludeInfoTypes": { # List of exclude infoTypes. # Set of infoTypes for which findings would affect this rule.

3645

"infoTypes": [ # InfoType list in ExclusionRule rule drops a finding when it overlaps or

3646

# contained within with a finding of an infoType from this list. For

3647

# example, for `InspectionRuleSet.info_types` containing "PHONE_NUMBER"` and

3648

# `exclusion_rule` containing `exclude_info_types.info_types` with

3649

# "EMAIL_ADDRESS" the phone number findings are dropped if they overlap

3650

# with EMAIL_ADDRESS finding.

3651

# That leads to "555-222-2222@example.org" to generate only a single

3652

# finding, namely email address.

3653

{ # Type of information detected by the API.

3654

"name": "A String", # Name of the information type. Either a name of your choosing when

3655

# creating a CustomInfoType, or one of the names listed

3656

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

3657

# a built-in type. InfoType names should conform to the pattern

3658

# `[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.

3669

"maxFindingsPerItem": 42, # Max number of findings that will be returned for each item scanned.

3670

# When set within `InspectJobConfig`,

3671

# the maximum returned is 2000 regardless if this is set higher.

3672

# When set within `InspectContentRequest`, this field is ignored.

3673

"maxFindingsPerInfoType": [ # Configuration of findings limit given for specified infoTypes.

3674

{ # Max findings configuration per infoType, per content item or long

3675

# running DlpJob.

3676

"maxFindings": 42, # Max findings limit for the given infoType.

3677

"infoType": { # Type of information detected by the API. # Type of information the findings limit applies to. Only one limit per

3678

# info_type should be provided. If InfoTypeLimit does not have an

3679

# info_type, the DLP API applies the limit against all info_types that

3680

# are found but not specified in another InfoTypeLimit.

3681

"name": "A String", # Name of the information type. Either a name of your choosing when

3682

# creating a CustomInfoType, or one of the names listed

3683

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

3684

# a built-in type. InfoType names should conform to the pattern

3685

# `[a-zA-Z0-9_]{1,64}`.

},

},

],

"maxFindingsPerRequest": 42, # Max number of findings that will be returned per request/job.

3690

# When set within `InspectContentRequest`, the maximum returned is 2000

3691

# regardless if this is set higher.

3692

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

3693

},

3694

"actions": [ # Actions to execute at the completion of the job.

3695

{ # A task to execute on the completion of a job.

3696

# See https://cloud.google.com/dlp/docs/concepts-actions to learn more.

3697

"publishSummaryToCscc": { # Publish the result summary of a DlpJob to the Cloud Security # Publish summary to Cloud Security Command Center (Alpha).

3698

# Command Center (CSCC Alpha).

3699

# This action is only available for projects which are parts of

3700

# an organization and whitelisted for the alpha Cloud Security Command

3701

# Center.

3702

# The action will publish count of finding instances and their info types.

3703

# The summary of findings will be persisted in CSCC and are governed by CSCC

3704

# service-specific policy, see https://cloud.google.com/terms/service-terms

3705

# Only a single instance of this action can be specified.

3706

# Compatible with: Inspect

3707

},

3708

"jobNotificationEmails": { # Enable email notification to project owners and editors on jobs's # Enable email notification for project owners and editors on job's

3709

# completion/failure.

3710

# completion/failure.

3711

},

3712

"saveFindings": { # If set, the detailed findings will be persisted to the specified # Save resulting findings in a provided location.

3713

# OutputStorageConfig. Only a single instance of this action can be

3714

# specified.

3715

# Compatible with: Inspect, Risk

3716

"outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

3717

"table": { # Message defining the location of a BigQuery table. A table is uniquely # Store findings in an existing table or a new table in an existing

3718

# dataset. If table_id is not set a new one will be generated

3719

# for you with the following format:

3720

# dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific timezone will be used for

3721

# generating the date details.

3722

#

3723

# For Inspect, each column in an existing output table must have the same

3724

# name, type, and mode of a field in the `Finding` object.

3725

#

3726

# For Risk, an existing output table should be the output of a previous

3727

# Risk analysis job run on the same source table, with the same privacy

3728

# metric and quasi-identifiers. Risk jobs that analyze the same table but

3729

# compute a different privacy metric, or use different sets of

3730

# quasi-identifiers, cannot store their results in the same table.

3731

# identified by its project_id, dataset_id, and table_name. Within a query

3732

# a table is often referenced with a string in the format of:

3733

# `<project_id>:<dataset_id>.<table_id>` or

3734

# `<project_id>.<dataset_id>.<table_id>`.

3735

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table.

3736

# If omitted, project ID is inferred from the API call.

3737

"datasetId": "A String", # Dataset ID of the table.

3738

"tableId": "A String", # Name of the table.

3739

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

3740

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only

3741

# used for Inspect and must be unspecified for Risk jobs. Columns are derived

3742

# from the `Finding` object. If appending to an existing table, any columns

3743

# from the predefined schema that are missing will be added. No columns in

3744

# the existing table will be deleted.

3745

#

3746

# If unspecified, then all available columns will be used for a new table or

3747

# an (existing) table with no schema, and no changes will be made to an

3748

# existing table that has a schema.

3749

# Only for use with external storage.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

3750

},

3751

},

3752

"pubSub": { # Publish a message into given Pub/Sub topic when DlpJob has completed. The # Publish a notification to a pubsub topic.

3753

# message contains a single field, `DlpJobName`, which is equal to the

3754

# finished job's

3755

# [`DlpJob.name`](/dlp/docs/reference/rest/v2/projects.dlpJobs#DlpJob).

3756

# Compatible with: Inspect, Risk

3757

"topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given

3758

# publishing access rights to the DLP API service account executing

3759

# the long running DlpJob sending the notifications.

3760

# Format is projects/{project}/topics/{topic}.

3761

},

3762

"publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Cloud Data Catalog. Labels summarizing the # Publish findings to Cloud Datahub.

3763

# results of the DlpJob will be applied to the entry for the resource scanned

3764

# in Cloud Data Catalog. Any labels previously written by another DlpJob will

3765

# be deleted. InfoType naming patterns are strictly enforced when using this

3766

# feature. Note that the findings will be persisted in Cloud Data Catalog

3767

# storage and are governed by Data Catalog service-specific policy, see

3768

# https://cloud.google.com/terms/service-terms

3769

# Only a single instance of this action can be specified and only allowed if

3770

# all resources being scanned are BigQuery tables.

3771

# Compatible with: Inspect

3772

},

3773

"publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This # Enable Stackdriver metric dlp.googleapis.com/finding_count.

3774

# will publish a metric to stack driver on each infotype requested and

3775

# how many findings were found for it. CustomDetectors will be bucketed

3776

# as 'Custom' under the Stackdriver label 'info_type'.

},

},

],

"storageConfig": { # Shared message indicating Cloud storage type. # The data to scan.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

3781

"hybridOptions": { # Configuration to control jobs where the content being inspected is outside # Hybrid inspection options.

3782

# Early access feature is in a pre-release state and might change or have

3783

# limited support. For more information, see

3784

# https://cloud.google.com/products#product-launch-stages.

3785

# of Google Cloud Platform.

3786

"labels": { # To organize findings, these labels will be added to each finding.

3787

#

3788

# Label keys must be between 1 and 63 characters long and must conform

3789

# to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.

3790

#

3791

# Label values must be between 0 and 63 characters long and must conform

3792

# to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.

3793

#

3794

# No more than 10 labels can be associated with a given finding.

3795

#

3796

# Examples:

3797

# * `"environment" : "production"`

3798

# * `"pipeline" : "etl"`

3799

"a_key": "A String",

3800

},

3801

"description": "A String", # A short description of where the data is coming from. Will be stored once

3802

# in the job. 256 max length.

3803

"tableOptions": { # Instructions regarding the table content being inspected. # If the container is a table, additional information to make findings

3804

# meaningful such as the columns that are primary keys.

3805

"identifyingFields": [ # The columns that are the primary keys for table objects included in

3806

# ContentItem. A copy of this cell's value will stored alongside alongside

3807

# each finding so that the finding can be traced to the specific row it came

3808

# from. No more than 3 may be provided.

3809

{ # General identifier of a data field in a storage service.

3810

"name": "A String", # Name describing the field.

},

],

},

"requiredFindingLabelKeys": [ # These are labels that each inspection request must include within their

3815

# 'finding_labels' map. Request may contain others, but any missing one of

3816

# these will be rejected.

3817

#

3818

# Label keys must be between 1 and 63 characters long and must conform

3819

# to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.

3820

#

3821

# No more than 10 keys can be required.

3822

"A String",

3823

],

3824

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

3825

"datastoreOptions": { # Options defining a data set within Google Cloud Datastore. # Google Cloud Datastore options.

3826

"partitionId": { # Datastore partition ID. # A partition ID identifies a grouping of entities. The grouping is always

3827

# by project and namespace, however the namespace ID may be empty.

3828

# A partition ID identifies a grouping of entities. The grouping is always

3829

# by project and namespace, however the namespace ID may be empty.

3830

#

3831

# A partition ID contains several dimensions:

3832

# project ID and namespace ID.

3833

"projectId": "A String", # The ID of the project to which the entities belong.

3834

"namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.

3835

},

3836

"kind": { # A representation of a Datastore kind. # The kind to process.

3837

"name": "A String", # The name of the kind.

3838

},

3839

},

3840

"timespanConfig": { # Configuration of the timespan of the items to include in scanning.

3841

# Currently only supported when inspecting Google Cloud Storage and BigQuery.

3842

"timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items.

3843

# Used for data sources like Datastore and BigQuery.

3844

#

3845

# For BigQuery:

3846

# Required to filter out rows based on the given start and

3847

# end times. If not specified and the table was modified between the given

3848

# start and end times, the entire table will be scanned.

3849

# The valid data types of the timestamp field are: `INTEGER`, `DATE`,

3850

# `TIMESTAMP`, or `DATETIME` BigQuery column.

3851

#

3852

# For Datastore.

3853

# Valid data types of the timestamp field are: `TIMESTAMP`.

3854

# Datastore entity will be scanned if the timestamp property does not

3855

# exist or its value is empty or invalid.

3856

"name": "A String", # Name describing the field.

3857

},

3858

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out

3859

# a valid start_time to avoid scanning files that have not been modified

3860

# since the last time the JobTrigger executed. This will be based on the

3861

# time of the execution of the last run of the JobTrigger.

3862

"endTime": "A String", # Exclude files or rows newer than this value.

3863

# If set to zero, no upper time limit is applied.

3864

"startTime": "A String", # Exclude files or rows older than this value.

3865

},

3866

"cloudStorageOptions": { # Options defining a file or a set of files within a Google Cloud Storage # Google Cloud Storage options.

3867

# bucket.

3868

"bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger

3869

# than this value then the rest of the bytes are omitted. Only one

3870

# of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.

3871

"fileSet": { # Set of files to scan. # The set of one or more files to scan.

3872

"regexFileSet": { # Message representing a set of files in a Cloud Storage bucket. Regular # The regex-filtered set of files to scan. Exactly one of `url` or

3873

# `regex_file_set` must be set.

3874

# expressions are used to allow fine-grained control over which files in the

3875

# bucket to include.

3876

#

3877

# Included files are those that match at least one item in `include_regex` and

3878

# do not match any items in `exclude_regex`. Note that a file that matches

3879

# items from both lists will _not_ be included. For a match to occur, the

3880

# entire file path (i.e., everything in the url after the bucket name) must

3881

# match the regular expression.

3882

#

3883

# For example, given the input `{bucket_name: "mybucket", include_regex:

3884

# ["directory1/.*"], exclude_regex:

3885

# ["directory1/excluded.*"]}`:

3886

#

3887

# * `gs://mybucket/directory1/myfile` will be included

3888

# * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches

3889

# across `/`)

3890

# * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the

3891

# full path doesn't match any items in `include_regex`)

3892

# * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path

3893

# matches an item in `exclude_regex`)

3894

#

3895

# If `include_regex` is left empty, it will match all files by default

3896

# (this is equivalent to setting `include_regex: [".*"]`).

3897

#

3898

# Some other common use cases:

3899

#

3900

# * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all

3901

# files in `mybucket` except for .pdf files

3902

# * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will

3903

# include all files directly under `gs://mybucket/directory/`, without matching

3904

# across `/`

3905

"bucketName": "A String", # The name of a Cloud Storage bucket. Required.

3906

"includeRegex": [ # A list of regular expressions matching file paths to include. All files in

3907

# the bucket that match at least one of these regular expressions will be

3908

# included in the set of files, except for those that also match an item in

3909

# `exclude_regex`. Leaving this field empty will match all files by default

3910

# (this is equivalent to including `.*` in the list).

3911

#

3912

# Regular expressions use RE2

3913

# [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found

3914

# under the google/re2 repository on GitHub.

3915

"A String",

3916

],

3917

"excludeRegex": [ # A list of regular expressions matching file paths to exclude. All files in

3918

# the bucket that match at least one of these regular expressions will be

3919

# excluded from the scan.

3920

#

3921

# Regular expressions use RE2

3922

# [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found

3923

# under the google/re2 repository on GitHub.

"A String",

],

},

"url": "A String", # The Cloud Storage url of the file(s) to scan, in the format

3928

# `gs://<bucket>/<path>`. Trailing wildcard in the path is allowed.

3929

#

3930

# If the url ends in a trailing slash, the bucket or directory represented

3931

# by the url will be scanned non-recursively (content in sub-directories

3932

# will not be scanned). This means that `gs://mybucket/` is equivalent to

3933

# `gs://mybucket/*`, and `gs://mybucket/directory/` is equivalent to

3934

# `gs://mybucket/directory/*`.

3935

#

3936

# Exactly one of `url` or `regex_file_set` must be set.

3937

},

3938

"filesLimitPercent": 42, # Limits the number of files to scan to this percentage of the input FileSet.

3939

# Number of files scanned is rounded down. Must be between 0 and 100,

3940

# inclusively. Both 0 and 100 means no limit. Defaults to 0.

3941

"fileTypes": [ # List of file type groups to include in the scan.

3942

# If empty, all files are scanned and available data format processors

3943

# are applied. In addition, the binary content of the selected files

3944

# is always scanned as well.

3945

# Images are scanned only as binary if the specified region

3946

# does not support image inspection and no file_types were specified.

3947

# Image inspection is restricted to 'global', 'us', 'asia', and 'europe'.

3948

"A String",

3949

],

3950

"sampleMethod": "A String",

3951

"bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The

3952

# number of bytes scanned is rounded down. Must be between 0 and 100,

3953

# inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one

3954

# of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.

3955

},

3956

"bigQueryOptions": { # Options defining BigQuery table and row identifiers. # BigQuery options.

3957

"tableReference": { # Message defining the location of a BigQuery table. A table is uniquely # Complete BigQuery table reference.

3958

# identified by its project_id, dataset_id, and table_name. Within a query

3959

# a table is often referenced with a string in the format of:

3960

# `<project_id>:<dataset_id>.<table_id>` or

3961

# `<project_id>.<dataset_id>.<table_id>`.

3962

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table.

3963

# If omitted, project ID is inferred from the API call.

3964

"datasetId": "A String", # Dataset ID of the table.

3965

"tableId": "A String", # Name of the table.

3966

},

3967

"identifyingFields": [ # Table fields that may uniquely identify a row within the table. When

3968

# `actions.saveFindings.outputConfig.table` is specified, the values of

3969

# columns specified here are available in the output table under

3970

# `location.content_locations.record_location.record_key.id_values`. Nested

3971

# fields such as `person.birthdate.year` are allowed.

3972

{ # General identifier of a data field in a storage service.

3973

"name": "A String", # Name describing the field.

3974

},

3975

],

3976

"rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows

3977

# scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and

3978

# 100 means no limit. Defaults to 0. Only one of rows_limit and

3979

# rows_limit_percent can be specified. Cannot be used in conjunction with

3980

# TimespanConfig.

3981

"rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the

3982

# rest of the rows are omitted. If not set, or if set to 0, all rows will be

3983

# scanned. Only one of rows_limit and rows_limit_percent can be specified.

3984

# Cannot be used in conjunction with TimespanConfig.

3985

"excludedFields": [ # References to fields excluded from scanning. This allows you to skip

3986

# inspection of entire columns which you know have no findings.

3987

{ # General identifier of a data field in a storage service.

3988

"name": "A String", # Name describing the field.

3989

},

3990

],

3991

"sampleMethod": "A String",

3992

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

3993

},

3994

"inspectTemplateName": "A String", # If provided, will be used as the default for all values in InspectConfig.

3995

# `inspect_config` will be merged into the values persisted as part of the

3996

# template.

3997

},

3998

"status": "A String", # Required. A status for this trigger.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="hybridInspect">hybridInspect(name, body=None, x__xgafv=None)</code>

4004

<pre>Inspect hybrid content and store findings to a trigger. The inspection

4005

will be processed asynchronously. To review the findings monitor the

4006

jobs within the trigger.

4007

Early access feature is in a pre-release state and might change or have

4008

limited support. For more information, see

4009

https://cloud.google.com/products#product-launch-stages.

4010

4011

Args:

4012

name: string, Required. Resource name of the trigger to execute a hybrid inspect on, for example

4013

`projects/dlp-test-project/jobTriggers/53234423`. (required)

4014

body: object, The request body.

4015

The object takes the form of:

4016

4017

{ # Request to search for potentially sensitive info in a custom location.

4018

"hybridItem": { # An individual hybrid item to inspect. Will be stored temporarily during # The item to inspect.

4019

# processing.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

4020

"item": { # Container structure for the content to inspect. # The item to inspect.

4021

"byteItem": { # Container for bytes to inspect or redact. # Content data to inspect or redact. Replaces `type` and `data`.

4022

"data": "A String", # Content data to inspect or redact.

4023

"type": "A String", # The type of data stored in the bytes string. Default will be TEXT_UTF8.

4024

},

4025

"value": "A String", # String data to inspect or redact.

4026

"table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. # Structured content for inspection. See

4027

# https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to

4028

# learn more.

4029

# See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to

4030

# learn more.

4031

"rows": [ # Rows of the table.

4032

{ # Values of the row.

4033

"values": [ # Individual cells.

4034

{ # Set of primitive values supported by the system.

4035

# Note that for the purposes of inspection or transformation, the number

4036

# of bytes considered to comprise a 'Value' is based on its representation

4037

# as a UTF-8 encoded string. For example, if 'integer_value' is set to

4038

# 123456789, the number of bytes would be counted as 9, even though an

4039

# int64 only holds up to 8 bytes of data.

4040

"timestampValue": "A String", # timestamp

4041

"dateValue": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # date

4042

# and time zone are either specified elsewhere or are not significant. The date

4043

# is relative to the Proleptic Gregorian Calendar. This can represent:

4044

#

4045

# * A full date, with non-zero year, month and day values

4046

# * A month and day value, with a zero year, e.g. an anniversary

4047

# * A year on its own, with zero month and day values

4048

# * A year and month value, with a zero day, e.g. a credit card expiration date

4049

#

4050

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

4051

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

4052

# a year.

4053

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

4054

# month and day.

4055

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

4056

# if specifying a year by itself or a year and month where the day is not

4057

# significant.

4058

},

4059

"stringValue": "A String", # string

4060

"integerValue": "A String", # integer

4061

"timeValue": { # Represents a time of day. The date and time zone are either not significant # time of day

4062

# or are specified elsewhere. An API may choose to allow leap seconds. Related

4063

# types are google.type.Date and `google.protobuf.Timestamp`.

4064

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

4065

# to allow the value "24:00:00" for scenarios like business closing time.

4066

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

4067

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

4068

# allow the value 60 if it allows leap-seconds.

4069

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

4070

},

4071

"booleanValue": True or False, # boolean

4072

"floatValue": 3.14, # float

4073

"dayOfWeekValue": "A String", # day of week

},

],

},

],

"headers": [ # Headers of the table.

4079

{ # General identifier of a data field in a storage service.

4080

"name": "A String", # Name describing the field.

},

],

},

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

4085

"findingDetails": { # Populate to associate additional data with each finding. # Supplementary information that will be added to each finding.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

4086

"rowOffset": "A String", # Offset of the row for tables. Populate if the row(s) being scanned are

4087

# part of a bigger dataset and you want to keep track of their absolute

4088

# position.

4089

"fileOffset": "A String", # Offset in bytes of the line, from the beginning of the file, where the

4090

# finding is located. Populate if the item being scanned is only part of a

4091

# bigger item, such as a shard of a file and you want to track the absolute

4092

# position of the finding.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

4093

"containerDetails": { # Represents a container that may contain DLP findings. # Details about the container where the content being inspected is from.

4094

# Examples of a container include a file, table, or database record.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

4095

"updateTime": "A String", # Findings container modification timestamp, if applicable.

4096

# For Google Cloud Storage contains last file modification timestamp.

4097

# For BigQuery table contains last_modified_time property.

4098

# For Datastore - not populated.

4099

"rootPath": "A String", # The root of the container.

4100

# Examples:

4101

# - For BigQuery table `project_id:dataset_id.table_id`, the root is

4102

# `dataset_id`

4103

# - For Google Cloud Storage file `gs://bucket/folder/filename.txt`, the root

4104

# is `gs://bucket`

4105

"projectId": "A String", # Project where the finding was found.

4106

# Can be different from the project that owns the finding.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

4107

"version": "A String", # Findings container version, if available

4108

# ("generation" for Google Cloud Storage).

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

4109

"relativePath": "A String", # The rest of the path after the root.

4110

# Examples:

4111

# - For BigQuery table `project_id:dataset_id.table_id`, the relative path is

4112

# `table_id`

4113

# - Google Cloud Storage file `gs://bucket/folder/filename.txt`, the relative

4114

# path is `folder/filename.txt`

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

4115

"fullPath": "A String", # A string representation of the full container name.

4116

# Examples:

4117

# - BigQuery: 'Project:DataSetId.TableId'

4118

# - Google Cloud Storage: 'gs://Bucket/folders/filename.txt'

4119

"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]

4120

},

4121

"labels": { # Labels to represent user provided metadata about the data being inspected.

4122

# If configured by the job, some key values may be required.

4123

# The labels associated with `Finding`'s produced by hybrid

4124

# inspection.

4125

#

4126

# Label keys must be between 1 and 63 characters long and must conform

4127

# to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.

4128

#

4129

# Label values must be between 0 and 63 characters long and must conform

4130

# to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.

4131

#

4132

# No more than 10 labels can be associated with a given finding.

4133

#

4134

# Examples:

4135

# * `"environment" : "production"`

4136

# * `"pipeline" : "etl"`

4137

"a_key": "A String",

4138

},

4139

"tableOptions": { # Instructions regarding the table content being inspected. # If the container is a table, additional information to make findings

4140

# meaningful such as the columns that are primary keys. If not known ahead

4141

# of time, can also be set within each inspect hybrid call and the two

4142

# will be merged. Note that identifying_fields will only be stored to

4143

# BigQuery, and only if the BigQuery action has been included.

4144

"identifyingFields": [ # The columns that are the primary keys for table objects included in

4145

# ContentItem. A copy of this cell's value will stored alongside alongside

4146

# each finding so that the finding can be traced to the specific row it came

4147

# from. No more than 3 may be provided.

4148

{ # General identifier of a data field in a storage service.

4149

"name": "A String", # Name describing the field.

4150

},

4151

],

4152

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

},

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4164

4165

{ # Quota exceeded errors will be thrown once quota has been met.

}</pre>

</div>

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4170

<code class="details" id="list">list(parent, locationId, orderBy=None, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</code>

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

4171

<pre>Lists job triggers.

4172

See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.

4173

4174

Args:

4175

parent: string, Required. The parent resource name, for example `projects/my-project-id`. (required)

4176

locationId: string, The geographic location where job triggers will be retrieved from.

4177

Use `-` for all locations. Reserved for future extensions. (required)

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

4178

orderBy: string, Comma separated list of triggeredJob fields to order by,

4179

followed by `asc` or `desc` postfix. This list is case-insensitive,

4180

default sorting order is ascending, redundant space characters are

4181

insignificant.

4182

4183

Example: `name asc,update_time, create_time desc`

4184

4185

Supported fields are:

4186

4187

- `create_time`: corresponds to time the JobTrigger was created.

4188

- `update_time`: corresponds to time the JobTrigger was last updated.

4189

- `last_run_time`: corresponds to the last time the JobTrigger ran.

4190

- `name`: corresponds to JobTrigger's name.

4191

- `display_name`: corresponds to JobTrigger's display name.

4192

- `status`: corresponds to JobTrigger's status.

4193

pageToken: string, Page token to continue retrieval. Comes from previous call

4194

to ListJobTriggers. `order_by` field must not

4195

change for subsequent calls.

4196

pageSize: integer, Size of the page, can be limited by a server.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

4197

filter: string, Allows filtering.

Supported syntax:

* Filter expressions are made up of one or more restrictions.

4202

* Restrictions can be combined by `AND` or `OR` logical operators. A

4203

sequence of restrictions implicitly uses `AND`.

4204

* A restriction has the form of `{field} {operator} {value}`.

4205

* Supported fields/values for inspect jobs:

4206

- `status` - HEALTHY|PAUSED|CANCELLED

4207

- `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY

4208

- 'last_run_time` - RFC 3339 formatted timestamp, surrounded by

4209

quotation marks. Nanoseconds are ignored.

4210

- 'error_count' - Number of errors that have occurred while running.

4211

* The operator must be `=` or `!=` for status and inspected_storage.

Examples:

* inspected_storage = cloud_storage AND status = HEALTHY

4216

* inspected_storage = cloud_storage OR inspected_storage = bigquery

4217

* inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY)

4218

* last_run_time > \"2017-12-12T00:00:00+00:00\"

4219

4220

The length of this field should be no more than 500 characters.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

4221

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4228

4229

{ # Response message for ListJobTriggers.

4230

"jobTriggers": [ # List of triggeredJobs, up to page_size in ListJobTriggersRequest.

4231

{ # Contains a configuration to make dlp api calls on a repeating basis.

4232

# See https://cloud.google.com/dlp/docs/concepts-job-triggers to learn more.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

4233

"lastRunTime": "A String", # Output only. The timestamp of the last time this trigger executed.

4234

"name": "A String", # Unique resource name for the triggeredJob, assigned by the service when the

4235

# triggeredJob is created, for example

4236

# `projects/dlp-test-project/jobTriggers/53234423`.

4237

"errors": [ # Output only. A stream of errors encountered when the trigger was activated. Repeated

4238

# errors may result in the JobTrigger automatically being paused.

4239

# Will return the last 100 errors. Whenever the JobTrigger is modified

4240

# this list will be cleared.

4241

{ # Details information about an error encountered during job execution or

4242

# the results of an unsuccessful activation of the JobTrigger.

4243

"details": { # The `Status` type defines a logical error model that is suitable for # Detailed error codes and messages.

4244

# different programming environments, including REST APIs and RPC APIs. It is

4245

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

4246

# three pieces of data: error code, error message, and error details.

4247

#

4248

# You can find out more about this error model and how to work with it in the

4249

# [API Design Guide](https://cloud.google.com/apis/design/errors).

4250

"message": "A String", # A developer-facing error message, which should be in English. Any

4251

# user-facing error message should be localized and sent in the

4252

# google.rpc.Status.details field, or localized by the client.

4253

"details": [ # A list of messages that carry the error details. There is a common set of

4254

# message types for APIs to use.

4255

{

4256

"a_key": "", # Properties of the object. Contains field @type with type URL.

4257

},

4258

],

4259

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

4260

},

4261

"timestamps": [ # The times the error occurred.

"A String",

],

},

],

"description": "A String", # User provided description (max 256 chars)

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

4267

"triggers": [ # A list of triggers which will be OR'ed together. Only one in the list

4268

# needs to trigger for a job to be started. The list may contain only

4269

# a single Schedule trigger and must have at least one object.

4270

{ # What event needs to occur for a new job to be started.

4271

"schedule": { # Schedule for triggeredJobs. # Create a job on a repeating basis based on the elapse of time.

4272

"recurrencePeriodDuration": "A String", # With this option a job is started a regular periodic basis. For

4273

# example: every day (86400 seconds).

4274

#

4275

# A scheduled start time will be skipped if the previous

4276

# execution has not ended when its scheduled time occurs.

4277

#

4278

# This value must be set to a time duration greater than or equal

4279

# to 1 day and can be no longer than 60 days.

4280

},

4281

"manual": { # Job trigger option for hybrid jobs. Jobs must be manually created # For use with hybrid jobs. Jobs must be manually created and finished.

4282

# Early access feature is in a pre-release state and might change or have

4283

# limited support. For more information, see

4284

# https://cloud.google.com/products#product-launch-stages.

# and finished.

},

},

],

"displayName": "A String", # Display name (max 100 chars)

4290

"createTime": "A String", # Output only. The creation timestamp of a triggeredJob.

4291

"updateTime": "A String", # Output only. The last update timestamp of a triggeredJob.

4292

"inspectJob": { # Controls what and how to inspect for findings. # For inspect jobs, a snapshot of the configuration.

4293

"inspectConfig": { # Configuration description of the scanning process. # How and what to scan for.

4294

# When used with redactContent only info_types and min_likelihood are currently

4295

# used.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

4296

"minLikelihood": "A String", # Only returns findings equal or above this threshold. The default is

4297

# POSSIBLE.

4298

# See https://cloud.google.com/dlp/docs/likelihood to learn more.

4299

"contentOptions": [ # List of options defining data content to scan.

4300

# If empty, text, images, and other content will be included.

4301

"A String",

4302

],

4303

"infoTypes": [ # Restricts what info_types to look for. The values must correspond to

4304

# InfoType values returned by ListInfoTypes or listed at

4305

# https://cloud.google.com/dlp/docs/infotypes-reference.

4306

#

4307

# When no InfoTypes or CustomInfoTypes are specified in a request, the

4308

# system may automatically choose what detectors to run. By default this may

4309

# be all types, but may change over time as detectors are updated.

4310

#

4311

# If you need precise control and predictability as to what detectors are

4312

# run you should specify specific InfoTypes listed in the reference,

4313

# otherwise a default list will be used, which may change over time.

4314

{ # Type of information detected by the API.

4315

"name": "A String", # Name of the information type. Either a name of your choosing when

4316

# creating a CustomInfoType, or one of the names listed

4317

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

4318

# a built-in type. InfoType names should conform to the pattern

4319

# `[a-zA-Z0-9_]{1,64}`.

4320

},

4321

],

4322

"excludeInfoTypes": True or False, # When true, excludes type information of the findings.

4323

"customInfoTypes": [ # CustomInfoTypes provided by the user. See

4324

# https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more.

4325

{ # Custom information type provided by the user. Used to find domain-specific

4326

# sensitive information configurable to the data in question.

4327

"surrogateType": { # Message for detecting output from deidentification transformations # Message for detecting output from deidentification transformations that

4328

# support reversing.

4329

# such as

4330

# [`CryptoReplaceFfxFpeConfig`](/dlp/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig).

4331

# These types of transformations are

4332

# those that perform pseudonymization, thereby producing a "surrogate" as

4333

# output. This should be used in conjunction with a field on the

4334

# transformation such as `surrogate_info_type`. This CustomInfoType does

4335

# not support the use of `detection_rules`.

4336

},

4337

"likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be

4338

# altered by a detection rule if the finding meets the criteria specified by

4339

# the rule. Defaults to `VERY_LIKELY` if not specified.

4340

"infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in

4341

# infoType, when the name matches one of existing infoTypes and that infoType

4342

# is specified in `InspectContent.info_types` field. Specifying the latter

4343

# adds findings to the one detected by the system. If built-in info type is

4344

# not specified in `InspectContent.info_types` list then the name is treated

4345

# as a custom info type.

4346

"name": "A String", # Name of the information type. Either a name of your choosing when

4347

# creating a CustomInfoType, or one of the names listed

4348

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

4349

# a built-in type. InfoType names should conform to the pattern

4350

# `[a-zA-Z0-9_]{1,64}`.

4351

},

4352

"regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType.

4353

"groupIndexes": [ # The index of the submatch to extract as findings. When not

4354

# specified, the entire match is returned. No more than 3 may be included.

4355

42,

4356

],

4357

"pattern": "A String", # Pattern defining the regular expression. Its syntax

4358

# (https://github.com/google/re2/wiki/Syntax) can be found under the

4359

# google/re2 repository on GitHub.

4360

},

4361

"detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType.

4362

# Rules are applied in order that they are specified. Not supported for the

4363

# `surrogate_type` CustomInfoType.

4364

{ # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a

4365

# `CustomInfoType` to alter behavior under certain circumstances, depending

4366

# on the specific details of the rule. Not supported for the `surrogate_type`

4367

# custom infoType.

4368

"hotwordRule": { # The rule that adjusts the likelihood of findings within a certain # Hotword-based detection rule.

4369

# proximity of hotwords.

4370

"likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as # Likelihood adjustment to apply to all matching findings.

4371

# part of a detection rule.

4372

"relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of

4373

# levels. For example, if a finding would be `POSSIBLE` without the

4374

# detection rule and `relative_likelihood` is 1, then it is upgraded to

4375

# `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`.

4376

# Likelihood may never drop below `VERY_UNLIKELY` or exceed

4377

# `VERY_LIKELY`, so applying an adjustment of 1 followed by an

4378

# adjustment of -1 when base likelihood is `VERY_LIKELY` will result in

4379

# a final likelihood of `LIKELY`.

4380

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value.

4381

},

4382

"hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword.

4383

"groupIndexes": [ # The index of the submatch to extract as findings. When not

4384

# specified, the entire match is returned. No more than 3 may be included.

4385

42,

4386

],

4387

"pattern": "A String", # Pattern defining the regular expression. Its syntax

4388

# (https://github.com/google/re2/wiki/Syntax) can be found under the

4389

# google/re2 repository on GitHub.

4390

},

4391

"proximity": { # Message for specifying a window around a finding to apply a detection # Proximity of the finding within which the entire hotword must reside.

4392

# The total length of the window cannot exceed 1000 characters. Note that

4393

# the finding itself will be included in the window, so that hotwords may

4394

# be used to match substrings of the finding itself. For example, the

4395

# certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be

4396

# adjusted upwards if the area code is known to be the local area code of

4397

# a company office using the hotword regex "\(xxx\)", where "xxx"

4398

# is the area code in question.

4399

# rule.

4400

"windowBefore": 42, # Number of characters before the finding to consider.

4401

"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

4407

# to be returned. It still can be used for rules matching.

4408

"dictionary": { # Custom information type based on a dictionary of words or phrases. This can # A list of phrases to detect as a CustomInfoType.

4409

# be used to match sensitive information specific to the data, such as a list

4410

# of employee IDs or job titles.

4411

#

4412

# Dictionary words are case-insensitive and all characters other than letters

4413

# and digits in the unicode [Basic Multilingual

4414

# Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane)

4415

# will be replaced with whitespace when scanning for matches, so the

4416

# dictionary phrase "Sam Johnson" will match all three phrases "sam johnson",

4417

# "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters

4418

# surrounding any match must be of a different type than the adjacent

4419

# characters within the word, so letters must be next to non-letters and

4420

# digits next to non-digits. For example, the dictionary word "jen" will

4421

# match the first three letters of the text "jen123" but will return no

4422

# matches for "jennifer".

4423

#

4424

# Dictionary words containing a large number of characters that are not

4425

# letters or digits may result in unexpected findings because such characters

4426

# are treated as whitespace. The

4427

# [limits](https://cloud.google.com/dlp/limits) page contains details about

4428

# the size limits of dictionaries. For dictionaries that do not fit within

4429

# these constraints, consider using `LargeCustomDictionaryConfig` in the

4430

# `StoredInfoType` API.

4431

"wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for.

4432

"words": [ # Words or phrases defining the dictionary. The dictionary must contain

4433

# at least one phrase and every phrase must contain at least 2 characters

4434

# 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

4439

# is accepted.

4440

"path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage.

4441

# Example: gs://[BUCKET_NAME]/dictionary.txt

4442

},

4443

},

4444

"storedType": { # A reference to a StoredInfoType to use with scanning. # Load an existing `StoredInfoType` resource for use in

4445

# `InspectDataSource`. Not currently supported in `InspectContent`.

4446

"name": "A String", # Resource name of the requested `StoredInfoType`, for example

4447

# `organizations/433245324/storedInfoTypes/432452342` or

4448

# `projects/project-id/storedInfoTypes/432452342`.

4449

"createTime": "A String", # Timestamp indicating when the version of the `StoredInfoType` used for

4450

# inspection was created. Output-only field, populated by the system.

4451

},

4452

},

4453

],

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

4454

"includeQuote": True or False, # When true, a contextual quote from the data that triggered a finding is

4455

# included in the response; see Finding.quote.

4456

"ruleSet": [ # Set of rules to apply to the findings for this InspectConfig.

4457

# Exclusion rules, contained in the set are executed in the end, other

4458

# rules are executed in the order they are specified for each info type.

4459

{ # Rule set for modifying a set of infoTypes to alter behavior under certain

4460

# circumstances, depending on the specific details of the rules within the set.

4461

"infoTypes": [ # List of infoTypes this rule set is applied to.

4462

{ # Type of information detected by the API.

4463

"name": "A String", # Name of the information type. Either a name of your choosing when

4464

# creating a CustomInfoType, or one of the names listed

4465

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

4466

# a built-in type. InfoType names should conform to the pattern

4467

# `[a-zA-Z0-9_]{1,64}`.

4468

},

4469

],

4470

"rules": [ # Set of rules to be applied to infoTypes. The rules are applied in order.

4471

{ # A single inspection rule to be applied to infoTypes, specified in

4472

# `InspectionRuleSet`.

4473

"hotwordRule": { # The rule that adjusts the likelihood of findings within a certain # Hotword-based detection rule.

4474

# proximity of hotwords.

4475

"likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as # Likelihood adjustment to apply to all matching findings.

4476

# part of a detection rule.

4477

"relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of

4478

# levels. For example, if a finding would be `POSSIBLE` without the

4479

# detection rule and `relative_likelihood` is 1, then it is upgraded to

4480

# `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`.

4481

# Likelihood may never drop below `VERY_UNLIKELY` or exceed

4482

# `VERY_LIKELY`, so applying an adjustment of 1 followed by an

4483

# adjustment of -1 when base likelihood is `VERY_LIKELY` will result in

4484

# a final likelihood of `LIKELY`.

4485

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value.

4486

},

4487

"hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword.

4488

"groupIndexes": [ # The index of the submatch to extract as findings. When not

4489

# specified, the entire match is returned. No more than 3 may be included.

4490

42,

4491

],

4492

"pattern": "A String", # Pattern defining the regular expression. Its syntax

4493

# (https://github.com/google/re2/wiki/Syntax) can be found under the

4494

# google/re2 repository on GitHub.

4495

},

4496

"proximity": { # Message for specifying a window around a finding to apply a detection # Proximity of the finding within which the entire hotword must reside.

4497

# The total length of the window cannot exceed 1000 characters. Note that

4498

# the finding itself will be included in the window, so that hotwords may

4499

# be used to match substrings of the finding itself. For example, the

4500

# certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be

4501

# adjusted upwards if the area code is known to be the local area code of

4502

# a company office using the hotword regex "\(xxx\)", where "xxx"

4503

# is the area code in question.

4504

# rule.

4505

"windowBefore": 42, # Number of characters before the finding to consider.

4506

"windowAfter": 42, # Number of characters after the finding to consider.

4507

},

4508

},

4509

"exclusionRule": { # The rule that specifies conditions when findings of infoTypes specified in # Exclusion rule.

4510

# `InspectionRuleSet` are removed from results.

4511

"dictionary": { # Custom information type based on a dictionary of words or phrases. This can # Dictionary which defines the rule.

4512

# be used to match sensitive information specific to the data, such as a list

4513

# of employee IDs or job titles.

4514

#

4515

# Dictionary words are case-insensitive and all characters other than letters

4516

# and digits in the unicode [Basic Multilingual

4517

# Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane)

4518

# will be replaced with whitespace when scanning for matches, so the

4519

# dictionary phrase "Sam Johnson" will match all three phrases "sam johnson",

4520

# "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters

4521

# surrounding any match must be of a different type than the adjacent

4522

# characters within the word, so letters must be next to non-letters and

4523

# digits next to non-digits. For example, the dictionary word "jen" will

4524

# match the first three letters of the text "jen123" but will return no

4525

# matches for "jennifer".

4526

#

4527

# Dictionary words containing a large number of characters that are not

4528

# letters or digits may result in unexpected findings because such characters

4529

# are treated as whitespace. The

4530

# [limits](https://cloud.google.com/dlp/limits) page contains details about

4531

# the size limits of dictionaries. For dictionaries that do not fit within

4532

# these constraints, consider using `LargeCustomDictionaryConfig` in the

4533

# `StoredInfoType` API.

4534

"wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for.

4535

"words": [ # Words or phrases defining the dictionary. The dictionary must contain

4536

# at least one phrase and every phrase must contain at least 2 characters

4537

# 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

4542

# is accepted.

4543

"path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage.

4544

# Example: gs://[BUCKET_NAME]/dictionary.txt

4545

},

4546

},

4547

"regex": { # Message defining a custom regular expression. # Regular expression which defines the rule.

4548

"groupIndexes": [ # The index of the submatch to extract as findings. When not

4549

# specified, the entire match is returned. No more than 3 may be included.

4550

42,

4551

],

4552

"pattern": "A String", # Pattern defining the regular expression. Its syntax

4553

# (https://github.com/google/re2/wiki/Syntax) can be found under the

4554

# google/re2 repository on GitHub.

4555

},

4556

"excludeInfoTypes": { # List of exclude infoTypes. # Set of infoTypes for which findings would affect this rule.

4557

"infoTypes": [ # InfoType list in ExclusionRule rule drops a finding when it overlaps or

4558

# contained within with a finding of an infoType from this list. For

4559

# example, for `InspectionRuleSet.info_types` containing "PHONE_NUMBER"` and

4560

# `exclusion_rule` containing `exclude_info_types.info_types` with

4561

# "EMAIL_ADDRESS" the phone number findings are dropped if they overlap

4562

# with EMAIL_ADDRESS finding.

4563

# That leads to "555-222-2222@example.org" to generate only a single

4564

# finding, namely email address.

4565

{ # Type of information detected by the API.

4566

"name": "A String", # Name of the information type. Either a name of your choosing when

4567

# creating a CustomInfoType, or one of the names listed

4568

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

4569

# a built-in type. InfoType names should conform to the pattern

4570

# `[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.

4581

"maxFindingsPerItem": 42, # Max number of findings that will be returned for each item scanned.

4582

# When set within `InspectJobConfig`,

4583

# the maximum returned is 2000 regardless if this is set higher.

4584

# When set within `InspectContentRequest`, this field is ignored.

4585

"maxFindingsPerInfoType": [ # Configuration of findings limit given for specified infoTypes.

4586

{ # Max findings configuration per infoType, per content item or long

4587

# running DlpJob.

4588

"maxFindings": 42, # Max findings limit for the given infoType.

4589

"infoType": { # Type of information detected by the API. # Type of information the findings limit applies to. Only one limit per

4590

# info_type should be provided. If InfoTypeLimit does not have an

4591

# info_type, the DLP API applies the limit against all info_types that

4592

# are found but not specified in another InfoTypeLimit.

4593

"name": "A String", # Name of the information type. Either a name of your choosing when

4594

# creating a CustomInfoType, or one of the names listed

4595

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

4596

# a built-in type. InfoType names should conform to the pattern

4597

# `[a-zA-Z0-9_]{1,64}`.

},

},

],

"maxFindingsPerRequest": 42, # Max number of findings that will be returned per request/job.

4602

# When set within `InspectContentRequest`, the maximum returned is 2000

4603

# regardless if this is set higher.

4604

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

4605

},

4606

"actions": [ # Actions to execute at the completion of the job.

4607

{ # A task to execute on the completion of a job.

4608

# See https://cloud.google.com/dlp/docs/concepts-actions to learn more.

4609

"publishSummaryToCscc": { # Publish the result summary of a DlpJob to the Cloud Security # Publish summary to Cloud Security Command Center (Alpha).

4610

# Command Center (CSCC Alpha).

4611

# This action is only available for projects which are parts of

4612

# an organization and whitelisted for the alpha Cloud Security Command

4613

# Center.

4614

# The action will publish count of finding instances and their info types.

4615

# The summary of findings will be persisted in CSCC and are governed by CSCC

4616

# service-specific policy, see https://cloud.google.com/terms/service-terms

4617

# Only a single instance of this action can be specified.

4618

# Compatible with: Inspect

4619

},

4620

"jobNotificationEmails": { # Enable email notification to project owners and editors on jobs's # Enable email notification for project owners and editors on job's

4621

# completion/failure.

4622

# completion/failure.

4623

},

4624

"saveFindings": { # If set, the detailed findings will be persisted to the specified # Save resulting findings in a provided location.

4625

# OutputStorageConfig. Only a single instance of this action can be

4626

# specified.

4627

# Compatible with: Inspect, Risk

4628

"outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

4629

"table": { # Message defining the location of a BigQuery table. A table is uniquely # Store findings in an existing table or a new table in an existing

4630

# dataset. If table_id is not set a new one will be generated

4631

# for you with the following format:

4632

# dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific timezone will be used for

4633

# generating the date details.

4634

#

4635

# For Inspect, each column in an existing output table must have the same

4636

# name, type, and mode of a field in the `Finding` object.

4637

#

4638

# For Risk, an existing output table should be the output of a previous

4639

# Risk analysis job run on the same source table, with the same privacy

4640

# metric and quasi-identifiers. Risk jobs that analyze the same table but

4641

# compute a different privacy metric, or use different sets of

4642

# quasi-identifiers, cannot store their results in the same table.

4643

# identified by its project_id, dataset_id, and table_name. Within a query

4644

# a table is often referenced with a string in the format of:

4645

# `<project_id>:<dataset_id>.<table_id>` or

4646

# `<project_id>.<dataset_id>.<table_id>`.

4647

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table.

4648

# If omitted, project ID is inferred from the API call.

4649

"datasetId": "A String", # Dataset ID of the table.

4650

"tableId": "A String", # Name of the table.

4651

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

4652

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only

4653

# used for Inspect and must be unspecified for Risk jobs. Columns are derived

4654

# from the `Finding` object. If appending to an existing table, any columns

4655

# from the predefined schema that are missing will be added. No columns in

4656

# the existing table will be deleted.

4657

#

4658

# If unspecified, then all available columns will be used for a new table or

4659

# an (existing) table with no schema, and no changes will be made to an

4660

# existing table that has a schema.

4661

# Only for use with external storage.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

4662

},

4663

},

4664

"pubSub": { # Publish a message into given Pub/Sub topic when DlpJob has completed. The # Publish a notification to a pubsub topic.

4665

# message contains a single field, `DlpJobName`, which is equal to the

4666

# finished job's

4667

# [`DlpJob.name`](/dlp/docs/reference/rest/v2/projects.dlpJobs#DlpJob).

4668

# Compatible with: Inspect, Risk

4669

"topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given

4670

# publishing access rights to the DLP API service account executing

4671

# the long running DlpJob sending the notifications.

4672

# Format is projects/{project}/topics/{topic}.

4673

},

4674

"publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Cloud Data Catalog. Labels summarizing the # Publish findings to Cloud Datahub.

4675

# results of the DlpJob will be applied to the entry for the resource scanned

4676

# in Cloud Data Catalog. Any labels previously written by another DlpJob will

4677

# be deleted. InfoType naming patterns are strictly enforced when using this

4678

# feature. Note that the findings will be persisted in Cloud Data Catalog

4679

# storage and are governed by Data Catalog service-specific policy, see

4680

# https://cloud.google.com/terms/service-terms

4681

# Only a single instance of this action can be specified and only allowed if

4682

# all resources being scanned are BigQuery tables.

4683

# Compatible with: Inspect

4684

},

4685

"publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This # Enable Stackdriver metric dlp.googleapis.com/finding_count.

4686

# will publish a metric to stack driver on each infotype requested and

4687

# how many findings were found for it. CustomDetectors will be bucketed

4688

# as 'Custom' under the Stackdriver label 'info_type'.

},

},

],

"storageConfig": { # Shared message indicating Cloud storage type. # The data to scan.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

4693

"hybridOptions": { # Configuration to control jobs where the content being inspected is outside # Hybrid inspection options.

4694

# Early access feature is in a pre-release state and might change or have

4695

# limited support. For more information, see

4696

# https://cloud.google.com/products#product-launch-stages.

4697

# of Google Cloud Platform.

4698

"labels": { # To organize findings, these labels will be added to each finding.

4699

#

4700

# Label keys must be between 1 and 63 characters long and must conform

4701

# to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.

4702

#

4703

# Label values must be between 0 and 63 characters long and must conform

4704

# to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.

4705

#

4706

# No more than 10 labels can be associated with a given finding.

4707

#

4708

# Examples:

4709

# * `"environment" : "production"`

4710

# * `"pipeline" : "etl"`

4711

"a_key": "A String",

4712

},

4713

"description": "A String", # A short description of where the data is coming from. Will be stored once

4714

# in the job. 256 max length.

4715

"tableOptions": { # Instructions regarding the table content being inspected. # If the container is a table, additional information to make findings

4716

# meaningful such as the columns that are primary keys.

4717

"identifyingFields": [ # The columns that are the primary keys for table objects included in

4718

# ContentItem. A copy of this cell's value will stored alongside alongside

4719

# each finding so that the finding can be traced to the specific row it came

4720

# from. No more than 3 may be provided.

4721

{ # General identifier of a data field in a storage service.

4722

"name": "A String", # Name describing the field.

},

],

},

"requiredFindingLabelKeys": [ # These are labels that each inspection request must include within their

4727

# 'finding_labels' map. Request may contain others, but any missing one of

4728

# these will be rejected.

4729

#

4730

# Label keys must be between 1 and 63 characters long and must conform

4731

# to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.

4732

#

4733

# No more than 10 keys can be required.

4734

"A String",

4735

],

4736

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

4737

"datastoreOptions": { # Options defining a data set within Google Cloud Datastore. # Google Cloud Datastore options.

4738

"partitionId": { # Datastore partition ID. # A partition ID identifies a grouping of entities. The grouping is always

4739

# by project and namespace, however the namespace ID may be empty.

4740

# A partition ID identifies a grouping of entities. The grouping is always

4741

# by project and namespace, however the namespace ID may be empty.

4742

#

4743

# A partition ID contains several dimensions:

4744

# project ID and namespace ID.

4745

"projectId": "A String", # The ID of the project to which the entities belong.

4746

"namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.

4747

},

4748

"kind": { # A representation of a Datastore kind. # The kind to process.

4749

"name": "A String", # The name of the kind.

4750

},

4751

},

4752

"timespanConfig": { # Configuration of the timespan of the items to include in scanning.

4753

# Currently only supported when inspecting Google Cloud Storage and BigQuery.

4754

"timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items.

4755

# Used for data sources like Datastore and BigQuery.

4756

#

4757

# For BigQuery:

4758

# Required to filter out rows based on the given start and

4759

# end times. If not specified and the table was modified between the given

4760

# start and end times, the entire table will be scanned.

4761

# The valid data types of the timestamp field are: `INTEGER`, `DATE`,

4762

# `TIMESTAMP`, or `DATETIME` BigQuery column.

4763

#

4764

# For Datastore.

4765

# Valid data types of the timestamp field are: `TIMESTAMP`.

4766

# Datastore entity will be scanned if the timestamp property does not

4767

# exist or its value is empty or invalid.

4768

"name": "A String", # Name describing the field.

4769

},

4770

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out

4771

# a valid start_time to avoid scanning files that have not been modified

4772

# since the last time the JobTrigger executed. This will be based on the

4773

# time of the execution of the last run of the JobTrigger.

4774

"endTime": "A String", # Exclude files or rows newer than this value.

4775

# If set to zero, no upper time limit is applied.

4776

"startTime": "A String", # Exclude files or rows older than this value.

4777

},

4778

"cloudStorageOptions": { # Options defining a file or a set of files within a Google Cloud Storage # Google Cloud Storage options.

4779

# bucket.

4780

"bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger

4781

# than this value then the rest of the bytes are omitted. Only one

4782

# of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.

4783

"fileSet": { # Set of files to scan. # The set of one or more files to scan.

4784

"regexFileSet": { # Message representing a set of files in a Cloud Storage bucket. Regular # The regex-filtered set of files to scan. Exactly one of `url` or

4785

# `regex_file_set` must be set.

4786

# expressions are used to allow fine-grained control over which files in the

4787

# bucket to include.

4788

#

4789

# Included files are those that match at least one item in `include_regex` and

4790

# do not match any items in `exclude_regex`. Note that a file that matches

4791

# items from both lists will _not_ be included. For a match to occur, the

4792

# entire file path (i.e., everything in the url after the bucket name) must

4793

# match the regular expression.

4794

#

4795

# For example, given the input `{bucket_name: "mybucket", include_regex:

4796

# ["directory1/.*"], exclude_regex:

4797

# ["directory1/excluded.*"]}`:

4798

#

4799

# * `gs://mybucket/directory1/myfile` will be included

4800

# * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches

4801

# across `/`)

4802

# * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the

4803

# full path doesn't match any items in `include_regex`)

4804

# * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path

4805

# matches an item in `exclude_regex`)

4806

#

4807

# If `include_regex` is left empty, it will match all files by default

4808

# (this is equivalent to setting `include_regex: [".*"]`).

4809

#

4810

# Some other common use cases:

4811

#

4812

# * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all

4813

# files in `mybucket` except for .pdf files

4814

# * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will

4815

# include all files directly under `gs://mybucket/directory/`, without matching

4816

# across `/`

4817

"bucketName": "A String", # The name of a Cloud Storage bucket. Required.

4818

"includeRegex": [ # A list of regular expressions matching file paths to include. All files in

4819

# the bucket that match at least one of these regular expressions will be

4820

# included in the set of files, except for those that also match an item in

4821

# `exclude_regex`. Leaving this field empty will match all files by default

4822

# (this is equivalent to including `.*` in the list).

4823

#

4824

# Regular expressions use RE2

4825

# [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found

4826

# under the google/re2 repository on GitHub.

4827

"A String",

4828

],

4829

"excludeRegex": [ # A list of regular expressions matching file paths to exclude. All files in

4830

# the bucket that match at least one of these regular expressions will be

4831

# excluded from the scan.

4832

#

4833

# Regular expressions use RE2

4834

# [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found

4835

# under the google/re2 repository on GitHub.

"A String",

],

},

"url": "A String", # The Cloud Storage url of the file(s) to scan, in the format

4840

# `gs://<bucket>/<path>`. Trailing wildcard in the path is allowed.

4841

#

4842

# If the url ends in a trailing slash, the bucket or directory represented

4843

# by the url will be scanned non-recursively (content in sub-directories

4844

# will not be scanned). This means that `gs://mybucket/` is equivalent to

4845

# `gs://mybucket/*`, and `gs://mybucket/directory/` is equivalent to

4846

# `gs://mybucket/directory/*`.

4847

#

4848

# Exactly one of `url` or `regex_file_set` must be set.

4849

},

4850

"filesLimitPercent": 42, # Limits the number of files to scan to this percentage of the input FileSet.

4851

# Number of files scanned is rounded down. Must be between 0 and 100,

4852

# inclusively. Both 0 and 100 means no limit. Defaults to 0.

4853

"fileTypes": [ # List of file type groups to include in the scan.

4854

# If empty, all files are scanned and available data format processors

4855

# are applied. In addition, the binary content of the selected files

4856

# is always scanned as well.

4857

# Images are scanned only as binary if the specified region

4858

# does not support image inspection and no file_types were specified.

4859

# Image inspection is restricted to 'global', 'us', 'asia', and 'europe'.

4860

"A String",

4861

],

4862

"sampleMethod": "A String",

4863

"bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The

4864

# number of bytes scanned is rounded down. Must be between 0 and 100,

4865

# inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one

4866

# of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.

4867

},

4868

"bigQueryOptions": { # Options defining BigQuery table and row identifiers. # BigQuery options.

4869

"tableReference": { # Message defining the location of a BigQuery table. A table is uniquely # Complete BigQuery table reference.

4870

# identified by its project_id, dataset_id, and table_name. Within a query

4871

# a table is often referenced with a string in the format of:

4872

# `<project_id>:<dataset_id>.<table_id>` or

4873

# `<project_id>.<dataset_id>.<table_id>`.

4874

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table.

4875

# If omitted, project ID is inferred from the API call.

4876

"datasetId": "A String", # Dataset ID of the table.

4877

"tableId": "A String", # Name of the table.

4878

},

4879

"identifyingFields": [ # Table fields that may uniquely identify a row within the table. When

4880

# `actions.saveFindings.outputConfig.table` is specified, the values of

4881

# columns specified here are available in the output table under

4882

# `location.content_locations.record_location.record_key.id_values`. Nested

4883

# fields such as `person.birthdate.year` are allowed.

4884

{ # General identifier of a data field in a storage service.

4885

"name": "A String", # Name describing the field.

4886

},

4887

],

4888

"rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows

4889

# scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and

4890

# 100 means no limit. Defaults to 0. Only one of rows_limit and

4891

# rows_limit_percent can be specified. Cannot be used in conjunction with

4892

# TimespanConfig.

4893

"rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the

4894

# rest of the rows are omitted. If not set, or if set to 0, all rows will be

4895

# scanned. Only one of rows_limit and rows_limit_percent can be specified.

4896

# Cannot be used in conjunction with TimespanConfig.

4897

"excludedFields": [ # References to fields excluded from scanning. This allows you to skip

4898

# inspection of entire columns which you know have no findings.

4899

{ # General identifier of a data field in a storage service.

4900

"name": "A String", # Name describing the field.

4901

},

4902

],

4903

"sampleMethod": "A String",

4904

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

4905

},

4906

"inspectTemplateName": "A String", # If provided, will be used as the default for all values in InspectConfig.

4907

# `inspect_config` will be merged into the values persisted as part of the

4908

# template.

4909

},

4910

"status": "A String", # Required. A status for this trigger.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

4911

},

4912

],

4913

"nextPageToken": "A String", # If the next page is available then the next page token to be used

4914

# in following ListJobTriggers request.

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

4920

<pre>Retrieves the next page of results.

4921

4922

Args:

4923

previous_request: The request for the previous page. (required)

4924

previous_response: The response from the request for the previous page. (required)

4925

4926

Returns:

4927

A request object that you can call 'execute()' on to request the next

4928

page. Returns None if there are no more items in the collection.

</pre>

</div>

<code class="details" id="patch">patch(name, body=None, x__xgafv=None)</code>

4934

<pre>Updates a job trigger.

4935

See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.

4936

4937

Args:

4938

name: string, Required. Resource name of the project and the triggeredJob, for example

4939

`projects/dlp-test-project/jobTriggers/53234423`. (required)

4940

body: object, The request body.

4941

The object takes the form of:

4942

4943

{ # Request message for UpdateJobTrigger.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

4944

"jobTrigger": { # Contains a configuration to make dlp api calls on a repeating basis. # New JobTrigger value.

4945

# See https://cloud.google.com/dlp/docs/concepts-job-triggers to learn more.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

4946

"lastRunTime": "A String", # Output only. The timestamp of the last time this trigger executed.

4947

"name": "A String", # Unique resource name for the triggeredJob, assigned by the service when the

4948

# triggeredJob is created, for example

4949

# `projects/dlp-test-project/jobTriggers/53234423`.

4950

"errors": [ # Output only. A stream of errors encountered when the trigger was activated. Repeated

4951

# errors may result in the JobTrigger automatically being paused.

4952

# Will return the last 100 errors. Whenever the JobTrigger is modified

4953

# this list will be cleared.

4954

{ # Details information about an error encountered during job execution or

4955

# the results of an unsuccessful activation of the JobTrigger.

4956

"details": { # The `Status` type defines a logical error model that is suitable for # Detailed error codes and messages.

4957

# different programming environments, including REST APIs and RPC APIs. It is

4958

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

4959

# three pieces of data: error code, error message, and error details.

4960

#

4961

# You can find out more about this error model and how to work with it in the

4962

# [API Design Guide](https://cloud.google.com/apis/design/errors).

4963

"message": "A String", # A developer-facing error message, which should be in English. Any

4964

# user-facing error message should be localized and sent in the

4965

# google.rpc.Status.details field, or localized by the client.

4966

"details": [ # A list of messages that carry the error details. There is a common set of

4967

# message types for APIs to use.

4968

{

4969

"a_key": "", # Properties of the object. Contains field @type with type URL.

4970

},

4971

],

4972

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

4973

},

4974

"timestamps": [ # The times the error occurred.

"A String",

],

},

],

"description": "A String", # User provided description (max 256 chars)

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

4980

"triggers": [ # A list of triggers which will be OR'ed together. Only one in the list

4981

# needs to trigger for a job to be started. The list may contain only

4982

# a single Schedule trigger and must have at least one object.

4983

{ # What event needs to occur for a new job to be started.

4984

"schedule": { # Schedule for triggeredJobs. # Create a job on a repeating basis based on the elapse of time.

4985

"recurrencePeriodDuration": "A String", # With this option a job is started a regular periodic basis. For

4986

# example: every day (86400 seconds).

4987

#

4988

# A scheduled start time will be skipped if the previous

4989

# execution has not ended when its scheduled time occurs.

4990

#

4991

# This value must be set to a time duration greater than or equal

4992

# to 1 day and can be no longer than 60 days.

4993

},

4994

"manual": { # Job trigger option for hybrid jobs. Jobs must be manually created # For use with hybrid jobs. Jobs must be manually created and finished.

4995

# Early access feature is in a pre-release state and might change or have

4996

# limited support. For more information, see

4997

# https://cloud.google.com/products#product-launch-stages.

# and finished.

},

},

],

"displayName": "A String", # Display name (max 100 chars)

5003

"createTime": "A String", # Output only. The creation timestamp of a triggeredJob.

5004

"updateTime": "A String", # Output only. The last update timestamp of a triggeredJob.

5005

"inspectJob": { # Controls what and how to inspect for findings. # For inspect jobs, a snapshot of the configuration.

5006

"inspectConfig": { # Configuration description of the scanning process. # How and what to scan for.

5007

# When used with redactContent only info_types and min_likelihood are currently

5008

# used.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

5009

"minLikelihood": "A String", # Only returns findings equal or above this threshold. The default is

5010

# POSSIBLE.

5011

# See https://cloud.google.com/dlp/docs/likelihood to learn more.

5012

"contentOptions": [ # List of options defining data content to scan.

5013

# If empty, text, images, and other content will be included.

5014

"A String",

5015

],

5016

"infoTypes": [ # Restricts what info_types to look for. The values must correspond to

5017

# InfoType values returned by ListInfoTypes or listed at

5018

# https://cloud.google.com/dlp/docs/infotypes-reference.

5019

#

5020

# When no InfoTypes or CustomInfoTypes are specified in a request, the

5021

# system may automatically choose what detectors to run. By default this may

5022

# be all types, but may change over time as detectors are updated.

5023

#

5024

# If you need precise control and predictability as to what detectors are

5025

# run you should specify specific InfoTypes listed in the reference,

5026

# otherwise a default list will be used, which may change over time.

5027

{ # Type of information detected by the API.

5028

"name": "A String", # Name of the information type. Either a name of your choosing when

5029

# creating a CustomInfoType, or one of the names listed

5030

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

5031

# a built-in type. InfoType names should conform to the pattern

5032

# `[a-zA-Z0-9_]{1,64}`.

5033

},

5034

],

5035

"excludeInfoTypes": True or False, # When true, excludes type information of the findings.

5036

"customInfoTypes": [ # CustomInfoTypes provided by the user. See

5037

# https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more.

5038

{ # Custom information type provided by the user. Used to find domain-specific

5039

# sensitive information configurable to the data in question.

5040

"surrogateType": { # Message for detecting output from deidentification transformations # Message for detecting output from deidentification transformations that

5041

# support reversing.

5042

# such as

5043

# [`CryptoReplaceFfxFpeConfig`](/dlp/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig).

5044

# These types of transformations are

5045

# those that perform pseudonymization, thereby producing a "surrogate" as

5046

# output. This should be used in conjunction with a field on the

5047

# transformation such as `surrogate_info_type`. This CustomInfoType does

5048

# not support the use of `detection_rules`.

5049

},

5050

"likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be

5051

# altered by a detection rule if the finding meets the criteria specified by

5052

# the rule. Defaults to `VERY_LIKELY` if not specified.

5053

"infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in

5054

# infoType, when the name matches one of existing infoTypes and that infoType

5055

# is specified in `InspectContent.info_types` field. Specifying the latter

5056

# adds findings to the one detected by the system. If built-in info type is

5057

# not specified in `InspectContent.info_types` list then the name is treated

5058

# as a custom info type.

5059

"name": "A String", # Name of the information type. Either a name of your choosing when

5060

# creating a CustomInfoType, or one of the names listed

5061

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

5062

# a built-in type. InfoType names should conform to the pattern

5063

# `[a-zA-Z0-9_]{1,64}`.

5064

},

5065

"regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType.

5066

"groupIndexes": [ # The index of the submatch to extract as findings. When not

5067

# specified, the entire match is returned. No more than 3 may be included.

5068

42,

5069

],

5070

"pattern": "A String", # Pattern defining the regular expression. Its syntax

5071

# (https://github.com/google/re2/wiki/Syntax) can be found under the

5072

# google/re2 repository on GitHub.

5073

},

5074

"detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType.

5075

# Rules are applied in order that they are specified. Not supported for the

5076

# `surrogate_type` CustomInfoType.

5077

{ # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a

5078

# `CustomInfoType` to alter behavior under certain circumstances, depending

5079

# on the specific details of the rule. Not supported for the `surrogate_type`

5080

# custom infoType.

5081

"hotwordRule": { # The rule that adjusts the likelihood of findings within a certain # Hotword-based detection rule.

5082

# proximity of hotwords.

5083

"likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as # Likelihood adjustment to apply to all matching findings.

5084

# part of a detection rule.

5085

"relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of

5086

# levels. For example, if a finding would be `POSSIBLE` without the

5087

# detection rule and `relative_likelihood` is 1, then it is upgraded to

5088

# `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`.

5089

# Likelihood may never drop below `VERY_UNLIKELY` or exceed

5090

# `VERY_LIKELY`, so applying an adjustment of 1 followed by an

5091

# adjustment of -1 when base likelihood is `VERY_LIKELY` will result in

5092

# a final likelihood of `LIKELY`.

5093

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value.

5094

},

5095

"hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword.

5096

"groupIndexes": [ # The index of the submatch to extract as findings. When not

5097

# specified, the entire match is returned. No more than 3 may be included.

5098

42,

5099

],

5100

"pattern": "A String", # Pattern defining the regular expression. Its syntax

5101

# (https://github.com/google/re2/wiki/Syntax) can be found under the

5102

# google/re2 repository on GitHub.

5103

},

5104

"proximity": { # Message for specifying a window around a finding to apply a detection # Proximity of the finding within which the entire hotword must reside.

5105

# The total length of the window cannot exceed 1000 characters. Note that

5106

# the finding itself will be included in the window, so that hotwords may

5107

# be used to match substrings of the finding itself. For example, the

5108

# certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be

5109

# adjusted upwards if the area code is known to be the local area code of

5110

# a company office using the hotword regex "\(xxx\)", where "xxx"

5111

# is the area code in question.

5112

# rule.

5113

"windowBefore": 42, # Number of characters before the finding to consider.

5114

"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

5120

# to be returned. It still can be used for rules matching.

5121

"dictionary": { # Custom information type based on a dictionary of words or phrases. This can # A list of phrases to detect as a CustomInfoType.

5122

# be used to match sensitive information specific to the data, such as a list

5123

# of employee IDs or job titles.

5124

#

5125

# Dictionary words are case-insensitive and all characters other than letters

5126

# and digits in the unicode [Basic Multilingual

5127

# Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane)

5128

# will be replaced with whitespace when scanning for matches, so the

5129

# dictionary phrase "Sam Johnson" will match all three phrases "sam johnson",

5130

# "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters

5131

# surrounding any match must be of a different type than the adjacent

5132

# characters within the word, so letters must be next to non-letters and

5133

# digits next to non-digits. For example, the dictionary word "jen" will

5134

# match the first three letters of the text "jen123" but will return no

5135

# matches for "jennifer".

5136

#

5137

# Dictionary words containing a large number of characters that are not

5138

# letters or digits may result in unexpected findings because such characters

5139

# are treated as whitespace. The

5140

# [limits](https://cloud.google.com/dlp/limits) page contains details about

5141

# the size limits of dictionaries. For dictionaries that do not fit within

5142

# these constraints, consider using `LargeCustomDictionaryConfig` in the

5143

# `StoredInfoType` API.

5144

"wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for.

5145

"words": [ # Words or phrases defining the dictionary. The dictionary must contain

5146

# at least one phrase and every phrase must contain at least 2 characters

5147

# 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

5152

# is accepted.

5153

"path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage.

5154

# Example: gs://[BUCKET_NAME]/dictionary.txt

5155

},

5156

},

5157

"storedType": { # A reference to a StoredInfoType to use with scanning. # Load an existing `StoredInfoType` resource for use in

5158

# `InspectDataSource`. Not currently supported in `InspectContent`.

5159

"name": "A String", # Resource name of the requested `StoredInfoType`, for example

5160

# `organizations/433245324/storedInfoTypes/432452342` or

5161

# `projects/project-id/storedInfoTypes/432452342`.

5162

"createTime": "A String", # Timestamp indicating when the version of the `StoredInfoType` used for

5163

# inspection was created. Output-only field, populated by the system.

5164

},

5165

},

5166

],

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

5167

"includeQuote": True or False, # When true, a contextual quote from the data that triggered a finding is

5168

# included in the response; see Finding.quote.

5169

"ruleSet": [ # Set of rules to apply to the findings for this InspectConfig.

5170

# Exclusion rules, contained in the set are executed in the end, other

5171

# rules are executed in the order they are specified for each info type.

5172

{ # Rule set for modifying a set of infoTypes to alter behavior under certain

5173

# circumstances, depending on the specific details of the rules within the set.

5174

"infoTypes": [ # List of infoTypes this rule set is applied to.

5175

{ # Type of information detected by the API.

5176

"name": "A String", # Name of the information type. Either a name of your choosing when

5177

# creating a CustomInfoType, or one of the names listed

5178

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

5179

# a built-in type. InfoType names should conform to the pattern

5180

# `[a-zA-Z0-9_]{1,64}`.

5181

},

5182

],

5183

"rules": [ # Set of rules to be applied to infoTypes. The rules are applied in order.

5184

{ # A single inspection rule to be applied to infoTypes, specified in

5185

# `InspectionRuleSet`.

5186

"hotwordRule": { # The rule that adjusts the likelihood of findings within a certain # Hotword-based detection rule.

5187

# proximity of hotwords.

5188

"likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as # Likelihood adjustment to apply to all matching findings.

5189

# part of a detection rule.

5190

"relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of

5191

# levels. For example, if a finding would be `POSSIBLE` without the

5192

# detection rule and `relative_likelihood` is 1, then it is upgraded to

5193

# `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`.

5194

# Likelihood may never drop below `VERY_UNLIKELY` or exceed

5195

# `VERY_LIKELY`, so applying an adjustment of 1 followed by an

5196

# adjustment of -1 when base likelihood is `VERY_LIKELY` will result in

5197

# a final likelihood of `LIKELY`.

5198

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value.

5199

},

5200

"hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword.

5201

"groupIndexes": [ # The index of the submatch to extract as findings. When not

5202

# specified, the entire match is returned. No more than 3 may be included.

5203

42,

5204

],

5205

"pattern": "A String", # Pattern defining the regular expression. Its syntax

5206

# (https://github.com/google/re2/wiki/Syntax) can be found under the

5207

# google/re2 repository on GitHub.

5208

},

5209

"proximity": { # Message for specifying a window around a finding to apply a detection # Proximity of the finding within which the entire hotword must reside.

5210

# The total length of the window cannot exceed 1000 characters. Note that

5211

# the finding itself will be included in the window, so that hotwords may

5212

# be used to match substrings of the finding itself. For example, the

5213

# certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be

5214

# adjusted upwards if the area code is known to be the local area code of

5215

# a company office using the hotword regex "\(xxx\)", where "xxx"

5216

# is the area code in question.

5217

# rule.

5218

"windowBefore": 42, # Number of characters before the finding to consider.

5219

"windowAfter": 42, # Number of characters after the finding to consider.

5220

},

5221

},

5222

"exclusionRule": { # The rule that specifies conditions when findings of infoTypes specified in # Exclusion rule.

5223

# `InspectionRuleSet` are removed from results.

5224

"dictionary": { # Custom information type based on a dictionary of words or phrases. This can # Dictionary which defines the rule.

5225

# be used to match sensitive information specific to the data, such as a list

5226

# of employee IDs or job titles.

5227

#

5228

# Dictionary words are case-insensitive and all characters other than letters

5229

# and digits in the unicode [Basic Multilingual

5230

# Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane)

5231

# will be replaced with whitespace when scanning for matches, so the

5232

# dictionary phrase "Sam Johnson" will match all three phrases "sam johnson",

5233

# "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters

5234

# surrounding any match must be of a different type than the adjacent

5235

# characters within the word, so letters must be next to non-letters and

5236

# digits next to non-digits. For example, the dictionary word "jen" will

5237

# match the first three letters of the text "jen123" but will return no

5238

# matches for "jennifer".

5239

#

5240

# Dictionary words containing a large number of characters that are not

5241

# letters or digits may result in unexpected findings because such characters

5242

# are treated as whitespace. The

5243

# [limits](https://cloud.google.com/dlp/limits) page contains details about

5244

# the size limits of dictionaries. For dictionaries that do not fit within

5245

# these constraints, consider using `LargeCustomDictionaryConfig` in the

5246

# `StoredInfoType` API.

5247

"wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for.

5248

"words": [ # Words or phrases defining the dictionary. The dictionary must contain

5249

# at least one phrase and every phrase must contain at least 2 characters

5250

# 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

5255

# is accepted.

5256

"path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage.

5257

# Example: gs://[BUCKET_NAME]/dictionary.txt

5258

},

5259

},

5260

"regex": { # Message defining a custom regular expression. # Regular expression which defines the rule.

5261

"groupIndexes": [ # The index of the submatch to extract as findings. When not

5262

# specified, the entire match is returned. No more than 3 may be included.

5263

42,

5264

],

5265

"pattern": "A String", # Pattern defining the regular expression. Its syntax

5266

# (https://github.com/google/re2/wiki/Syntax) can be found under the

5267

# google/re2 repository on GitHub.

5268

},

5269

"excludeInfoTypes": { # List of exclude infoTypes. # Set of infoTypes for which findings would affect this rule.

5270

"infoTypes": [ # InfoType list in ExclusionRule rule drops a finding when it overlaps or

5271

# contained within with a finding of an infoType from this list. For

5272

# example, for `InspectionRuleSet.info_types` containing "PHONE_NUMBER"` and

5273

# `exclusion_rule` containing `exclude_info_types.info_types` with

5274

# "EMAIL_ADDRESS" the phone number findings are dropped if they overlap

5275

# with EMAIL_ADDRESS finding.

5276

# That leads to "555-222-2222@example.org" to generate only a single

5277

# finding, namely email address.

5278

{ # Type of information detected by the API.

5279

"name": "A String", # Name of the information type. Either a name of your choosing when

5280

# creating a CustomInfoType, or one of the names listed

5281

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

5282

# a built-in type. InfoType names should conform to the pattern

5283

# `[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.

5294

"maxFindingsPerItem": 42, # Max number of findings that will be returned for each item scanned.

5295

# When set within `InspectJobConfig`,

5296

# the maximum returned is 2000 regardless if this is set higher.

5297

# When set within `InspectContentRequest`, this field is ignored.

5298

"maxFindingsPerInfoType": [ # Configuration of findings limit given for specified infoTypes.

5299

{ # Max findings configuration per infoType, per content item or long

5300

# running DlpJob.

5301

"maxFindings": 42, # Max findings limit for the given infoType.

5302

"infoType": { # Type of information detected by the API. # Type of information the findings limit applies to. Only one limit per

5303

# info_type should be provided. If InfoTypeLimit does not have an

5304

# info_type, the DLP API applies the limit against all info_types that

5305

# are found but not specified in another InfoTypeLimit.

5306

"name": "A String", # Name of the information type. Either a name of your choosing when

5307

# creating a CustomInfoType, or one of the names listed

5308

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

5309

# a built-in type. InfoType names should conform to the pattern

5310

# `[a-zA-Z0-9_]{1,64}`.

},

},

],

"maxFindingsPerRequest": 42, # Max number of findings that will be returned per request/job.

5315

# When set within `InspectContentRequest`, the maximum returned is 2000

5316

# regardless if this is set higher.

5317

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

5318

},

5319

"actions": [ # Actions to execute at the completion of the job.

5320

{ # A task to execute on the completion of a job.

5321

# See https://cloud.google.com/dlp/docs/concepts-actions to learn more.

5322

"publishSummaryToCscc": { # Publish the result summary of a DlpJob to the Cloud Security # Publish summary to Cloud Security Command Center (Alpha).

5323

# Command Center (CSCC Alpha).

5324

# This action is only available for projects which are parts of

5325

# an organization and whitelisted for the alpha Cloud Security Command

5326

# Center.

5327

# The action will publish count of finding instances and their info types.

5328

# The summary of findings will be persisted in CSCC and are governed by CSCC

5329

# service-specific policy, see https://cloud.google.com/terms/service-terms

5330

# Only a single instance of this action can be specified.

5331

# Compatible with: Inspect

5332

},

5333

"jobNotificationEmails": { # Enable email notification to project owners and editors on jobs's # Enable email notification for project owners and editors on job's

5334

# completion/failure.

5335

# completion/failure.

5336

},

5337

"saveFindings": { # If set, the detailed findings will be persisted to the specified # Save resulting findings in a provided location.

5338

# OutputStorageConfig. Only a single instance of this action can be

5339

# specified.

5340

# Compatible with: Inspect, Risk

5341

"outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

5342

"table": { # Message defining the location of a BigQuery table. A table is uniquely # Store findings in an existing table or a new table in an existing

5343

# dataset. If table_id is not set a new one will be generated

5344

# for you with the following format:

5345

# dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific timezone will be used for

5346

# generating the date details.

5347

#

5348

# For Inspect, each column in an existing output table must have the same

5349

# name, type, and mode of a field in the `Finding` object.

5350

#

5351

# For Risk, an existing output table should be the output of a previous

5352

# Risk analysis job run on the same source table, with the same privacy

5353

# metric and quasi-identifiers. Risk jobs that analyze the same table but

5354

# compute a different privacy metric, or use different sets of

5355

# quasi-identifiers, cannot store their results in the same table.

5356

# identified by its project_id, dataset_id, and table_name. Within a query

5357

# a table is often referenced with a string in the format of:

5358

# `<project_id>:<dataset_id>.<table_id>` or

5359

# `<project_id>.<dataset_id>.<table_id>`.

5360

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table.

5361

# If omitted, project ID is inferred from the API call.

5362

"datasetId": "A String", # Dataset ID of the table.

5363

"tableId": "A String", # Name of the table.

5364

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

5365

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only

5366

# used for Inspect and must be unspecified for Risk jobs. Columns are derived

5367

# from the `Finding` object. If appending to an existing table, any columns

5368

# from the predefined schema that are missing will be added. No columns in

5369

# the existing table will be deleted.

5370

#

5371

# If unspecified, then all available columns will be used for a new table or

5372

# an (existing) table with no schema, and no changes will be made to an

5373

# existing table that has a schema.

5374

# Only for use with external storage.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

5375

},

5376

},

5377

"pubSub": { # Publish a message into given Pub/Sub topic when DlpJob has completed. The # Publish a notification to a pubsub topic.

5378

# message contains a single field, `DlpJobName`, which is equal to the

5379

# finished job's

5380

# [`DlpJob.name`](/dlp/docs/reference/rest/v2/projects.dlpJobs#DlpJob).

5381

# Compatible with: Inspect, Risk

5382

"topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given

5383

# publishing access rights to the DLP API service account executing

5384

# the long running DlpJob sending the notifications.

5385

# Format is projects/{project}/topics/{topic}.

5386

},

5387

"publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Cloud Data Catalog. Labels summarizing the # Publish findings to Cloud Datahub.

5388

# results of the DlpJob will be applied to the entry for the resource scanned

5389

# in Cloud Data Catalog. Any labels previously written by another DlpJob will

5390

# be deleted. InfoType naming patterns are strictly enforced when using this

5391

# feature. Note that the findings will be persisted in Cloud Data Catalog

5392

# storage and are governed by Data Catalog service-specific policy, see

5393

# https://cloud.google.com/terms/service-terms

5394

# Only a single instance of this action can be specified and only allowed if

5395

# all resources being scanned are BigQuery tables.

5396

# Compatible with: Inspect

5397

},

5398

"publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This # Enable Stackdriver metric dlp.googleapis.com/finding_count.

5399

# will publish a metric to stack driver on each infotype requested and

5400

# how many findings were found for it. CustomDetectors will be bucketed

5401

# as 'Custom' under the Stackdriver label 'info_type'.

},

},

],

"storageConfig": { # Shared message indicating Cloud storage type. # The data to scan.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

5406

"hybridOptions": { # Configuration to control jobs where the content being inspected is outside # Hybrid inspection options.

5407

# Early access feature is in a pre-release state and might change or have

5408

# limited support. For more information, see

5409

# https://cloud.google.com/products#product-launch-stages.

5410

# of Google Cloud Platform.

5411

"labels": { # To organize findings, these labels will be added to each finding.

5412

#

5413

# Label keys must be between 1 and 63 characters long and must conform

5414

# to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.

5415

#

5416

# Label values must be between 0 and 63 characters long and must conform

5417

# to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.

5418

#

5419

# No more than 10 labels can be associated with a given finding.

5420

#

5421

# Examples:

5422

# * `"environment" : "production"`

5423

# * `"pipeline" : "etl"`

5424

"a_key": "A String",

5425

},

5426

"description": "A String", # A short description of where the data is coming from. Will be stored once

5427

# in the job. 256 max length.

5428

"tableOptions": { # Instructions regarding the table content being inspected. # If the container is a table, additional information to make findings

5429

# meaningful such as the columns that are primary keys.

5430

"identifyingFields": [ # The columns that are the primary keys for table objects included in

5431

# ContentItem. A copy of this cell's value will stored alongside alongside

5432

# each finding so that the finding can be traced to the specific row it came

5433

# from. No more than 3 may be provided.

5434

{ # General identifier of a data field in a storage service.

5435

"name": "A String", # Name describing the field.

},

],

},

"requiredFindingLabelKeys": [ # These are labels that each inspection request must include within their

5440

# 'finding_labels' map. Request may contain others, but any missing one of

5441

# these will be rejected.

5442

#

5443

# Label keys must be between 1 and 63 characters long and must conform

5444

# to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.

5445

#

5446

# No more than 10 keys can be required.

5447

"A String",

5448

],

5449

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

5450

"datastoreOptions": { # Options defining a data set within Google Cloud Datastore. # Google Cloud Datastore options.

5451

"partitionId": { # Datastore partition ID. # A partition ID identifies a grouping of entities. The grouping is always

5452

# by project and namespace, however the namespace ID may be empty.

5453

# A partition ID identifies a grouping of entities. The grouping is always

5454

# by project and namespace, however the namespace ID may be empty.

5455

#

5456

# A partition ID contains several dimensions:

5457

# project ID and namespace ID.

5458

"projectId": "A String", # The ID of the project to which the entities belong.

5459

"namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.

5460

},

5461

"kind": { # A representation of a Datastore kind. # The kind to process.

5462

"name": "A String", # The name of the kind.

5463

},

5464

},

5465

"timespanConfig": { # Configuration of the timespan of the items to include in scanning.

5466

# Currently only supported when inspecting Google Cloud Storage and BigQuery.

5467

"timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items.

5468

# Used for data sources like Datastore and BigQuery.

5469

#

5470

# For BigQuery:

5471

# Required to filter out rows based on the given start and

5472

# end times. If not specified and the table was modified between the given

5473

# start and end times, the entire table will be scanned.

5474

# The valid data types of the timestamp field are: `INTEGER`, `DATE`,

5475

# `TIMESTAMP`, or `DATETIME` BigQuery column.

5476

#

5477

# For Datastore.

5478

# Valid data types of the timestamp field are: `TIMESTAMP`.

5479

# Datastore entity will be scanned if the timestamp property does not

5480

# exist or its value is empty or invalid.

5481

"name": "A String", # Name describing the field.

5482

},

5483

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out

5484

# a valid start_time to avoid scanning files that have not been modified

5485

# since the last time the JobTrigger executed. This will be based on the

5486

# time of the execution of the last run of the JobTrigger.

5487

"endTime": "A String", # Exclude files or rows newer than this value.

5488

# If set to zero, no upper time limit is applied.

5489

"startTime": "A String", # Exclude files or rows older than this value.

5490

},

5491

"cloudStorageOptions": { # Options defining a file or a set of files within a Google Cloud Storage # Google Cloud Storage options.

5492

# bucket.

5493

"bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger

5494

# than this value then the rest of the bytes are omitted. Only one

5495

# of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.

5496

"fileSet": { # Set of files to scan. # The set of one or more files to scan.

5497

"regexFileSet": { # Message representing a set of files in a Cloud Storage bucket. Regular # The regex-filtered set of files to scan. Exactly one of `url` or

5498

# `regex_file_set` must be set.

5499

# expressions are used to allow fine-grained control over which files in the

5500

# bucket to include.

5501

#

5502

# Included files are those that match at least one item in `include_regex` and

5503

# do not match any items in `exclude_regex`. Note that a file that matches

5504

# items from both lists will _not_ be included. For a match to occur, the

5505

# entire file path (i.e., everything in the url after the bucket name) must

5506

# match the regular expression.

5507

#

5508

# For example, given the input `{bucket_name: "mybucket", include_regex:

5509

# ["directory1/.*"], exclude_regex:

5510

# ["directory1/excluded.*"]}`:

5511

#

5512

# * `gs://mybucket/directory1/myfile` will be included

5513

# * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches

5514

# across `/`)

5515

# * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the

5516

# full path doesn't match any items in `include_regex`)

5517

# * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path

5518

# matches an item in `exclude_regex`)

5519

#

5520

# If `include_regex` is left empty, it will match all files by default

5521

# (this is equivalent to setting `include_regex: [".*"]`).

5522

#

5523

# Some other common use cases:

5524

#

5525

# * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all

5526

# files in `mybucket` except for .pdf files

5527

# * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will

5528

# include all files directly under `gs://mybucket/directory/`, without matching

5529

# across `/`

5530

"bucketName": "A String", # The name of a Cloud Storage bucket. Required.

5531

"includeRegex": [ # A list of regular expressions matching file paths to include. All files in

5532

# the bucket that match at least one of these regular expressions will be

5533

# included in the set of files, except for those that also match an item in

5534

# `exclude_regex`. Leaving this field empty will match all files by default

5535

# (this is equivalent to including `.*` in the list).

5536

#

5537

# Regular expressions use RE2

5538

# [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found

5539

# under the google/re2 repository on GitHub.

5540

"A String",

5541

],

5542

"excludeRegex": [ # A list of regular expressions matching file paths to exclude. All files in

5543

# the bucket that match at least one of these regular expressions will be

5544

# excluded from the scan.

5545

#

5546

# Regular expressions use RE2

5547

# [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found

5548

# under the google/re2 repository on GitHub.

"A String",

],

},

"url": "A String", # The Cloud Storage url of the file(s) to scan, in the format

5553

# `gs://<bucket>/<path>`. Trailing wildcard in the path is allowed.

5554

#

5555

# If the url ends in a trailing slash, the bucket or directory represented

5556

# by the url will be scanned non-recursively (content in sub-directories

5557

# will not be scanned). This means that `gs://mybucket/` is equivalent to

5558

# `gs://mybucket/*`, and `gs://mybucket/directory/` is equivalent to

5559

# `gs://mybucket/directory/*`.

5560

#

5561

# Exactly one of `url` or `regex_file_set` must be set.

5562

},

5563

"filesLimitPercent": 42, # Limits the number of files to scan to this percentage of the input FileSet.

5564

# Number of files scanned is rounded down. Must be between 0 and 100,

5565

# inclusively. Both 0 and 100 means no limit. Defaults to 0.

5566

"fileTypes": [ # List of file type groups to include in the scan.

5567

# If empty, all files are scanned and available data format processors

5568

# are applied. In addition, the binary content of the selected files

5569

# is always scanned as well.

5570

# Images are scanned only as binary if the specified region

5571

# does not support image inspection and no file_types were specified.

5572

# Image inspection is restricted to 'global', 'us', 'asia', and 'europe'.

5573

"A String",

5574

],

5575

"sampleMethod": "A String",

5576

"bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The

5577

# number of bytes scanned is rounded down. Must be between 0 and 100,

5578

# inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one

5579

# of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.

5580

},

5581

"bigQueryOptions": { # Options defining BigQuery table and row identifiers. # BigQuery options.

5582

"tableReference": { # Message defining the location of a BigQuery table. A table is uniquely # Complete BigQuery table reference.

5583

# identified by its project_id, dataset_id, and table_name. Within a query

5584

# a table is often referenced with a string in the format of:

5585

# `<project_id>:<dataset_id>.<table_id>` or

5586

# `<project_id>.<dataset_id>.<table_id>`.

5587

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table.

5588

# If omitted, project ID is inferred from the API call.

5589

"datasetId": "A String", # Dataset ID of the table.

5590

"tableId": "A String", # Name of the table.

5591

},

5592

"identifyingFields": [ # Table fields that may uniquely identify a row within the table. When

5593

# `actions.saveFindings.outputConfig.table` is specified, the values of

5594

# columns specified here are available in the output table under

5595

# `location.content_locations.record_location.record_key.id_values`. Nested

5596

# fields such as `person.birthdate.year` are allowed.

5597

{ # General identifier of a data field in a storage service.

5598

"name": "A String", # Name describing the field.

5599

},

5600

],

5601

"rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows

5602

# scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and

5603

# 100 means no limit. Defaults to 0. Only one of rows_limit and

5604

# rows_limit_percent can be specified. Cannot be used in conjunction with

5605

# TimespanConfig.

5606

"rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the

5607

# rest of the rows are omitted. If not set, or if set to 0, all rows will be

5608

# scanned. Only one of rows_limit and rows_limit_percent can be specified.

5609

# Cannot be used in conjunction with TimespanConfig.

5610

"excludedFields": [ # References to fields excluded from scanning. This allows you to skip

5611

# inspection of entire columns which you know have no findings.

5612

{ # General identifier of a data field in a storage service.

5613

"name": "A String", # Name describing the field.

5614

},

5615

],

5616

"sampleMethod": "A String",

5617

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

5618

},

5619

"inspectTemplateName": "A String", # If provided, will be used as the default for all values in InspectConfig.

5620

# `inspect_config` will be merged into the values persisted as part of the

5621

# template.

5622

},

5623

"status": "A String", # Required. A status for this trigger.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

5624

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

5625

"updateMask": "A String", # Mask to control which fields get updated.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

5626

}

5627

5628

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

5635

5636

{ # Contains a configuration to make dlp api calls on a repeating basis.

5637

# See https://cloud.google.com/dlp/docs/concepts-job-triggers to learn more.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

5638

"lastRunTime": "A String", # Output only. The timestamp of the last time this trigger executed.

5639

"name": "A String", # Unique resource name for the triggeredJob, assigned by the service when the

5640

# triggeredJob is created, for example

5641

# `projects/dlp-test-project/jobTriggers/53234423`.

5642

"errors": [ # Output only. A stream of errors encountered when the trigger was activated. Repeated

5643

# errors may result in the JobTrigger automatically being paused.

5644

# Will return the last 100 errors. Whenever the JobTrigger is modified

5645

# this list will be cleared.

5646

{ # Details information about an error encountered during job execution or

5647

# the results of an unsuccessful activation of the JobTrigger.

5648

"details": { # The `Status` type defines a logical error model that is suitable for # Detailed error codes and messages.

5649

# different programming environments, including REST APIs and RPC APIs. It is

5650

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

5651

# three pieces of data: error code, error message, and error details.

5652

#

5653

# You can find out more about this error model and how to work with it in the

5654

# [API Design Guide](https://cloud.google.com/apis/design/errors).

5655

"message": "A String", # A developer-facing error message, which should be in English. Any

5656

# user-facing error message should be localized and sent in the

5657

# google.rpc.Status.details field, or localized by the client.

5658

"details": [ # A list of messages that carry the error details. There is a common set of

5659

# message types for APIs to use.

5660

{

5661

"a_key": "", # Properties of the object. Contains field @type with type URL.

5662

},

5663

],

5664

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

5665

},

5666

"timestamps": [ # The times the error occurred.

"A String",

],

},

],

"description": "A String", # User provided description (max 256 chars)

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

5672

"triggers": [ # A list of triggers which will be OR'ed together. Only one in the list

5673

# needs to trigger for a job to be started. The list may contain only

5674

# a single Schedule trigger and must have at least one object.

5675

{ # What event needs to occur for a new job to be started.

5676

"schedule": { # Schedule for triggeredJobs. # Create a job on a repeating basis based on the elapse of time.

5677

"recurrencePeriodDuration": "A String", # With this option a job is started a regular periodic basis. For

5678

# example: every day (86400 seconds).

5679

#

5680

# A scheduled start time will be skipped if the previous

5681

# execution has not ended when its scheduled time occurs.

5682

#

5683

# This value must be set to a time duration greater than or equal

5684

# to 1 day and can be no longer than 60 days.

5685

},

5686

"manual": { # Job trigger option for hybrid jobs. Jobs must be manually created # For use with hybrid jobs. Jobs must be manually created and finished.

5687

# Early access feature is in a pre-release state and might change or have

5688

# limited support. For more information, see

5689

# https://cloud.google.com/products#product-launch-stages.

# and finished.

},

},

],

"displayName": "A String", # Display name (max 100 chars)

5695

"createTime": "A String", # Output only. The creation timestamp of a triggeredJob.

5696

"updateTime": "A String", # Output only. The last update timestamp of a triggeredJob.

5697

"inspectJob": { # Controls what and how to inspect for findings. # For inspect jobs, a snapshot of the configuration.

5698

"inspectConfig": { # Configuration description of the scanning process. # How and what to scan for.

5699

# When used with redactContent only info_types and min_likelihood are currently

5700

# used.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

5701

"minLikelihood": "A String", # Only returns findings equal or above this threshold. The default is

5702

# POSSIBLE.

5703

# See https://cloud.google.com/dlp/docs/likelihood to learn more.

5704

"contentOptions": [ # List of options defining data content to scan.

5705

# If empty, text, images, and other content will be included.

5706

"A String",

5707

],

5708

"infoTypes": [ # Restricts what info_types to look for. The values must correspond to

5709

# InfoType values returned by ListInfoTypes or listed at

5710

# https://cloud.google.com/dlp/docs/infotypes-reference.

5711

#

5712

# When no InfoTypes or CustomInfoTypes are specified in a request, the

5713

# system may automatically choose what detectors to run. By default this may

5714

# be all types, but may change over time as detectors are updated.

5715

#

5716

# If you need precise control and predictability as to what detectors are

5717

# run you should specify specific InfoTypes listed in the reference,

5718

# otherwise a default list will be used, which may change over time.

5719

{ # Type of information detected by the API.

5720

"name": "A String", # Name of the information type. Either a name of your choosing when

5721

# creating a CustomInfoType, or one of the names listed

5722

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

5723

# a built-in type. InfoType names should conform to the pattern

5724

# `[a-zA-Z0-9_]{1,64}`.

5725

},

5726

],

5727

"excludeInfoTypes": True or False, # When true, excludes type information of the findings.

5728

"customInfoTypes": [ # CustomInfoTypes provided by the user. See

5729

# https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more.

5730

{ # Custom information type provided by the user. Used to find domain-specific

5731

# sensitive information configurable to the data in question.

5732

"surrogateType": { # Message for detecting output from deidentification transformations # Message for detecting output from deidentification transformations that

5733

# support reversing.

5734

# such as

5735

# [`CryptoReplaceFfxFpeConfig`](/dlp/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig).

5736

# These types of transformations are

5737

# those that perform pseudonymization, thereby producing a "surrogate" as

5738

# output. This should be used in conjunction with a field on the

5739

# transformation such as `surrogate_info_type`. This CustomInfoType does

5740

# not support the use of `detection_rules`.

5741

},

5742

"likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be

5743

# altered by a detection rule if the finding meets the criteria specified by

5744

# the rule. Defaults to `VERY_LIKELY` if not specified.

5745

"infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in

5746

# infoType, when the name matches one of existing infoTypes and that infoType

5747

# is specified in `InspectContent.info_types` field. Specifying the latter

5748

# adds findings to the one detected by the system. If built-in info type is

5749

# not specified in `InspectContent.info_types` list then the name is treated

5750

# as a custom info type.

5751

"name": "A String", # Name of the information type. Either a name of your choosing when

5752

# creating a CustomInfoType, or one of the names listed

5753

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

5754

# a built-in type. InfoType names should conform to the pattern

5755

# `[a-zA-Z0-9_]{1,64}`.

5756

},

5757

"regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType.

5758

"groupIndexes": [ # The index of the submatch to extract as findings. When not

5759

# specified, the entire match is returned. No more than 3 may be included.

5760

42,

5761

],

5762

"pattern": "A String", # Pattern defining the regular expression. Its syntax

5763

# (https://github.com/google/re2/wiki/Syntax) can be found under the

5764

# google/re2 repository on GitHub.

5765

},

5766

"detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType.

5767

# Rules are applied in order that they are specified. Not supported for the

5768

# `surrogate_type` CustomInfoType.

5769

{ # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a

5770

# `CustomInfoType` to alter behavior under certain circumstances, depending

5771

# on the specific details of the rule. Not supported for the `surrogate_type`

5772

# custom infoType.

5773

"hotwordRule": { # The rule that adjusts the likelihood of findings within a certain # Hotword-based detection rule.

5774

# proximity of hotwords.

5775

"likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as # Likelihood adjustment to apply to all matching findings.

5776

# part of a detection rule.

5777

"relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of

5778

# levels. For example, if a finding would be `POSSIBLE` without the

5779

# detection rule and `relative_likelihood` is 1, then it is upgraded to

5780

# `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`.

5781

# Likelihood may never drop below `VERY_UNLIKELY` or exceed

5782

# `VERY_LIKELY`, so applying an adjustment of 1 followed by an

5783

# adjustment of -1 when base likelihood is `VERY_LIKELY` will result in

5784

# a final likelihood of `LIKELY`.

5785

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value.

5786

},

5787

"hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword.

5788

"groupIndexes": [ # The index of the submatch to extract as findings. When not

5789

# specified, the entire match is returned. No more than 3 may be included.

5790

42,

5791

],

5792

"pattern": "A String", # Pattern defining the regular expression. Its syntax

5793

# (https://github.com/google/re2/wiki/Syntax) can be found under the

5794

# google/re2 repository on GitHub.

5795

},

5796

"proximity": { # Message for specifying a window around a finding to apply a detection # Proximity of the finding within which the entire hotword must reside.

5797

# The total length of the window cannot exceed 1000 characters. Note that

5798

# the finding itself will be included in the window, so that hotwords may

5799

# be used to match substrings of the finding itself. For example, the

5800

# certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be

5801

# adjusted upwards if the area code is known to be the local area code of

5802

# a company office using the hotword regex "\(xxx\)", where "xxx"

5803

# is the area code in question.

5804

# rule.

5805

"windowBefore": 42, # Number of characters before the finding to consider.

5806

"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

5812

# to be returned. It still can be used for rules matching.

5813

"dictionary": { # Custom information type based on a dictionary of words or phrases. This can # A list of phrases to detect as a CustomInfoType.

5814

# be used to match sensitive information specific to the data, such as a list

5815

# of employee IDs or job titles.

5816

#

5817

# Dictionary words are case-insensitive and all characters other than letters

5818

# and digits in the unicode [Basic Multilingual

5819

# Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane)

5820

# will be replaced with whitespace when scanning for matches, so the

5821

# dictionary phrase "Sam Johnson" will match all three phrases "sam johnson",

5822

# "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters

5823

# surrounding any match must be of a different type than the adjacent

5824

# characters within the word, so letters must be next to non-letters and

5825

# digits next to non-digits. For example, the dictionary word "jen" will

5826

# match the first three letters of the text "jen123" but will return no

5827

# matches for "jennifer".

5828

#

5829

# Dictionary words containing a large number of characters that are not

5830

# letters or digits may result in unexpected findings because such characters

5831

# are treated as whitespace. The

5832

# [limits](https://cloud.google.com/dlp/limits) page contains details about

5833

# the size limits of dictionaries. For dictionaries that do not fit within

5834

# these constraints, consider using `LargeCustomDictionaryConfig` in the

5835

# `StoredInfoType` API.

5836

"wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for.

5837

"words": [ # Words or phrases defining the dictionary. The dictionary must contain

5838

# at least one phrase and every phrase must contain at least 2 characters

5839

# 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

5844

# is accepted.

5845

"path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage.

5846

# Example: gs://[BUCKET_NAME]/dictionary.txt

5847

},

5848

},

5849

"storedType": { # A reference to a StoredInfoType to use with scanning. # Load an existing `StoredInfoType` resource for use in

5850

# `InspectDataSource`. Not currently supported in `InspectContent`.

5851

"name": "A String", # Resource name of the requested `StoredInfoType`, for example

5852

# `organizations/433245324/storedInfoTypes/432452342` or

5853

# `projects/project-id/storedInfoTypes/432452342`.

5854

"createTime": "A String", # Timestamp indicating when the version of the `StoredInfoType` used for

5855

# inspection was created. Output-only field, populated by the system.

5856

},

5857

},

5858

],

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

5859

"includeQuote": True or False, # When true, a contextual quote from the data that triggered a finding is

5860

# included in the response; see Finding.quote.

5861

"ruleSet": [ # Set of rules to apply to the findings for this InspectConfig.

5862

# Exclusion rules, contained in the set are executed in the end, other

5863

# rules are executed in the order they are specified for each info type.

5864

{ # Rule set for modifying a set of infoTypes to alter behavior under certain

5865

# circumstances, depending on the specific details of the rules within the set.

5866

"infoTypes": [ # List of infoTypes this rule set is applied to.

5867

{ # Type of information detected by the API.

5868

"name": "A String", # Name of the information type. Either a name of your choosing when

5869

# creating a CustomInfoType, or one of the names listed

5870

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

5871

# a built-in type. InfoType names should conform to the pattern

5872

# `[a-zA-Z0-9_]{1,64}`.

5873

},

5874

],

5875

"rules": [ # Set of rules to be applied to infoTypes. The rules are applied in order.

5876

{ # A single inspection rule to be applied to infoTypes, specified in

5877

# `InspectionRuleSet`.

5878

"hotwordRule": { # The rule that adjusts the likelihood of findings within a certain # Hotword-based detection rule.

5879

# proximity of hotwords.

5880

"likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as # Likelihood adjustment to apply to all matching findings.

5881

# part of a detection rule.

5882

"relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of

5883

# levels. For example, if a finding would be `POSSIBLE` without the

5884

# detection rule and `relative_likelihood` is 1, then it is upgraded to

5885

# `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`.

5886

# Likelihood may never drop below `VERY_UNLIKELY` or exceed

5887

# `VERY_LIKELY`, so applying an adjustment of 1 followed by an

5888

# adjustment of -1 when base likelihood is `VERY_LIKELY` will result in

5889

# a final likelihood of `LIKELY`.

5890

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value.

5891

},

5892

"hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword.

5893

"groupIndexes": [ # The index of the submatch to extract as findings. When not

5894

# specified, the entire match is returned. No more than 3 may be included.

5895

42,

5896

],

5897

"pattern": "A String", # Pattern defining the regular expression. Its syntax

5898

# (https://github.com/google/re2/wiki/Syntax) can be found under the

5899

# google/re2 repository on GitHub.

5900

},

5901

"proximity": { # Message for specifying a window around a finding to apply a detection # Proximity of the finding within which the entire hotword must reside.

5902

# The total length of the window cannot exceed 1000 characters. Note that

5903

# the finding itself will be included in the window, so that hotwords may

5904

# be used to match substrings of the finding itself. For example, the

5905

# certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be

5906

# adjusted upwards if the area code is known to be the local area code of

5907

# a company office using the hotword regex "\(xxx\)", where "xxx"

5908

# is the area code in question.

5909

# rule.

5910

"windowBefore": 42, # Number of characters before the finding to consider.

5911

"windowAfter": 42, # Number of characters after the finding to consider.

5912

},

5913

},

5914

"exclusionRule": { # The rule that specifies conditions when findings of infoTypes specified in # Exclusion rule.

5915

# `InspectionRuleSet` are removed from results.

5916

"dictionary": { # Custom information type based on a dictionary of words or phrases. This can # Dictionary which defines the rule.

5917

# be used to match sensitive information specific to the data, such as a list

5918

# of employee IDs or job titles.

5919

#

5920

# Dictionary words are case-insensitive and all characters other than letters

5921

# and digits in the unicode [Basic Multilingual

5922

# Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane)

5923

# will be replaced with whitespace when scanning for matches, so the

5924

# dictionary phrase "Sam Johnson" will match all three phrases "sam johnson",

5925

# "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters

5926

# surrounding any match must be of a different type than the adjacent

5927

# characters within the word, so letters must be next to non-letters and

5928

# digits next to non-digits. For example, the dictionary word "jen" will

5929

# match the first three letters of the text "jen123" but will return no

5930

# matches for "jennifer".

5931

#

5932

# Dictionary words containing a large number of characters that are not

5933

# letters or digits may result in unexpected findings because such characters

5934

# are treated as whitespace. The

5935

# [limits](https://cloud.google.com/dlp/limits) page contains details about

5936

# the size limits of dictionaries. For dictionaries that do not fit within

5937

# these constraints, consider using `LargeCustomDictionaryConfig` in the

5938

# `StoredInfoType` API.

5939

"wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for.

5940

"words": [ # Words or phrases defining the dictionary. The dictionary must contain

5941

# at least one phrase and every phrase must contain at least 2 characters

5942

# 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

5947

# is accepted.

5948

"path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage.

5949

# Example: gs://[BUCKET_NAME]/dictionary.txt

5950

},

5951

},

5952

"regex": { # Message defining a custom regular expression. # Regular expression which defines the rule.

5953

"groupIndexes": [ # The index of the submatch to extract as findings. When not

5954

# specified, the entire match is returned. No more than 3 may be included.

5955

42,

5956

],

5957

"pattern": "A String", # Pattern defining the regular expression. Its syntax

5958

# (https://github.com/google/re2/wiki/Syntax) can be found under the

5959

# google/re2 repository on GitHub.

5960

},

5961

"excludeInfoTypes": { # List of exclude infoTypes. # Set of infoTypes for which findings would affect this rule.

5962

"infoTypes": [ # InfoType list in ExclusionRule rule drops a finding when it overlaps or

5963

# contained within with a finding of an infoType from this list. For

5964

# example, for `InspectionRuleSet.info_types` containing "PHONE_NUMBER"` and

5965

# `exclusion_rule` containing `exclude_info_types.info_types` with

5966

# "EMAIL_ADDRESS" the phone number findings are dropped if they overlap

5967

# with EMAIL_ADDRESS finding.

5968

# That leads to "555-222-2222@example.org" to generate only a single

5969

# finding, namely email address.

5970

{ # Type of information detected by the API.

5971

"name": "A String", # Name of the information type. Either a name of your choosing when

5972

# creating a CustomInfoType, or one of the names listed

5973

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

5974

# a built-in type. InfoType names should conform to the pattern

5975

# `[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.

5986

"maxFindingsPerItem": 42, # Max number of findings that will be returned for each item scanned.

5987

# When set within `InspectJobConfig`,

5988

# the maximum returned is 2000 regardless if this is set higher.

5989

# When set within `InspectContentRequest`, this field is ignored.

5990

"maxFindingsPerInfoType": [ # Configuration of findings limit given for specified infoTypes.

5991

{ # Max findings configuration per infoType, per content item or long

5992

# running DlpJob.

5993

"maxFindings": 42, # Max findings limit for the given infoType.

5994

"infoType": { # Type of information detected by the API. # Type of information the findings limit applies to. Only one limit per

5995

# info_type should be provided. If InfoTypeLimit does not have an

5996

# info_type, the DLP API applies the limit against all info_types that

5997

# are found but not specified in another InfoTypeLimit.

5998

"name": "A String", # Name of the information type. Either a name of your choosing when

5999

# creating a CustomInfoType, or one of the names listed

6000

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

6001

# a built-in type. InfoType names should conform to the pattern

6002

# `[a-zA-Z0-9_]{1,64}`.

},

},

],

"maxFindingsPerRequest": 42, # Max number of findings that will be returned per request/job.

6007

# When set within `InspectContentRequest`, the maximum returned is 2000

6008

# regardless if this is set higher.

6009

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

6010

},

6011

"actions": [ # Actions to execute at the completion of the job.

6012

{ # A task to execute on the completion of a job.

6013

# See https://cloud.google.com/dlp/docs/concepts-actions to learn more.

6014

"publishSummaryToCscc": { # Publish the result summary of a DlpJob to the Cloud Security # Publish summary to Cloud Security Command Center (Alpha).

6015

# Command Center (CSCC Alpha).

6016

# This action is only available for projects which are parts of

6017

# an organization and whitelisted for the alpha Cloud Security Command

6018

# Center.

6019

# The action will publish count of finding instances and their info types.

6020

# The summary of findings will be persisted in CSCC and are governed by CSCC

6021

# service-specific policy, see https://cloud.google.com/terms/service-terms

6022

# Only a single instance of this action can be specified.

6023

# Compatible with: Inspect

6024

},

6025

"jobNotificationEmails": { # Enable email notification to project owners and editors on jobs's # Enable email notification for project owners and editors on job's

6026

# completion/failure.

6027

# completion/failure.

6028

},

6029

"saveFindings": { # If set, the detailed findings will be persisted to the specified # Save resulting findings in a provided location.

6030

# OutputStorageConfig. Only a single instance of this action can be

6031

# specified.

6032

# Compatible with: Inspect, Risk

6033

"outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

6034

"table": { # Message defining the location of a BigQuery table. A table is uniquely # Store findings in an existing table or a new table in an existing

6035

# dataset. If table_id is not set a new one will be generated

6036

# for you with the following format:

6037

# dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific timezone will be used for

6038

# generating the date details.

6039

#

6040

# For Inspect, each column in an existing output table must have the same

6041

# name, type, and mode of a field in the `Finding` object.

6042

#

6043

# For Risk, an existing output table should be the output of a previous

6044

# Risk analysis job run on the same source table, with the same privacy

6045

# metric and quasi-identifiers. Risk jobs that analyze the same table but

6046

# compute a different privacy metric, or use different sets of

6047

# quasi-identifiers, cannot store their results in the same table.

6048

# identified by its project_id, dataset_id, and table_name. Within a query

6049

# a table is often referenced with a string in the format of:

6050

# `<project_id>:<dataset_id>.<table_id>` or

6051

# `<project_id>.<dataset_id>.<table_id>`.

6052

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table.

6053

# If omitted, project ID is inferred from the API call.

6054

"datasetId": "A String", # Dataset ID of the table.

6055

"tableId": "A String", # Name of the table.

6056

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

6057

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only

6058

# used for Inspect and must be unspecified for Risk jobs. Columns are derived

6059

# from the `Finding` object. If appending to an existing table, any columns

6060

# from the predefined schema that are missing will be added. No columns in

6061

# the existing table will be deleted.

6062

#

6063

# If unspecified, then all available columns will be used for a new table or

6064

# an (existing) table with no schema, and no changes will be made to an

6065

# existing table that has a schema.

6066

# Only for use with external storage.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

6067

},

6068

},

6069

"pubSub": { # Publish a message into given Pub/Sub topic when DlpJob has completed. The # Publish a notification to a pubsub topic.

6070

# message contains a single field, `DlpJobName`, which is equal to the

6071

# finished job's

6072

# [`DlpJob.name`](/dlp/docs/reference/rest/v2/projects.dlpJobs#DlpJob).

6073

# Compatible with: Inspect, Risk

6074

"topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given

6075

# publishing access rights to the DLP API service account executing

6076

# the long running DlpJob sending the notifications.

6077

# Format is projects/{project}/topics/{topic}.

6078

},

6079

"publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Cloud Data Catalog. Labels summarizing the # Publish findings to Cloud Datahub.

6080

# results of the DlpJob will be applied to the entry for the resource scanned

6081

# in Cloud Data Catalog. Any labels previously written by another DlpJob will

6082

# be deleted. InfoType naming patterns are strictly enforced when using this

6083

# feature. Note that the findings will be persisted in Cloud Data Catalog

6084

# storage and are governed by Data Catalog service-specific policy, see

6085

# https://cloud.google.com/terms/service-terms

6086

# Only a single instance of this action can be specified and only allowed if

6087

# all resources being scanned are BigQuery tables.

6088

# Compatible with: Inspect

6089

},

6090

"publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This # Enable Stackdriver metric dlp.googleapis.com/finding_count.

6091

# will publish a metric to stack driver on each infotype requested and

6092

# how many findings were found for it. CustomDetectors will be bucketed

6093

# as 'Custom' under the Stackdriver label 'info_type'.

},

},

],

"storageConfig": { # Shared message indicating Cloud storage type. # The data to scan.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

6098

"hybridOptions": { # Configuration to control jobs where the content being inspected is outside # Hybrid inspection options.

6099

# Early access feature is in a pre-release state and might change or have

6100

# limited support. For more information, see

6101

# https://cloud.google.com/products#product-launch-stages.

6102

# of Google Cloud Platform.

6103

"labels": { # To organize findings, these labels will be added to each finding.

6104

#

6105

# Label keys must be between 1 and 63 characters long and must conform

6106

# to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.

6107

#

6108

# Label values must be between 0 and 63 characters long and must conform

6109

# to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.

6110

#

6111

# No more than 10 labels can be associated with a given finding.

6112

#

6113

# Examples:

6114

# * `"environment" : "production"`

6115

# * `"pipeline" : "etl"`

6116

"a_key": "A String",

6117

},

6118

"description": "A String", # A short description of where the data is coming from. Will be stored once

6119

# in the job. 256 max length.

6120

"tableOptions": { # Instructions regarding the table content being inspected. # If the container is a table, additional information to make findings

6121

# meaningful such as the columns that are primary keys.

6122

"identifyingFields": [ # The columns that are the primary keys for table objects included in

6123

# ContentItem. A copy of this cell's value will stored alongside alongside

6124

# each finding so that the finding can be traced to the specific row it came

6125

# from. No more than 3 may be provided.

6126

{ # General identifier of a data field in a storage service.

6127

"name": "A String", # Name describing the field.

},

],

},

"requiredFindingLabelKeys": [ # These are labels that each inspection request must include within their

6132

# 'finding_labels' map. Request may contain others, but any missing one of

6133

# these will be rejected.

6134

#

6135

# Label keys must be between 1 and 63 characters long and must conform

6136

# to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.

6137

#

6138

# No more than 10 keys can be required.

6139

"A String",

6140

],

6141

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

6142

"datastoreOptions": { # Options defining a data set within Google Cloud Datastore. # Google Cloud Datastore options.

6143

"partitionId": { # Datastore partition ID. # A partition ID identifies a grouping of entities. The grouping is always

6144

# by project and namespace, however the namespace ID may be empty.

6145

# A partition ID identifies a grouping of entities. The grouping is always

6146

# by project and namespace, however the namespace ID may be empty.

6147

#

6148

# A partition ID contains several dimensions:

6149

# project ID and namespace ID.

6150

"projectId": "A String", # The ID of the project to which the entities belong.

6151

"namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.

6152

},

6153

"kind": { # A representation of a Datastore kind. # The kind to process.

6154

"name": "A String", # The name of the kind.

6155

},

6156

},

6157

"timespanConfig": { # Configuration of the timespan of the items to include in scanning.

6158

# Currently only supported when inspecting Google Cloud Storage and BigQuery.

6159

"timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items.

6160

# Used for data sources like Datastore and BigQuery.

6161

#

6162

# For BigQuery:

6163

# Required to filter out rows based on the given start and

6164

# end times. If not specified and the table was modified between the given

6165

# start and end times, the entire table will be scanned.

6166

# The valid data types of the timestamp field are: `INTEGER`, `DATE`,

6167

# `TIMESTAMP`, or `DATETIME` BigQuery column.

6168

#

6169

# For Datastore.

6170

# Valid data types of the timestamp field are: `TIMESTAMP`.

6171

# Datastore entity will be scanned if the timestamp property does not

6172

# exist or its value is empty or invalid.

6173

"name": "A String", # Name describing the field.

6174

},

6175

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out

6176

# a valid start_time to avoid scanning files that have not been modified

6177

# since the last time the JobTrigger executed. This will be based on the

6178

# time of the execution of the last run of the JobTrigger.

6179

"endTime": "A String", # Exclude files or rows newer than this value.

6180

# If set to zero, no upper time limit is applied.

6181

"startTime": "A String", # Exclude files or rows older than this value.

6182

},

6183

"cloudStorageOptions": { # Options defining a file or a set of files within a Google Cloud Storage # Google Cloud Storage options.

6184

# bucket.

6185

"bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger

6186

# than this value then the rest of the bytes are omitted. Only one

6187

# of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.

6188

"fileSet": { # Set of files to scan. # The set of one or more files to scan.

6189

"regexFileSet": { # Message representing a set of files in a Cloud Storage bucket. Regular # The regex-filtered set of files to scan. Exactly one of `url` or

6190

# `regex_file_set` must be set.

6191

# expressions are used to allow fine-grained control over which files in the

6192

# bucket to include.

6193

#

6194

# Included files are those that match at least one item in `include_regex` and

6195

# do not match any items in `exclude_regex`. Note that a file that matches

6196

# items from both lists will _not_ be included. For a match to occur, the

6197

# entire file path (i.e., everything in the url after the bucket name) must

6198

# match the regular expression.

6199

#

6200

# For example, given the input `{bucket_name: "mybucket", include_regex:

6201

# ["directory1/.*"], exclude_regex:

6202

# ["directory1/excluded.*"]}`:

6203

#

6204

# * `gs://mybucket/directory1/myfile` will be included

6205

# * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches

6206

# across `/`)

6207

# * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the

6208

# full path doesn't match any items in `include_regex`)

6209

# * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path

6210

# matches an item in `exclude_regex`)

6211

#

6212

# If `include_regex` is left empty, it will match all files by default

6213

# (this is equivalent to setting `include_regex: [".*"]`).

6214

#

6215

# Some other common use cases:

6216

#

6217

# * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all

6218

# files in `mybucket` except for .pdf files

6219

# * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will

6220

# include all files directly under `gs://mybucket/directory/`, without matching

6221

# across `/`

6222

"bucketName": "A String", # The name of a Cloud Storage bucket. Required.

6223

"includeRegex": [ # A list of regular expressions matching file paths to include. All files in

6224

# the bucket that match at least one of these regular expressions will be

6225

# included in the set of files, except for those that also match an item in

6226

# `exclude_regex`. Leaving this field empty will match all files by default

6227

# (this is equivalent to including `.*` in the list).

6228

#

6229

# Regular expressions use RE2

6230

# [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found

6231

# under the google/re2 repository on GitHub.

6232

"A String",

6233

],

6234

"excludeRegex": [ # A list of regular expressions matching file paths to exclude. All files in

6235

# the bucket that match at least one of these regular expressions will be

6236

# excluded from the scan.

6237

#

6238

# Regular expressions use RE2

6239

# [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found

6240

# under the google/re2 repository on GitHub.

"A String",

],

},

"url": "A String", # The Cloud Storage url of the file(s) to scan, in the format

6245

# `gs://<bucket>/<path>`. Trailing wildcard in the path is allowed.

6246

#

6247

# If the url ends in a trailing slash, the bucket or directory represented

6248

# by the url will be scanned non-recursively (content in sub-directories

6249

# will not be scanned). This means that `gs://mybucket/` is equivalent to

6250

# `gs://mybucket/*`, and `gs://mybucket/directory/` is equivalent to

6251

# `gs://mybucket/directory/*`.

6252

#

6253

# Exactly one of `url` or `regex_file_set` must be set.

6254

},

6255

"filesLimitPercent": 42, # Limits the number of files to scan to this percentage of the input FileSet.

6256

# Number of files scanned is rounded down. Must be between 0 and 100,

6257

# inclusively. Both 0 and 100 means no limit. Defaults to 0.

6258

"fileTypes": [ # List of file type groups to include in the scan.

6259

# If empty, all files are scanned and available data format processors

6260

# are applied. In addition, the binary content of the selected files

6261

# is always scanned as well.

6262

# Images are scanned only as binary if the specified region

6263

# does not support image inspection and no file_types were specified.

6264

# Image inspection is restricted to 'global', 'us', 'asia', and 'europe'.

6265

"A String",

6266

],

6267

"sampleMethod": "A String",

6268

"bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The

6269

# number of bytes scanned is rounded down. Must be between 0 and 100,

6270

# inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one

6271

# of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.

6272

},

6273

"bigQueryOptions": { # Options defining BigQuery table and row identifiers. # BigQuery options.

6274

"tableReference": { # Message defining the location of a BigQuery table. A table is uniquely # Complete BigQuery table reference.

6275

# identified by its project_id, dataset_id, and table_name. Within a query

6276

# a table is often referenced with a string in the format of:

6277

# `<project_id>:<dataset_id>.<table_id>` or

6278

# `<project_id>.<dataset_id>.<table_id>`.

6279

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table.

6280

# If omitted, project ID is inferred from the API call.

6281

"datasetId": "A String", # Dataset ID of the table.

6282

"tableId": "A String", # Name of the table.

6283

},

6284

"identifyingFields": [ # Table fields that may uniquely identify a row within the table. When

6285

# `actions.saveFindings.outputConfig.table` is specified, the values of

6286

# columns specified here are available in the output table under

6287

# `location.content_locations.record_location.record_key.id_values`. Nested

6288

# fields such as `person.birthdate.year` are allowed.

6289

{ # General identifier of a data field in a storage service.

6290

"name": "A String", # Name describing the field.

6291

},

6292

],

6293

"rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows

6294

# scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and

6295

# 100 means no limit. Defaults to 0. Only one of rows_limit and

6296

# rows_limit_percent can be specified. Cannot be used in conjunction with

6297

# TimespanConfig.

6298

"rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the

6299

# rest of the rows are omitted. If not set, or if set to 0, all rows will be

6300

# scanned. Only one of rows_limit and rows_limit_percent can be specified.

6301

# Cannot be used in conjunction with TimespanConfig.

6302

"excludedFields": [ # References to fields excluded from scanning. This allows you to skip

6303

# inspection of entire columns which you know have no findings.

6304

{ # General identifier of a data field in a storage service.

6305

"name": "A String", # Name describing the field.

6306

},

6307

],

6308

"sampleMethod": "A String",

6309

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

6310

},

6311

"inspectTemplateName": "A String", # If provided, will be used as the default for all values in InspectConfig.

6312

# `inspect_config` will be merged into the values persisted as part of the

6313

# template.

6314

},

6315

"status": "A String", # Required. A status for this trigger.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

}</pre>

</div>

</body></html>