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

2020-07-22 17:02:09 -0700

[diff] [blame^]

81

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

Bu Sun Kim

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

[diff] [blame]

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

2020-07-22 17:02:09 -0700

[diff] [blame^]

93

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

Bu Sun Kim

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

2020-07-22 17:02:09 -0700

[diff] [blame^]

125

"errors": [ # A stream of errors encountered running the job.

126

{ # Details information about an error encountered during job execution or

127

# the results of an unsuccessful activation of the JobTrigger.

128

"timestamps": [ # The times the error occurred.

129

"A String",

130

],

131

"details": { # The `Status` type defines a logical error model that is suitable for # Detailed error codes and messages.

132

# different programming environments, including REST APIs and RPC APIs. It is

133

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

134

# three pieces of data: error code, error message, and error details.

135

#

136

# You can find out more about this error model and how to work with it in the

137

# [API Design Guide](https://cloud.google.com/apis/design/errors).

138

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

139

"details": [ # A list of messages that carry the error details. There is a common set of

140

# message types for APIs to use.

141

{

142

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

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

[diff] [blame]

143

},

144

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

145

"message": "A String", # A developer-facing error message, which should be in English. Any

146

# user-facing error message should be localized and sent in the

147

# google.rpc.Status.details field, or localized by the client.

},

},

],

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

152

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

153

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

154

"kMapEstimationResult": { # Result of the reidentifiability analysis. Note that these results are an # K-map result

155

# estimation, not exact values.

156

"kMapEstimationHistogram": [ # The intervals [min_anonymity, max_anonymity] do not overlap. If a value

157

# doesn't correspond to any such interval, the associated frequency is

158

# zero. For example, the following records:

159

# {min_anonymity: 1, max_anonymity: 1, frequency: 17}

160

# {min_anonymity: 2, max_anonymity: 3, frequency: 42}

161

# {min_anonymity: 5, max_anonymity: 10, frequency: 99}

162

# mean that there are no record with an estimated anonymity of 4, 5, or

163

# larger than 10.

164

{ # 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

169

# to 3, 4 or 5 people in the overlying population. An important particular

170

# case is when min_anonymity = max_anonymity = 1: the frequency field then

171

# corresponds to the number of uniquely identifiable records.

172

"maxAnonymity": "A String", # Always greater than or equal to min_anonymity.

173

"bucketSize": "A String", # Number of records within these anonymity bounds.

174

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

175

"bucketValues": [ # Sample of quasi-identifier tuple values in this bucket. The total

176

# number of classes returned per bucket is capped at 20.

177

{ # A tuple of values for the quasi-identifier columns.

178

"estimatedAnonymity": "A String", # The estimated anonymity for these quasi-identifier values.

179

"quasiIdsValues": [ # The quasi-identifier values.

180

{ # Set of primitive values supported by the system.

181

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

182

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

183

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

184

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

185

# int64 only holds up to 8 bytes of data.

186

"integerValue": "A String", # integer

187

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

188

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

189

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

190

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

191

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

192

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

193

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

194

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

195

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

196

},

197

"dayOfWeekValue": "A String", # day of week

198

"floatValue": 3.14, # float

199

"stringValue": "A String", # string

200

"timestampValue": "A String", # timestamp

201

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

202

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

203

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

204

#

205

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

206

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

207

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

208

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

209

#

210

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

211

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

212

# month and day.

213

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

214

# a year.

215

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

216

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

217

# significant.

218

},

219

"booleanValue": True or False, # boolean

Bu Sun Kim

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

[diff] [blame]

220

},

221

],

222

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

223

],

224

"minAnonymity": "A String", # Always positive.

Bu Sun Kim

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

[diff] [blame]

225

},

226

],

227

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

228

"deltaPresenceEstimationResult": { # Result of the δ-presence computation. Note that these results are an # Delta-presence result

229

# estimation, not exact values.

230

"deltaPresenceEstimationHistogram": [ # The intervals [min_probability, max_probability) do not overlap. If a

231

# value doesn't correspond to any such interval, the associated frequency

232

# is zero. For example, the following records:

233

# {min_probability: 0, max_probability: 0.1, frequency: 17}

234

# {min_probability: 0.2, max_probability: 0.3, frequency: 42}

235

# {min_probability: 0.3, max_probability: 0.4, frequency: 99}

236

# mean that there are no record with an estimated probability in [0.1, 0.2)

237

# nor larger or equal to 0.4.

238

{ # A DeltaPresenceEstimationHistogramBucket message with the following

239

# values:

240

# min_probability: 0.1

241

# max_probability: 0.2

242

# frequency: 42

243

# means that there are 42 records for which δ is in [0.1, 0.2). An

244

# important particular case is when min_probability = max_probability = 1:

245

# then, every individual who shares this quasi-identifier combination is in

246

# the dataset.

247

"maxProbability": 3.14, # Always greater than or equal to min_probability.

248

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

249

"bucketValues": [ # Sample of quasi-identifier tuple values in this bucket. The total

250

# number of classes returned per bucket is capped at 20.

251

{ # A tuple of values for the quasi-identifier columns.

252

"estimatedProbability": 3.14, # The estimated probability that a given individual sharing these

253

# quasi-identifier values is in the dataset. This value, typically called

254

# δ, is the ratio between the number of records in the dataset with these

255

# quasi-identifier values, and the total number of individuals (inside

256

# *and* outside the dataset) with these quasi-identifier values.

257

# For example, if there are 15 individuals in the dataset who share the

258

# same quasi-identifier values, and an estimated 100 people in the entire

259

# population with these values, then δ is 0.15.

260

"quasiIdsValues": [ # The quasi-identifier values.

261

{ # Set of primitive values supported by the system.

262

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

263

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

264

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

265

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

266

# int64 only holds up to 8 bytes of data.

267

"integerValue": "A String", # integer

268

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

269

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

270

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

271

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

272

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

273

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

274

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

275

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

276

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

277

},

278

"dayOfWeekValue": "A String", # day of week

279

"floatValue": 3.14, # float

280

"stringValue": "A String", # string

281

"timestampValue": "A String", # timestamp

282

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

283

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

284

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

285

#

286

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

287

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

288

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

289

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

290

#

291

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

292

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

293

# month and day.

294

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

295

# a year.

296

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

297

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

298

# significant.

299

},

300

"booleanValue": True or False, # boolean

},

],

},

],

"minProbability": 3.14, # Between 0 and 1.

306

"bucketSize": "A String", # Number of records within these probability bounds.

},

],

},

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

311

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

312

{ # Histogram of value frequencies in the column.

313

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

314

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

315

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

316

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

317

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

318

# values returned per bucket is capped at 20.

319

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

320

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

321

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

322

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

323

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

324

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

325

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

326

# int64 only holds up to 8 bytes of data.

327

"integerValue": "A String", # integer

328

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

329

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

330

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

331

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

332

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

333

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

334

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

335

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

336

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

337

},

338

"dayOfWeekValue": "A String", # day of week

339

"floatValue": 3.14, # float

340

"stringValue": "A String", # string

341

"timestampValue": "A String", # timestamp

342

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

343

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

344

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

345

#

346

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

347

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

348

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

349

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

350

#

351

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

352

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

353

# month and day.

354

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

355

# a year.

356

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

357

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

358

# significant.

359

},

360

"booleanValue": True or False, # boolean

},

},

],

},

],

},

"numericalStatsResult": { # Result of the numerical stats computation. # Numerical stats result

368

"quantileValues": [ # List of 99 values that partition the set of field values into 100 equal

369

# sized buckets.

370

{ # Set of primitive values supported by the system.

371

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

372

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

373

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

374

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

375

# int64 only holds up to 8 bytes of data.

376

"integerValue": "A String", # integer

377

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

378

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

379

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

380

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

381

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

382

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

383

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

384

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

385

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

386

},

387

"dayOfWeekValue": "A String", # day of week

388

"floatValue": 3.14, # float

389

"stringValue": "A String", # string

390

"timestampValue": "A String", # timestamp

391

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

392

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

393

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

394

#

395

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

396

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

397

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

398

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

399

#

400

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

401

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

402

# month and day.

403

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

404

# a year.

405

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

406

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

407

# significant.

408

},

409

"booleanValue": True or False, # boolean

410

},

411

],

412

"minValue": { # Set of primitive values supported by the system. # Minimum value appearing in the column.

413

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

414

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

415

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

416

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

417

# int64 only holds up to 8 bytes of data.

418

"integerValue": "A String", # integer

419

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

420

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

421

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

422

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

423

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

424

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

425

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

426

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

427

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

428

},

429

"dayOfWeekValue": "A String", # day of week

430

"floatValue": 3.14, # float

431

"stringValue": "A String", # string

432

"timestampValue": "A String", # timestamp

433

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

434

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

435

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

436

#

437

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

438

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

439

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

440

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

441

#

442

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

443

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

444

# month and day.

445

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

446

# a year.

447

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

448

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

449

# significant.

450

},

451

"booleanValue": True or False, # boolean

452

},

453

"maxValue": { # Set of primitive values supported by the system. # Maximum value appearing in the column.

454

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

455

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

456

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

457

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

458

# int64 only holds up to 8 bytes of data.

459

"integerValue": "A String", # integer

460

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

461

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

462

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

463

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

464

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

465

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

466

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

467

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

468

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

469

},

470

"dayOfWeekValue": "A String", # day of week

471

"floatValue": 3.14, # float

472

"stringValue": "A String", # string

473

"timestampValue": "A String", # timestamp

474

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

475

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

476

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

477

#

478

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

479

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

480

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

481

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

482

#

483

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

484

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

485

# month and day.

486

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

487

# a year.

488

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

489

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

490

# significant.

491

},

492

"booleanValue": True or False, # boolean

493

},

494

},

495

"kAnonymityResult": { # Result of the k-anonymity computation. # K-anonymity result

496

"equivalenceClassHistogramBuckets": [ # Histogram of k-anonymity equivalence classes.

497

{ # Histogram of k-anonymity equivalence classes.

498

"bucketValues": [ # Sample of equivalence classes in this bucket. The total number of

499

# classes returned per bucket is capped at 20.

500

{ # The set of columns' values that share the same ldiversity value

501

"quasiIdsValues": [ # Set of values defining the equivalence class. One value per

502

# quasi-identifier column in the original KAnonymity metric message.

503

# The order is always the same as the original request.

504

{ # Set of primitive values supported by the system.

505

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

506

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

507

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

508

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

509

# int64 only holds up to 8 bytes of data.

510

"integerValue": "A String", # integer

511

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

512

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

513

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

514

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

515

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

516

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

517

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

518

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

519

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

520

},

521

"dayOfWeekValue": "A String", # day of week

522

"floatValue": 3.14, # float

523

"stringValue": "A String", # string

524

"timestampValue": "A String", # timestamp

525

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

526

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

527

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

528

#

529

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

530

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

531

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

532

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

533

#

534

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

535

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

536

# month and day.

537

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

538

# a year.

539

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

540

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

541

# significant.

542

},

543

"booleanValue": True or False, # boolean

544

},

545

],

546

"equivalenceClassSize": "A String", # Size of the equivalence class, for example number of rows with the

547

# above set of values.

548

},

549

],

550

"equivalenceClassSizeLowerBound": "A String", # Lower bound on the size of the equivalence classes in this bucket.

551

"equivalenceClassSizeUpperBound": "A String", # Upper bound on the size of the equivalence classes in this bucket.

552

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

553

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

554

},

555

],

556

},

Bu Sun Kim

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

[diff] [blame]

557

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

558

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

559

# number of distinct values and value count distribution.

560

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

561

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

562

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

563

# depending on the data.

564

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

565

},

566

},

567

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

568

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

569

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

570

},

571

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

572

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

573

# specified, they are considered a single composite key.

574

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

575

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

},

],

},

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

580

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

581

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

582

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

583

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

584

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

Bu Sun Kim

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

[diff] [blame]

585

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

586

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

587

# US_ZIP_5) or a region code.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

588

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

589

# same tag.

590

{ # A column with a semantic tag attached.

591

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

592

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

593

},

594

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

595

# indicate an auxiliary table that contains statistical information on

596

# the possible values of this column (below).

597

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

598

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

599

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

600

# To programmatically obtain the list of supported InfoTypes, use

601

# ListInfoTypes with the supported_by=RISK_ANALYSIS filter.

602

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

603

# creating a CustomInfoType, or one of the names listed

604

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

605

# a built-in type. When sending Cloud DLP results to Data Catalog, infoType

606

# names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

607

},

608

"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

609

# the distribution of values in the input data

610

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

611

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

612

#

613

# service Foo {

614

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

615

# }

616

#

617

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

618

},

619

},

620

],

Bu Sun Kim

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

[diff] [blame]

621

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

622

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

623

# of one auxiliary table.

624

{ # An auxiliary table contains statistical information on the relative

Bu Sun Kim

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

[diff] [blame]

625

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

626

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

627

# frequency of each quasi-identifier tuple.

628

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

629

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

630

# tuple is highly reidentifiable).

Bu Sun Kim

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

[diff] [blame]

631

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

632

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

633

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

634

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

635

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

636

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

637

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

638

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

639

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

640

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

641

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

642

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

643

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

644

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

645

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

646

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

647

},

648

},

649

],

Bu Sun Kim

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

[diff] [blame]

650

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

651

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

652

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

653

},

654

},

655

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

656

},

657

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

658

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

659

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

660

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

Bu Sun Kim

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

[diff] [blame]

661

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

662

# same tag.

663

{ # A column with a semantic tag attached.

664

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

665

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

666

},

667

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

668

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

669

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

670

# To programmatically obtain the list of supported InfoTypes, use

671

# ListInfoTypes with the supported_by=RISK_ANALYSIS filter.

672

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

673

# creating a CustomInfoType, or one of the names listed

674

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

675

# a built-in type. When sending Cloud DLP results to Data Catalog, infoType

676

# names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

Bu Sun Kim

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

[diff] [blame]

677

},

678

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

679

# indicate an auxiliary table that contains statistical information on

680

# the possible values of this column (below).

681

"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

682

# the distribution of values in the input data

683

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

684

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

685

#

686

# service Foo {

687

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

688

# }

689

#

690

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

691

},

692

},

693

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

694

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

695

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

696

# field of one auxiliary table.

697

{ # An auxiliary table containing statistical information on the relative

698

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

699

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

700

# frequency of each quasi-identifier tuple.

701

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

702

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

703

# tuple is highly reidentifiable).

704

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

705

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

706

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

707

},

708

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

709

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

710

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

711

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

712

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

713

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

714

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

715

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

716

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

717

},

718

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

719

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

720

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

721

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

722

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

723

},

724

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

725

# indicate an auxiliary table that contains statistical information on

726

# the possible values of this column (below).

},

],

},

],

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

732

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

733

# US_ZIP_5) or a region code.

Bu Sun Kim

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

[diff] [blame]

734

},

735

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

Bu Sun Kim

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

[diff] [blame]

736

"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

737

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

738

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

739

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

740

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

741

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

742

#

743

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

744

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

745

# might be ignored.

746

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

747

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

748

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

749

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

750

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

751

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

752

},

753

},

Bu Sun Kim

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

[diff] [blame]

754

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

755

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

756

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

757

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

758

# a repeated field.

759

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

760

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

761

},

762

],

Bu Sun Kim

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

[diff] [blame]

763

},

764

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

765

# min, max, and quantiles.

766

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

767

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

768

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

769

},

770

},

Bu Sun Kim

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

[diff] [blame]

771

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

772

"lDiversityResult": { # Result of the l-diversity computation. # L-divesity result

773

"sensitiveValueFrequencyHistogramBuckets": [ # Histogram of l-diversity equivalence class sensitive value frequencies.

774

{ # Histogram of l-diversity equivalence class sensitive value frequencies.

775

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

Bu Sun Kim

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

[diff] [blame]

776

"bucketValues": [ # Sample of equivalence classes in this bucket. The total number of

777

# classes returned per bucket is capped at 20.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

778

{ # The set of columns' values that share the same ldiversity value.

779

"quasiIdsValues": [ # Quasi-identifier values defining the k-anonymity equivalence

780

# class. The order is always the same as the original request.

Bu Sun Kim

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

[diff] [blame]

781

{ # Set of primitive values supported by the system.

782

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

783

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

784

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

785

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

786

# int64 only holds up to 8 bytes of data.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

787

"integerValue": "A String", # integer

788

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

789

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

790

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

791

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

792

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

793

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

794

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

795

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

796

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

797

},

798

"dayOfWeekValue": "A String", # day of week

799

"floatValue": 3.14, # float

800

"stringValue": "A String", # string

Bu Sun Kim

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

[diff] [blame]

801

"timestampValue": "A String", # timestamp

802

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

803

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

804

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

805

#

806

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

807

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

808

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

809

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

810

#

811

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

Bu Sun Kim

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

[diff] [blame]

812

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

813

# month and day.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

814

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

815

# a year.

Bu Sun Kim

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

[diff] [blame]

816

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

817

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

818

# significant.

819

},

Bu Sun Kim

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

[diff] [blame]

820

"booleanValue": True or False, # boolean

Bu Sun Kim

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

[diff] [blame]

821

},

822

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

823

"topSensitiveValues": [ # Estimated frequencies of top sensitive values.

824

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

825

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

826

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

827

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

828

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

829

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

830

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

831

# int64 only holds up to 8 bytes of data.

832

"integerValue": "A String", # integer

833

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

834

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

835

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

836

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

837

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

838

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

839

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

840

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

841

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

842

},

843

"dayOfWeekValue": "A String", # day of week

844

"floatValue": 3.14, # float

845

"stringValue": "A String", # string

846

"timestampValue": "A String", # timestamp

847

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

848

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

849

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

850

#

851

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

852

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

853

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

854

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

855

#

856

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

857

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

858

# month and day.

859

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

860

# a year.

861

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

862

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

863

# significant.

864

},

865

"booleanValue": True or False, # boolean

},

},

],

"equivalenceClassSize": "A String", # Size of the k-anonymity equivalence class.

870

"numDistinctSensitiveValues": "A String", # Number of distinct sensitive values in this equivalence class.

Bu Sun Kim

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

[diff] [blame]

871

},

872

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

873

"sensitiveValueFrequencyUpperBound": "A String", # Upper bound on the sensitive value frequencies of the equivalence

874

# classes in this bucket.

Bu Sun Kim

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

[diff] [blame]

875

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

876

"sensitiveValueFrequencyLowerBound": "A String", # Lower bound on the sensitive value frequencies of the equivalence

877

# classes in this bucket.

Bu Sun Kim

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.

882

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

883

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

884

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

885

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

886

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

887

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

888

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

889

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

890

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

891

},

892

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

893

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

894

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

895

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

896

# instantiated the job.

897

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

898

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

899

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

900

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

901

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

902

# template.

903

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

904

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

905

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

906

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

907

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

908

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

909

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

910

},

911

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

912

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

913

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

914

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

915

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

916

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

917

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

918

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

919

# all resources being scanned are BigQuery tables.

920

# Compatible with: Inspect

921

},

922

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

923

# completion/failure.

924

# completion/failure.

925

},

926

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

927

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

928

# finished job's

929

# [`DlpJob.name`](https://cloud.google.com/dlp/docs/reference/rest/v2/projects.dlpJobs#DlpJob).

930

# Compatible with: Inspect, Risk

931

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

932

# publishing access rights to the DLP API service account executing

933

# the long running DlpJob sending the notifications.

934

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

935

},

936

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

937

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

938

# specified.

939

# Compatible with: Inspect, Risk

940

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

941

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

942

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

943

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

944

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

945

# the existing table will be deleted.

946

#

947

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

948

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

949

# existing table that has a schema.

950

# Only for use with external storage.

951

"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

952

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

953

# for you with the following format:

954

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

955

# generating the date details.

956

#

957

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

958

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

959

#

960

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

961

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

962

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

963

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

964

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

965

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

966

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

967

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

968

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

969

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

970

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

971

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

972

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

},

},

},

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

977

# Command Center (CSCC Alpha).

978

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

979

# an organization and whitelisted for the alpha Cloud Security Command

980

# Center.

981

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

982

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

983

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

984

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

985

# Compatible with: Inspect

986

},

Bu Sun Kim

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

[diff] [blame]

987

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

988

],

989

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

990

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

991

# bucket.

992

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

993

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

994

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

995

# of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.

996

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

997

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

998

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

999

# is always scanned as well.

1000

# Images are scanned only as binary if the specified region

1001

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

1002

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

1003

"A String",

1004

],

1005

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

1006

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

1007

# of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.

1008

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

1009

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

1010

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

1011

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

1012

"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

1013

# `regex_file_set` must be set.

1014

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

1015

# bucket to include.

1016

#

1017

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

1018

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

1019

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

1020

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

1021

# match the regular expression.

1022

#

1023

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

1024

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

1025

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

1026

#

1027

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

1028

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

1029

# across `/`)

1030

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

1031

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

1032

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

1033

# matches an item in `exclude_regex`)

1034

#

1035

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

1036

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

1037

#

1038

# Some other common use cases:

1039

#

1040

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

1041

# files in `mybucket` except for .pdf files

1042

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

1043

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

1044

# across `/`

1045

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

1046

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

1047

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

1048

# excluded from the scan.

1049

#

1050

# Regular expressions use RE2

1051

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

1052

# under the google/re2 repository on GitHub.

1053

"A String",

1054

],

1055

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

1056

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

1057

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

1058

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

1059

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

1060

#

1061

# Regular expressions use RE2

1062

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

1063

# 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

1068

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

1069

#

1070

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

1071

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

1072

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

1073

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

1074

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

1075

#

1076

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

1077

},

1078

"sampleMethod": "A String",

Bu Sun Kim

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

[diff] [blame]

1079

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1080

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

1081

"sampleMethod": "A String",

1082

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

1083

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

1084

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

1085

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

1086

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

1087

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

1088

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

1089

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

1090

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

1091

},

1092

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

1093

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

1094

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

1095

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

1096

# TimespanConfig.

1097

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

1098

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

1099

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

1100

# Cannot be used in conjunction with TimespanConfig.

1101

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

1102

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

1103

# columns specified here are available in the output table under

1104

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

1105

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

1106

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

1107

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

1108

},

1109

],

1110

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

1111

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

1112

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

1113

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

},

],

},

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

1118

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

1119

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

1120

# Used for data sources like Datastore and BigQuery.

1121

#

1122

# For BigQuery:

1123

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

1124

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

1125

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

1126

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

1127

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

1128

#

1129

# For Datastore.

1130

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

1131

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

1132

# exist or its value is empty or invalid.

1133

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

1134

},

1135

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

1136

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

1137

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

1138

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

1139

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

1140

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

1141

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

1142

},

1143

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

1144

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

1145

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

1146

},

1147

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

1148

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

1149

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

1150

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

1151

#

1152

# A partition ID contains several dimensions:

1153

# project ID and namespace ID.

1154

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

1155

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

1156

},

1157

},

1158

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

1159

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

1160

# limited support. For more information, see

1161

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

1162

# of Google Cloud Platform.

1163

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

1164

# meaningful such as the columns that are primary keys.

1165

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

1166

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

1167

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

1168

# from. No more than 3 may be provided.

1169

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

1170

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

},

],

},

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

1175

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

1176

# these will be rejected.

1177

#

1178

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

1179

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

1180

#

1181

# No more than 10 keys can be required.

1182

"A String",

1183

],

1184

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

1185

#

1186

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

1187

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

1188

#

1189

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

1190

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

1191

#

1192

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

1193

#

1194

# Examples:

1195

# * `"environment" : "production"`

1196

# * `"pipeline" : "etl"`

1197

"a_key": "A String",

1198

},

1199

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

1200

# in the job. 256 max length.

1201

},

Bu Sun Kim

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

[diff] [blame]

1202

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1203

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

1204

# When used with redactContent only info_types and min_likelihood are currently

1205

# used.

1206

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

1207

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

1208

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

1209

# sensitive information configurable to the data in question.

1210

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

1211

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

1212

# of employee IDs or job titles.

1213

#

1214

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

1215

# and digits in the unicode [Basic Multilingual

1216

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

1217

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

1218

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

1219

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

1220

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

1221

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

1222

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

1223

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

1224

# matches for "jennifer".

1225

#

1226

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

1227

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

1228

# are treated as whitespace. The

1229

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

1230

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

1231

# these constraints, consider using `LargeCustomDictionaryConfig` in the

1232

# `StoredInfoType` API.

1233

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

1234

# is accepted.

1235

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

1236

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

1237

},

1238

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

1239

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

1240

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

1241

# that are letters or digits. [required]

"A String",

],

},

},

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

1247

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

1248

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

1249

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

1250

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

1251

# as a custom info type.

1252

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

1253

# creating a CustomInfoType, or one of the names listed

1254

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

1255

# a built-in type. When sending Cloud DLP results to Data Catalog, infoType

1256

# names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

1257

},

1258

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

1259

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

1260

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

1261

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

1262

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

1263

# `surrogate_type` CustomInfoType.

1264

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

1265

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

1266

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

1267

# custom infoType.

1268

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

1269

# proximity of hotwords.

1270

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

1271

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

1272

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

1273

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

1274

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

1275

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

1276

# a company office using the hotword regex "$xxx$", where "xxx"

1277

# is the area code in question.

1278

# rule.

1279

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

1280

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

Bu Sun Kim

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

[diff] [blame]

1281

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1282

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

1283

# part of a detection rule.

1284

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

1285

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

1286

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

1287

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

1288

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

1289

# Likelihood may never drop below `VERY_UNLIKELY` or exceed

1290

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

1291

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

1292

# a final likelihood of `LIKELY`.

Bu Sun Kim

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

[diff] [blame]

1293

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1294

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

1295

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

1296

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

1297

42,

1298

],

1299

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

1300

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

1301

# google/re2 repository on GitHub.

1302

},

Bu Sun Kim

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

[diff] [blame]

1303

},

1304

},

1305

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1306

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

1307

# support reversing.

1308

# such as

1309

# [`CryptoReplaceFfxFpeConfig`](https://cloud.google.com/dlp/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig).

1310

# These types of transformations are

1311

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

1312

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

1313

# transformation such as `surrogate_info_type`. This CustomInfoType does

1314

# not support the use of `detection_rules`.

1315

},

1316

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

1317

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

1318

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

1319

42,

1320

],

1321

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

1322

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

1323

# google/re2 repository on GitHub.

1324

},

1325

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

1326

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

1327

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

1328

# `organizations/433245324/storedInfoTypes/432452342` or

1329

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

1330

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

1331

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

1332

},

1333

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

1334

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

Bu Sun Kim

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

[diff] [blame]

1335

},

1336

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1337

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

1338

# POSSIBLE.

1339

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

1340

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

1341

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

1342

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

1343

# regardless if this is set higher.

1344

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

1345

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

1346

# running DlpJob.

1347

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

1348

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

1349

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

1350

# are found but not specified in another InfoTypeLimit.

1351

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

1352

# creating a CustomInfoType, or one of the names listed

1353

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

1354

# a built-in type. When sending Cloud DLP results to Data Catalog, infoType

1355

# names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

1356

},

1357

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

1358

},

1359

],

1360

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

1361

# When set within `InspectJobConfig`,

1362

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

1363

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

1364

},

1365

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

1366

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

1367

# included in the response; see Finding.quote.

1368

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

1369

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

1370

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

1371

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

1372

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

1373

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

1374

{ # Type of information detected by the API.

1375

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

1376

# creating a CustomInfoType, or one of the names listed

1377

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

1378

# a built-in type. When sending Cloud DLP results to Data Catalog, infoType

1379

# names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

1380

},

1381

],

1382

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

1383

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

1384

# `InspectionRuleSet`.

1385

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

1386

# proximity of hotwords.

1387

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

1388

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

1389

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

1390

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

1391

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

1392

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

1393

# a company office using the hotword regex "$xxx$", where "xxx"

1394

# is the area code in question.

1395

# rule.

1396

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

1397

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

1398

},

1399

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

1400

# part of a detection rule.

1401

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

1402

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

1403

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

1404

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

1405

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

1406

# Likelihood may never drop below `VERY_UNLIKELY` or exceed

1407

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

1408

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

1409

# a final likelihood of `LIKELY`.

1410

},

1411

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

1412

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

1413

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

1414

42,

1415

],

1416

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

1417

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

1418

# google/re2 repository on GitHub.

1419

},

1420

},

1421

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

1422

# `InspectionRuleSet` are removed from results.

1423

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

1424

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

1425

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

1426

# of employee IDs or job titles.

1427

#

1428

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

1429

# and digits in the unicode [Basic Multilingual

1430

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

1431

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

1432

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

1433

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

1434

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

1435

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

1436

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

1437

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

1438

# matches for "jennifer".

1439

#

1440

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

1441

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

1442

# are treated as whitespace. The

1443

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

1444

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

1445

# these constraints, consider using `LargeCustomDictionaryConfig` in the

1446

# `StoredInfoType` API.

1447

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

1448

# is accepted.

1449

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

1450

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

1451

},

1452

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

1453

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

1454

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

1455

# that are letters or digits. [required]

"A String",

],

},

},

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

1461

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

1462

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

1463

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

1464

# `exclusion_rule` containing `exclude_info_types.info_types` with

1465

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

1466

# with EMAIL_ADDRESS finding.

1467

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

1468

# finding, namely email address.

1469

{ # Type of information detected by the API.

1470

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

1471

# creating a CustomInfoType, or one of the names listed

1472

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

1473

# a built-in type. When sending Cloud DLP results to Data Catalog, infoType

1474

# names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

},

],

},

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

1479

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

1480

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

1481

42,

1482

],

1483

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

1484

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

1485

# google/re2 repository on GitHub.

},

},

},

],

},

],

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

1493

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

1494

"A String",

1495

],

1496

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

1497

# InfoType values returned by ListInfoTypes or listed at

1498

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

1499

#

1500

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

1501

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

1502

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

1503

#

1504

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

1505

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

1506

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

1507

{ # Type of information detected by the API.

1508

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

1509

# creating a CustomInfoType, or one of the names listed

1510

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

1511

# a built-in type. When sending Cloud DLP results to Data Catalog, infoType

1512

# names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

},

],

},

},

"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

1518

# this run.

1519

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

1520

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

1521

# to learn more.

1522

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

1523

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

1524

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

1525

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

1526

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

1527

#

1528

# The template will have one of the following formats:

1529

# `projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID` OR

1530

# `organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID`;

1531

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

1532

# When used with redactContent only info_types and min_likelihood are currently

1533

# used.

1534

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

1535

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

1536

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

1537

# sensitive information configurable to the data in question.

1538

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

1539

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

1540

# of employee IDs or job titles.

1541

#

1542

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

1543

# and digits in the unicode [Basic Multilingual

1544

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

1545

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

1546

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

1547

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

1548

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

1549

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

1550

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

1551

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

1552

# matches for "jennifer".

1553

#

1554

# Dictionary words containing a large number of characters that are not

1555

# letters or digits may result in unexpected findings because such characters

1556

# are treated as whitespace. The

1557

# [limits](https://cloud.google.com/dlp/limits) page contains details about

1558

# the size limits of dictionaries. For dictionaries that do not fit within

1559

# these constraints, consider using `LargeCustomDictionaryConfig` in the

1560

# `StoredInfoType` API.

1561

"cloudStoragePath": { # Message representing a single file or path in Cloud Storage. # Newline-delimited file of words in Cloud Storage. Only a single file

1562

# is accepted.

1563

"path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage.

1564

# Example: gs://[BUCKET_NAME]/dictionary.txt

1565

},

1566

"wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for.

1567

"words": [ # Words or phrases defining the dictionary. The dictionary must contain

1568

# at least one phrase and every phrase must contain at least 2 characters

1569

# that are letters or digits. [required]

"A String",

],

},

},

"infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in

1575

# infoType, when the name matches one of existing infoTypes and that infoType

1576

# is specified in `InspectContent.info_types` field. Specifying the latter

1577

# adds findings to the one detected by the system. If built-in info type is

1578

# not specified in `InspectContent.info_types` list then the name is treated

1579

# as a custom info type.

1580

"name": "A String", # Name of the information type. Either a name of your choosing when

1581

# creating a CustomInfoType, or one of the names listed

1582

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

1583

# a built-in type. When sending Cloud DLP results to Data Catalog, infoType

1584

# names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

1585

},

1586

"likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be

1587

# altered by a detection rule if the finding meets the criteria specified by

1588

# the rule. Defaults to `VERY_LIKELY` if not specified.

1589

"detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType.

1590

# Rules are applied in order that they are specified. Not supported for the

1591

# `surrogate_type` CustomInfoType.

1592

{ # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a

1593

# `CustomInfoType` to alter behavior under certain circumstances, depending

1594

# on the specific details of the rule. Not supported for the `surrogate_type`

1595

# custom infoType.

1596

"hotwordRule": { # The rule that adjusts the likelihood of findings within a certain # Hotword-based detection rule.

1597

# proximity of hotwords.

1598

"proximity": { # Message for specifying a window around a finding to apply a detection # Proximity of the finding within which the entire hotword must reside.

1599

# The total length of the window cannot exceed 1000 characters. Note that

1600

# the finding itself will be included in the window, so that hotwords may

1601

# be used to match substrings of the finding itself. For example, the

1602

# certainty of a phone number regex "$\d{3}$ \d{3}-\d{4}" could be

1603

# adjusted upwards if the area code is known to be the local area code of

1604

# a company office using the hotword regex "$xxx$", where "xxx"

1605

# is the area code in question.

1606

# rule.

1607

"windowAfter": 42, # Number of characters after the finding to consider.

1608

"windowBefore": 42, # Number of characters before the finding to consider.

1609

},

1610

"likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as # Likelihood adjustment to apply to all matching findings.

1611

# part of a detection rule.

1612

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value.

1613

"relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of

1614

# levels. For example, if a finding would be `POSSIBLE` without the

1615

# detection rule and `relative_likelihood` is 1, then it is upgraded to

1616

# `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`.

1617

# Likelihood may never drop below `VERY_UNLIKELY` or exceed

1618

# `VERY_LIKELY`, so applying an adjustment of 1 followed by an

1619

# adjustment of -1 when base likelihood is `VERY_LIKELY` will result in

1620

# a final likelihood of `LIKELY`.

1621

},

1622

"hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword.

1623

"groupIndexes": [ # The index of the submatch to extract as findings. When not

1624

# specified, the entire match is returned. No more than 3 may be included.

1625

42,

1626

],

1627

"pattern": "A String", # Pattern defining the regular expression. Its syntax

1628

# (https://github.com/google/re2/wiki/Syntax) can be found under the

1629

# google/re2 repository on GitHub.

},

},

},

],

"surrogateType": { # Message for detecting output from deidentification transformations # Message for detecting output from deidentification transformations that

1635

# support reversing.

1636

# such as

1637

# [`CryptoReplaceFfxFpeConfig`](https://cloud.google.com/dlp/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig).

1638

# These types of transformations are

1639

# those that perform pseudonymization, thereby producing a "surrogate" as

1640

# output. This should be used in conjunction with a field on the

1641

# transformation such as `surrogate_info_type`. This CustomInfoType does

1642

# not support the use of `detection_rules`.

1643

},

1644

"regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType.

1645

"groupIndexes": [ # The index of the submatch to extract as findings. When not

1646

# specified, the entire match is returned. No more than 3 may be included.

1647

42,

1648

],

1649

"pattern": "A String", # Pattern defining the regular expression. Its syntax

1650

# (https://github.com/google/re2/wiki/Syntax) can be found under the

1651

# google/re2 repository on GitHub.

1652

},

1653

"storedType": { # A reference to a StoredInfoType to use with scanning. # Load an existing `StoredInfoType` resource for use in

1654

# `InspectDataSource`. Not currently supported in `InspectContent`.

1655

"name": "A String", # Resource name of the requested `StoredInfoType`, for example

1656

# `organizations/433245324/storedInfoTypes/432452342` or

1657

# `projects/project-id/storedInfoTypes/432452342`.

1658

"createTime": "A String", # Timestamp indicating when the version of the `StoredInfoType` used for

1659

# inspection was created. Output-only field, populated by the system.

1660

},

1661

"exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding

1662

# to be returned. It still can be used for rules matching.

1663

},

1664

],

1665

"minLikelihood": "A String", # Only returns findings equal or above this threshold. The default is

1666

# POSSIBLE.

1667

# See https://cloud.google.com/dlp/docs/likelihood to learn more.

1668

"limits": { # Configuration to control the number of findings returned. # Configuration to control the number of findings returned.

1669

"maxFindingsPerRequest": 42, # Max number of findings that will be returned per request/job.

1670

# When set within `InspectContentRequest`, the maximum returned is 2000

1671

# regardless if this is set higher.

1672

"maxFindingsPerInfoType": [ # Configuration of findings limit given for specified infoTypes.

1673

{ # Max findings configuration per infoType, per content item or long

1674

# running DlpJob.

1675

"infoType": { # Type of information detected by the API. # Type of information the findings limit applies to. Only one limit per

1676

# info_type should be provided. If InfoTypeLimit does not have an

1677

# info_type, the DLP API applies the limit against all info_types that

1678

# are found but not specified in another InfoTypeLimit.

1679

"name": "A String", # Name of the information type. Either a name of your choosing when

1680

# creating a CustomInfoType, or one of the names listed

1681

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

1682

# a built-in type. When sending Cloud DLP results to Data Catalog, infoType

1683

# names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

1684

},

1685

"maxFindings": 42, # Max findings limit for the given infoType.

1686

},

1687

],

1688

"maxFindingsPerItem": 42, # Max number of findings that will be returned for each item scanned.

1689

# When set within `InspectJobConfig`,

1690

# the maximum returned is 2000 regardless if this is set higher.

1691

# When set within `InspectContentRequest`, this field is ignored.

1692

},

1693

"excludeInfoTypes": True or False, # When true, excludes type information of the findings.

1694

"includeQuote": True or False, # When true, a contextual quote from the data that triggered a finding is

1695

# included in the response; see Finding.quote.

1696

"ruleSet": [ # Set of rules to apply to the findings for this InspectConfig.

1697

# Exclusion rules, contained in the set are executed in the end, other

1698

# rules are executed in the order they are specified for each info type.

1699

{ # Rule set for modifying a set of infoTypes to alter behavior under certain

1700

# circumstances, depending on the specific details of the rules within the set.

1701

"infoTypes": [ # List of infoTypes this rule set is applied to.

1702

{ # Type of information detected by the API.

1703

"name": "A String", # Name of the information type. Either a name of your choosing when

1704

# creating a CustomInfoType, or one of the names listed

1705

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

1706

# a built-in type. When sending Cloud DLP results to Data Catalog, infoType

1707

# names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

1708

},

1709

],

1710

"rules": [ # Set of rules to be applied to infoTypes. The rules are applied in order.

1711

{ # A single inspection rule to be applied to infoTypes, specified in

1712

# `InspectionRuleSet`.

1713

"hotwordRule": { # The rule that adjusts the likelihood of findings within a certain # Hotword-based detection rule.

1714

# proximity of hotwords.

1715

"proximity": { # Message for specifying a window around a finding to apply a detection # Proximity of the finding within which the entire hotword must reside.

1716

# The total length of the window cannot exceed 1000 characters. Note that

1717

# the finding itself will be included in the window, so that hotwords may

1718

# be used to match substrings of the finding itself. For example, the

1719

# certainty of a phone number regex "$\d{3}$ \d{3}-\d{4}" could be

1720

# adjusted upwards if the area code is known to be the local area code of

1721

# a company office using the hotword regex "$xxx$", where "xxx"

1722

# is the area code in question.

1723

# rule.

1724

"windowAfter": 42, # Number of characters after the finding to consider.

1725

"windowBefore": 42, # Number of characters before the finding to consider.

1726

},

1727

"likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as # Likelihood adjustment to apply to all matching findings.

1728

# part of a detection rule.

1729

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value.

1730

"relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of

1731

# levels. For example, if a finding would be `POSSIBLE` without the

1732

# detection rule and `relative_likelihood` is 1, then it is upgraded to

1733

# `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`.

1734

# Likelihood may never drop below `VERY_UNLIKELY` or exceed

1735

# `VERY_LIKELY`, so applying an adjustment of 1 followed by an

1736

# adjustment of -1 when base likelihood is `VERY_LIKELY` will result in

1737

# a final likelihood of `LIKELY`.

1738

},

1739

"hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword.

1740

"groupIndexes": [ # The index of the submatch to extract as findings. When not

1741

# specified, the entire match is returned. No more than 3 may be included.

1742

42,

1743

],

1744

"pattern": "A String", # Pattern defining the regular expression. Its syntax

1745

# (https://github.com/google/re2/wiki/Syntax) can be found under the

1746

# google/re2 repository on GitHub.

1747

},

1748

},

1749

"exclusionRule": { # The rule that specifies conditions when findings of infoTypes specified in # Exclusion rule.

1750

# `InspectionRuleSet` are removed from results.

1751

"matchingType": "A String", # How the rule is applied, see MatchingType documentation for details.

1752

"dictionary": { # Custom information type based on a dictionary of words or phrases. This can # Dictionary which defines the rule.

1753

# be used to match sensitive information specific to the data, such as a list

1754

# of employee IDs or job titles.

1755

#

1756

# Dictionary words are case-insensitive and all characters other than letters

1757

# and digits in the unicode [Basic Multilingual

1758

# Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane)

1759

# will be replaced with whitespace when scanning for matches, so the

1760

# dictionary phrase "Sam Johnson" will match all three phrases "sam johnson",

1761

# "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters

1762

# surrounding any match must be of a different type than the adjacent

1763

# characters within the word, so letters must be next to non-letters and

1764

# digits next to non-digits. For example, the dictionary word "jen" will

1765

# match the first three letters of the text "jen123" but will return no

1766

# matches for "jennifer".

1767

#

1768

# Dictionary words containing a large number of characters that are not

1769

# letters or digits may result in unexpected findings because such characters

1770

# are treated as whitespace. The

1771

# [limits](https://cloud.google.com/dlp/limits) page contains details about

1772

# the size limits of dictionaries. For dictionaries that do not fit within

1773

# these constraints, consider using `LargeCustomDictionaryConfig` in the

1774

# `StoredInfoType` API.

1775

"cloudStoragePath": { # Message representing a single file or path in Cloud Storage. # Newline-delimited file of words in Cloud Storage. Only a single file

1776

# is accepted.

1777

"path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage.

1778

# Example: gs://[BUCKET_NAME]/dictionary.txt

1779

},

1780

"wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for.

1781

"words": [ # Words or phrases defining the dictionary. The dictionary must contain

1782

# at least one phrase and every phrase must contain at least 2 characters

1783

# that are letters or digits. [required]

"A String",

],

},

},

"excludeInfoTypes": { # List of exclude infoTypes. # Set of infoTypes for which findings would affect this rule.

1789

"infoTypes": [ # InfoType list in ExclusionRule rule drops a finding when it overlaps or

1790

# contained within with a finding of an infoType from this list. For

1791

# example, for `InspectionRuleSet.info_types` containing "PHONE_NUMBER"` and

1792

# `exclusion_rule` containing `exclude_info_types.info_types` with

1793

# "EMAIL_ADDRESS" the phone number findings are dropped if they overlap

1794

# with EMAIL_ADDRESS finding.

1795

# That leads to "555-222-2222@example.org" to generate only a single

1796

# finding, namely email address.

1797

{ # Type of information detected by the API.

1798

"name": "A String", # Name of the information type. Either a name of your choosing when

1799

# creating a CustomInfoType, or one of the names listed

1800

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

1801

# a built-in type. When sending Cloud DLP results to Data Catalog, infoType

1802

# names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

},

],

},

"regex": { # Message defining a custom regular expression. # Regular expression which defines the rule.

1807

"groupIndexes": [ # The index of the submatch to extract as findings. When not

1808

# specified, the entire match is returned. No more than 3 may be included.

1809

42,

1810

],

1811

"pattern": "A String", # Pattern defining the regular expression. Its syntax

1812

# (https://github.com/google/re2/wiki/Syntax) can be found under the

1813

# google/re2 repository on GitHub.

},

},

},

],

},

],

"contentOptions": [ # List of options defining data content to scan.

1821

# If empty, text, images, and other content will be included.

1822

"A String",

1823

],

1824

"infoTypes": [ # Restricts what info_types to look for. The values must correspond to

1825

# InfoType values returned by ListInfoTypes or listed at

1826

# https://cloud.google.com/dlp/docs/infotypes-reference.

1827

#

1828

# When no InfoTypes or CustomInfoTypes are specified in a request, the

1829

# system may automatically choose what detectors to run. By default this may

1830

# be all types, but may change over time as detectors are updated.

1831

#

1832

# If you need precise control and predictability as to what detectors are

1833

# run you should specify specific InfoTypes listed in the reference,

1834

# otherwise a default list will be used, which may change over time.

1835

{ # Type of information detected by the API.

1836

"name": "A String", # Name of the information type. Either a name of your choosing when

1837

# creating a CustomInfoType, or one of the names listed

1838

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

1839

# a built-in type. When sending Cloud DLP results to Data Catalog, infoType

1840

# names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

},

],

},

},

},

"result": { # All result fields mentioned below are updated while the job is processing. # A summary of the outcome of this inspect job.

1847

"hybridStats": { # Statistics related to processing hybrid inspect requests. # Statistics related to the processing of hybrid inspect.

1848

# Early access feature is in a pre-release state and might change or have

1849

# limited support. For more information, see

1850

# https://cloud.google.com/products#product-launch-stages.

1851

"processedCount": "A String", # The number of hybrid inspection requests processed within this job.

1852

"abortedCount": "A String", # The number of hybrid inspection requests aborted because the job ran

1853

# out of quota or was ended before they could be processed.

1854

"pendingCount": "A String", # The number of hybrid requests currently being processed. Only populated

1855

# when called via method `getDlpJob`.

1856

# A burst of traffic may cause hybrid inspect requests to be enqueued.

1857

# Processing will take place as quickly as possible, but resource limitations

1858

# may impact how long a request is enqueued for.

1859

},

1860

"totalEstimatedBytes": "A String", # Estimate of the number of bytes to process.

1861

"infoTypeStats": [ # Statistics of how many instances of each info type were found during

1862

# inspect job.

1863

{ # Statistics regarding a specific InfoType.

1864

"infoType": { # Type of information detected by the API. # The type of finding this stat is for.

1865

"name": "A String", # Name of the information type. Either a name of your choosing when

1866

# creating a CustomInfoType, or one of the names listed

1867

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

1868

# a built-in type. When sending Cloud DLP results to Data Catalog, infoType

1869

# names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

1870

},

1871

"count": "A String", # Number of findings for this infoType.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1872

},

1873

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1874

"processedBytes": "A String", # Total size in bytes that were processed.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1875

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1876

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1877

"name": "A String", # The server-assigned name.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1882

<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

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:

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1888

parent: string, Required. Parent resource name.

1889

- Format:projects/[PROJECT-ID]

1890

- Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1891

body: object, The request body.

1892

The object takes the form of:

1893

1894

{ # Request message for CreateJobTrigger.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1895

"locationId": "A String", # Deprecated. This field has no effect.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1896

"jobTrigger": { # Contains a configuration to make dlp api calls on a repeating basis. # Required. The JobTrigger to create.

1897

# See https://cloud.google.com/dlp/docs/concepts-job-triggers to learn more.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1898

"status": "A String", # Required. A status for this trigger.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1899

"triggers": [ # A list of triggers which will be OR'ed together. Only one in the list

1900

# needs to trigger for a job to be started. The list may contain only

1901

# a single Schedule trigger and must have at least one object.

1902

{ # What event needs to occur for a new job to be started.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1903

"manual": { # Job trigger option for hybrid jobs. Jobs must be manually created # For use with hybrid jobs. Jobs must be manually created and finished.

1904

# Early access feature is in a pre-release state and might change or have

1905

# limited support. For more information, see

1906

# https://cloud.google.com/products#product-launch-stages.

1907

# and finished.

1908

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1909

"schedule": { # Schedule for triggeredJobs. # Create a job on a repeating basis based on the elapse of time.

1910

"recurrencePeriodDuration": "A String", # With this option a job is started a regular periodic basis. For

1911

# example: every day (86400 seconds).

1912

#

1913

# A scheduled start time will be skipped if the previous

1914

# execution has not ended when its scheduled time occurs.

1915

#

1916

# This value must be set to a time duration greater than or equal

1917

# to 1 day and can be no longer than 60 days.

1918

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1919

},

1920

],

1921

"errors": [ # Output only. A stream of errors encountered when the trigger was activated. Repeated

1922

# errors may result in the JobTrigger automatically being paused.

1923

# Will return the last 100 errors. Whenever the JobTrigger is modified

1924

# this list will be cleared.

1925

{ # Details information about an error encountered during job execution or

1926

# the results of an unsuccessful activation of the JobTrigger.

1927

"timestamps": [ # The times the error occurred.

1928

"A String",

1929

],

1930

"details": { # The `Status` type defines a logical error model that is suitable for # Detailed error codes and messages.

1931

# different programming environments, including REST APIs and RPC APIs. It is

1932

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

1933

# three pieces of data: error code, error message, and error details.

1934

#

1935

# You can find out more about this error model and how to work with it in the

1936

# [API Design Guide](https://cloud.google.com/apis/design/errors).

1937

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

1938

"details": [ # A list of messages that carry the error details. There is a common set of

1939

# message types for APIs to use.

1940

{

1941

"a_key": "", # Properties of the object. Contains field @type with type URL.

1942

},

1943

],

1944

"message": "A String", # A developer-facing error message, which should be in English. Any

1945

# user-facing error message should be localized and sent in the

1946

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1947

},

1948

},

1949

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1950

"updateTime": "A String", # Output only. The last update timestamp of a triggeredJob.

1951

"inspectJob": { # Controls what and how to inspect for findings. # For inspect jobs, a snapshot of the configuration.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1952

"inspectTemplateName": "A String", # If provided, will be used as the default for all values in InspectConfig.

1953

# `inspect_config` will be merged into the values persisted as part of the

1954

# template.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1955

"actions": [ # Actions to execute at the completion of the job.

1956

{ # A task to execute on the completion of a job.

1957

# See https://cloud.google.com/dlp/docs/concepts-actions to learn more.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1958

"publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This # Enable Stackdriver metric dlp.googleapis.com/finding_count.

1959

# will publish a metric to stack driver on each infotype requested and

1960

# how many findings were found for it. CustomDetectors will be bucketed

1961

# as 'Custom' under the Stackdriver label 'info_type'.

1962

},

1963

"publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Cloud Data Catalog. Labels summarizing the # Publish findings to Cloud Datahub.

1964

# results of the DlpJob will be applied to the entry for the resource scanned

1965

# in Cloud Data Catalog. Any labels previously written by another DlpJob will

1966

# be deleted. InfoType naming patterns are strictly enforced when using this

1967

# feature. Note that the findings will be persisted in Cloud Data Catalog

1968

# storage and are governed by Data Catalog service-specific policy, see

1969

# https://cloud.google.com/terms/service-terms

1970

# Only a single instance of this action can be specified and only allowed if

1971

# all resources being scanned are BigQuery tables.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1972

# Compatible with: Inspect

1973

},

1974

"jobNotificationEmails": { # Enable email notification to project owners and editors on jobs's # Enable email notification for project owners and editors on job's

1975

# completion/failure.

1976

# completion/failure.

1977

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1978

"pubSub": { # Publish a message into given Pub/Sub topic when DlpJob has completed. The # Publish a notification to a pubsub topic.

1979

# message contains a single field, `DlpJobName`, which is equal to the

1980

# finished job's

1981

# [`DlpJob.name`](https://cloud.google.com/dlp/docs/reference/rest/v2/projects.dlpJobs#DlpJob).

1982

# Compatible with: Inspect, Risk

1983

"topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given

1984

# publishing access rights to the DLP API service account executing

1985

# the long running DlpJob sending the notifications.

1986

# Format is projects/{project}/topics/{topic}.

1987

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1988

"saveFindings": { # If set, the detailed findings will be persisted to the specified # Save resulting findings in a provided location.

1989

# OutputStorageConfig. Only a single instance of this action can be

1990

# specified.

1991

# Compatible with: Inspect, Risk

1992

"outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1993

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only

1994

# used for Inspect and must be unspecified for Risk jobs. Columns are derived

1995

# from the `Finding` object. If appending to an existing table, any columns

1996

# from the predefined schema that are missing will be added. No columns in

1997

# the existing table will be deleted.

1998

#

1999

# If unspecified, then all available columns will be used for a new table or

2000

# an (existing) table with no schema, and no changes will be made to an

2001

# existing table that has a schema.

2002

# Only for use with external storage.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2003

"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

2004

# dataset. If table_id is not set a new one will be generated

2005

# for you with the following format:

2006

# dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific timezone will be used for

2007

# generating the date details.

2008

#

2009

# For Inspect, each column in an existing output table must have the same

2010

# name, type, and mode of a field in the `Finding` object.

2011

#

2012

# For Risk, an existing output table should be the output of a previous

2013

# Risk analysis job run on the same source table, with the same privacy

2014

# metric and quasi-identifiers. Risk jobs that analyze the same table but

2015

# compute a different privacy metric, or use different sets of

2016

# quasi-identifiers, cannot store their results in the same table.

2017

# identified by its project_id, dataset_id, and table_name. Within a query

2018

# a table is often referenced with a string in the format of:

2019

# `<project_id>:<dataset_id>.<table_id>` or

2020

# `<project_id>.<dataset_id>.<table_id>`.

2021

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table.

2022

# If omitted, project ID is inferred from the API call.

2023

"datasetId": "A String", # Dataset ID of the table.

2024

"tableId": "A String", # Name of the table.

2025

},

2026

},

2027

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2028

"publishSummaryToCscc": { # Publish the result summary of a DlpJob to the Cloud Security # Publish summary to Cloud Security Command Center (Alpha).

2029

# Command Center (CSCC Alpha).

2030

# This action is only available for projects which are parts of

2031

# an organization and whitelisted for the alpha Cloud Security Command

2032

# Center.

2033

# The action will publish count of finding instances and their info types.

2034

# The summary of findings will be persisted in CSCC and are governed by CSCC

2035

# service-specific policy, see https://cloud.google.com/terms/service-terms

2036

# Only a single instance of this action can be specified.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2037

# Compatible with: Inspect

2038

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2039

},

2040

],

2041

"storageConfig": { # Shared message indicating Cloud storage type. # The data to scan.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2042

"cloudStorageOptions": { # Options defining a file or a set of files within a Google Cloud Storage # Google Cloud Storage options.

2043

# bucket.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2044

"bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The

2045

# number of bytes scanned is rounded down. Must be between 0 and 100,

2046

# inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one

2047

# of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.

2048

"fileTypes": [ # List of file type groups to include in the scan.

2049

# If empty, all files are scanned and available data format processors

2050

# are applied. In addition, the binary content of the selected files

2051

# is always scanned as well.

2052

# Images are scanned only as binary if the specified region

2053

# does not support image inspection and no file_types were specified.

2054

# Image inspection is restricted to 'global', 'us', 'asia', and 'europe'.

2055

"A String",

2056

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2057

"bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger

2058

# than this value then the rest of the bytes are omitted. Only one

2059

# of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2060

"filesLimitPercent": 42, # Limits the number of files to scan to this percentage of the input FileSet.

2061

# Number of files scanned is rounded down. Must be between 0 and 100,

2062

# inclusively. Both 0 and 100 means no limit. Defaults to 0.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2063

"fileSet": { # Set of files to scan. # The set of one or more files to scan.

2064

"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

2065

# `regex_file_set` must be set.

2066

# expressions are used to allow fine-grained control over which files in the

2067

# bucket to include.

2068

#

2069

# Included files are those that match at least one item in `include_regex` and

2070

# do not match any items in `exclude_regex`. Note that a file that matches

2071

# items from both lists will _not_ be included. For a match to occur, the

2072

# entire file path (i.e., everything in the url after the bucket name) must

2073

# match the regular expression.

2074

#

2075

# For example, given the input `{bucket_name: "mybucket", include_regex:

2076

# ["directory1/.*"], exclude_regex:

2077

# ["directory1/excluded.*"]}`:

2078

#

2079

# * `gs://mybucket/directory1/myfile` will be included

2080

# * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches

2081

# across `/`)

2082

# * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the

2083

# full path doesn't match any items in `include_regex`)

2084

# * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path

2085

# matches an item in `exclude_regex`)

2086

#

2087

# If `include_regex` is left empty, it will match all files by default

2088

# (this is equivalent to setting `include_regex: [".*"]`).

2089

#

2090

# Some other common use cases:

2091

#

2092

# * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all

2093

# files in `mybucket` except for .pdf files

2094

# * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will

2095

# include all files directly under `gs://mybucket/directory/`, without matching

2096

# across `/`

2097

"bucketName": "A String", # The name of a Cloud Storage bucket. Required.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2098

"excludeRegex": [ # A list of regular expressions matching file paths to exclude. All files in

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2099

# the bucket that match at least one of these regular expressions will be

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2100

# excluded from the scan.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2101

#

2102

# Regular expressions use RE2

2103

# [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found

2104

# under the google/re2 repository on GitHub.

2105

"A String",

2106

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2107

"includeRegex": [ # A list of regular expressions matching file paths to include. All files in

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2108

# the bucket that match at least one of these regular expressions will be

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2109

# included in the set of files, except for those that also match an item in

2110

# `exclude_regex`. Leaving this field empty will match all files by default

2111

# (this is equivalent to including `.*` in the list).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2112

#

2113

# Regular expressions use RE2

2114

# [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found

2115

# 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

2120

# `gs://<bucket>/<path>`. Trailing wildcard in the path is allowed.

2121

#

2122

# If the url ends in a trailing slash, the bucket or directory represented

2123

# by the url will be scanned non-recursively (content in sub-directories

2124

# will not be scanned). This means that `gs://mybucket/` is equivalent to

2125

# `gs://mybucket/*`, and `gs://mybucket/directory/` is equivalent to

2126

# `gs://mybucket/directory/*`.

2127

#

2128

# Exactly one of `url` or `regex_file_set` must be set.

2129

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2130

"sampleMethod": "A String",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2131

},

2132

"bigQueryOptions": { # Options defining BigQuery table and row identifiers. # BigQuery options.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2133

"sampleMethod": "A String",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2134

"tableReference": { # Message defining the location of a BigQuery table. A table is uniquely # Complete BigQuery table reference.

2135

# identified by its project_id, dataset_id, and table_name. Within a query

2136

# a table is often referenced with a string in the format of:

2137

# `<project_id>:<dataset_id>.<table_id>` or

2138

# `<project_id>.<dataset_id>.<table_id>`.

2139

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table.

2140

# If omitted, project ID is inferred from the API call.

2141

"datasetId": "A String", # Dataset ID of the table.

2142

"tableId": "A String", # Name of the table.

2143

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2144

"rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows

2145

# scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and

2146

# 100 means no limit. Defaults to 0. Only one of rows_limit and

2147

# rows_limit_percent can be specified. Cannot be used in conjunction with

2148

# TimespanConfig.

2149

"rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the

2150

# rest of the rows are omitted. If not set, or if set to 0, all rows will be

2151

# scanned. Only one of rows_limit and rows_limit_percent can be specified.

2152

# Cannot be used in conjunction with TimespanConfig.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2153

"identifyingFields": [ # Table fields that may uniquely identify a row within the table. When

2154

# `actions.saveFindings.outputConfig.table` is specified, the values of

2155

# columns specified here are available in the output table under

2156

# `location.content_locations.record_location.record_key.id_values`. Nested

2157

# fields such as `person.birthdate.year` are allowed.

2158

{ # General identifier of a data field in a storage service.

2159

"name": "A String", # Name describing the field.

2160

},

2161

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2162

"excludedFields": [ # References to fields excluded from scanning. This allows you to skip

2163

# inspection of entire columns which you know have no findings.

2164

{ # General identifier of a data field in a storage service.

2165

"name": "A String", # Name describing the field.

2166

},

2167

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2168

},

2169

"timespanConfig": { # Configuration of the timespan of the items to include in scanning.

2170

# Currently only supported when inspecting Google Cloud Storage and BigQuery.

2171

"timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items.

2172

# Used for data sources like Datastore and BigQuery.

2173

#

2174

# For BigQuery:

2175

# Required to filter out rows based on the given start and

2176

# end times. If not specified and the table was modified between the given

2177

# start and end times, the entire table will be scanned.

2178

# The valid data types of the timestamp field are: `INTEGER`, `DATE`,

2179

# `TIMESTAMP`, or `DATETIME` BigQuery column.

2180

#

2181

# For Datastore.

2182

# Valid data types of the timestamp field are: `TIMESTAMP`.

2183

# Datastore entity will be scanned if the timestamp property does not

2184

# exist or its value is empty or invalid.

2185

"name": "A String", # Name describing the field.

2186

},

2187

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out

2188

# a valid start_time to avoid scanning files that have not been modified

2189

# since the last time the JobTrigger executed. This will be based on the

2190

# time of the execution of the last run of the JobTrigger.

2191

"startTime": "A String", # Exclude files or rows older than this value.

2192

"endTime": "A String", # Exclude files or rows newer than this value.

2193

# If set to zero, no upper time limit is applied.

2194

},

2195

"datastoreOptions": { # Options defining a data set within Google Cloud Datastore. # Google Cloud Datastore options.

2196

"kind": { # A representation of a Datastore kind. # The kind to process.

2197

"name": "A String", # The name of the kind.

2198

},

2199

"partitionId": { # Datastore partition ID. # A partition ID identifies a grouping of entities. The grouping is always

2200

# by project and namespace, however the namespace ID may be empty.

2201

# A partition ID identifies a grouping of entities. The grouping is always

2202

# by project and namespace, however the namespace ID may be empty.

2203

#

2204

# A partition ID contains several dimensions:

2205

# project ID and namespace ID.

2206

"namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.

2207

"projectId": "A String", # The ID of the project to which the entities belong.

2208

},

2209

},

2210

"hybridOptions": { # Configuration to control jobs where the content being inspected is outside # Hybrid inspection options.

2211

# Early access feature is in a pre-release state and might change or have

2212

# limited support. For more information, see

2213

# https://cloud.google.com/products#product-launch-stages.

2214

# of Google Cloud Platform.

2215

"tableOptions": { # Instructions regarding the table content being inspected. # If the container is a table, additional information to make findings

2216

# meaningful such as the columns that are primary keys.

2217

"identifyingFields": [ # The columns that are the primary keys for table objects included in

2218

# ContentItem. A copy of this cell's value will stored alongside alongside

2219

# each finding so that the finding can be traced to the specific row it came

2220

# from. No more than 3 may be provided.

2221

{ # General identifier of a data field in a storage service.

2222

"name": "A String", # Name describing the field.

},

],

},

"requiredFindingLabelKeys": [ # These are labels that each inspection request must include within their

2227

# 'finding_labels' map. Request may contain others, but any missing one of

2228

# these will be rejected.

2229

#

2230

# Label keys must be between 1 and 63 characters long and must conform

2231

# to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.

2232

#

2233

# No more than 10 keys can be required.

2234

"A String",

2235

],

2236

"labels": { # To organize findings, these labels will be added to each finding.

2237

#

2238

# Label keys must be between 1 and 63 characters long and must conform

2239

# to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.

2240

#

2241

# Label values must be between 0 and 63 characters long and must conform

2242

# to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.

2243

#

2244

# No more than 10 labels can be associated with a given finding.

2245

#

2246

# Examples:

2247

# * `"environment" : "production"`

2248

# * `"pipeline" : "etl"`

2249

"a_key": "A String",

2250

},

2251

"description": "A String", # A short description of where the data is coming from. Will be stored once

2252

# in the job. 256 max length.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2253

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2254

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2255

"inspectConfig": { # Configuration description of the scanning process. # How and what to scan for.

2256

# When used with redactContent only info_types and min_likelihood are currently

2257

# used.

2258

"customInfoTypes": [ # CustomInfoTypes provided by the user. See

2259

# https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more.

2260

{ # Custom information type provided by the user. Used to find domain-specific

2261

# sensitive information configurable to the data in question.

2262

"dictionary": { # Custom information type based on a dictionary of words or phrases. This can # A list of phrases to detect as a CustomInfoType.

2263

# be used to match sensitive information specific to the data, such as a list

2264

# of employee IDs or job titles.

2265

#

2266

# Dictionary words are case-insensitive and all characters other than letters

2267

# and digits in the unicode [Basic Multilingual

2268

# Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane)

2269

# will be replaced with whitespace when scanning for matches, so the

2270

# dictionary phrase "Sam Johnson" will match all three phrases "sam johnson",

2271

# "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters

2272

# surrounding any match must be of a different type than the adjacent

2273

# characters within the word, so letters must be next to non-letters and

2274

# digits next to non-digits. For example, the dictionary word "jen" will

2275

# match the first three letters of the text "jen123" but will return no

2276

# matches for "jennifer".

2277

#

2278

# Dictionary words containing a large number of characters that are not

2279

# letters or digits may result in unexpected findings because such characters

2280

# are treated as whitespace. The

2281

# [limits](https://cloud.google.com/dlp/limits) page contains details about

2282

# the size limits of dictionaries. For dictionaries that do not fit within

2283

# these constraints, consider using `LargeCustomDictionaryConfig` in the

2284

# `StoredInfoType` API.

2285

"cloudStoragePath": { # Message representing a single file or path in Cloud Storage. # Newline-delimited file of words in Cloud Storage. Only a single file

2286

# is accepted.

2287

"path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage.

2288

# Example: gs://[BUCKET_NAME]/dictionary.txt

2289

},

2290

"wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for.

2291

"words": [ # Words or phrases defining the dictionary. The dictionary must contain

2292

# at least one phrase and every phrase must contain at least 2 characters

2293

# that are letters or digits. [required]

"A String",

],

},

},

"infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in

2299

# infoType, when the name matches one of existing infoTypes and that infoType

2300

# is specified in `InspectContent.info_types` field. Specifying the latter

2301

# adds findings to the one detected by the system. If built-in info type is

2302

# not specified in `InspectContent.info_types` list then the name is treated

2303

# as a custom info type.

2304

"name": "A String", # Name of the information type. Either a name of your choosing when

2305

# creating a CustomInfoType, or one of the names listed

2306

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

2307

# a built-in type. When sending Cloud DLP results to Data Catalog, infoType

2308

# names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

2309

},

2310

"likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be

2311

# altered by a detection rule if the finding meets the criteria specified by

2312

# the rule. Defaults to `VERY_LIKELY` if not specified.

2313

"detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType.

2314

# Rules are applied in order that they are specified. Not supported for the

2315

# `surrogate_type` CustomInfoType.

2316

{ # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a

2317

# `CustomInfoType` to alter behavior under certain circumstances, depending

2318

# on the specific details of the rule. Not supported for the `surrogate_type`

2319

# custom infoType.

2320

"hotwordRule": { # The rule that adjusts the likelihood of findings within a certain # Hotword-based detection rule.

2321

# proximity of hotwords.

2322

"proximity": { # Message for specifying a window around a finding to apply a detection # Proximity of the finding within which the entire hotword must reside.

2323

# The total length of the window cannot exceed 1000 characters. Note that

2324

# the finding itself will be included in the window, so that hotwords may

2325

# be used to match substrings of the finding itself. For example, the

2326

# certainty of a phone number regex "$\d{3}$ \d{3}-\d{4}" could be

2327

# adjusted upwards if the area code is known to be the local area code of

2328

# a company office using the hotword regex "$xxx$", where "xxx"

2329

# is the area code in question.

2330

# rule.

2331

"windowAfter": 42, # Number of characters after the finding to consider.

2332

"windowBefore": 42, # Number of characters before the finding to consider.

2333

},

2334

"likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as # Likelihood adjustment to apply to all matching findings.

2335

# part of a detection rule.

2336

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value.

2337

"relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of

2338

# levels. For example, if a finding would be `POSSIBLE` without the

2339

# detection rule and `relative_likelihood` is 1, then it is upgraded to

2340

# `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`.

2341

# Likelihood may never drop below `VERY_UNLIKELY` or exceed

2342

# `VERY_LIKELY`, so applying an adjustment of 1 followed by an

2343

# adjustment of -1 when base likelihood is `VERY_LIKELY` will result in

2344

# a final likelihood of `LIKELY`.

2345

},

2346

"hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword.

2347

"groupIndexes": [ # The index of the submatch to extract as findings. When not

2348

# specified, the entire match is returned. No more than 3 may be included.

2349

42,

2350

],

2351

"pattern": "A String", # Pattern defining the regular expression. Its syntax

2352

# (https://github.com/google/re2/wiki/Syntax) can be found under the

2353

# google/re2 repository on GitHub.

},

},

},

],

"surrogateType": { # Message for detecting output from deidentification transformations # Message for detecting output from deidentification transformations that

2359

# support reversing.

2360

# such as

2361

# [`CryptoReplaceFfxFpeConfig`](https://cloud.google.com/dlp/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig).

2362

# These types of transformations are

2363

# those that perform pseudonymization, thereby producing a "surrogate" as

2364

# output. This should be used in conjunction with a field on the

2365

# transformation such as `surrogate_info_type`. This CustomInfoType does

2366

# not support the use of `detection_rules`.

2367

},

2368

"regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType.

2369

"groupIndexes": [ # The index of the submatch to extract as findings. When not

2370

# specified, the entire match is returned. No more than 3 may be included.

2371

42,

2372

],

2373

"pattern": "A String", # Pattern defining the regular expression. Its syntax

2374

# (https://github.com/google/re2/wiki/Syntax) can be found under the

2375

# google/re2 repository on GitHub.

2376

},

2377

"storedType": { # A reference to a StoredInfoType to use with scanning. # Load an existing `StoredInfoType` resource for use in

2378

# `InspectDataSource`. Not currently supported in `InspectContent`.

2379

"name": "A String", # Resource name of the requested `StoredInfoType`, for example

2380

# `organizations/433245324/storedInfoTypes/432452342` or

2381

# `projects/project-id/storedInfoTypes/432452342`.

2382

"createTime": "A String", # Timestamp indicating when the version of the `StoredInfoType` used for

2383

# inspection was created. Output-only field, populated by the system.

2384

},

2385

"exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding

2386

# to be returned. It still can be used for rules matching.

2387

},

2388

],

2389

"minLikelihood": "A String", # Only returns findings equal or above this threshold. The default is

2390

# POSSIBLE.

2391

# See https://cloud.google.com/dlp/docs/likelihood to learn more.

2392

"limits": { # Configuration to control the number of findings returned. # Configuration to control the number of findings returned.

2393

"maxFindingsPerRequest": 42, # Max number of findings that will be returned per request/job.

2394

# When set within `InspectContentRequest`, the maximum returned is 2000

2395

# regardless if this is set higher.

2396

"maxFindingsPerInfoType": [ # Configuration of findings limit given for specified infoTypes.

2397

{ # Max findings configuration per infoType, per content item or long

2398

# running DlpJob.

2399

"infoType": { # Type of information detected by the API. # Type of information the findings limit applies to. Only one limit per

2400

# info_type should be provided. If InfoTypeLimit does not have an

2401

# info_type, the DLP API applies the limit against all info_types that

2402

# are found but not specified in another InfoTypeLimit.

2403

"name": "A String", # Name of the information type. Either a name of your choosing when

2404

# creating a CustomInfoType, or one of the names listed

2405

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

2406

# a built-in type. When sending Cloud DLP results to Data Catalog, infoType

2407

# names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

2408

},

2409

"maxFindings": 42, # Max findings limit for the given infoType.

2410

},

2411

],

2412

"maxFindingsPerItem": 42, # Max number of findings that will be returned for each item scanned.

2413

# When set within `InspectJobConfig`,

2414

# the maximum returned is 2000 regardless if this is set higher.

2415

# When set within `InspectContentRequest`, this field is ignored.

2416

},

2417

"excludeInfoTypes": True or False, # When true, excludes type information of the findings.

2418

"includeQuote": True or False, # When true, a contextual quote from the data that triggered a finding is

2419

# included in the response; see Finding.quote.

2420

"ruleSet": [ # Set of rules to apply to the findings for this InspectConfig.

2421

# Exclusion rules, contained in the set are executed in the end, other

2422

# rules are executed in the order they are specified for each info type.

2423

{ # Rule set for modifying a set of infoTypes to alter behavior under certain

2424

# circumstances, depending on the specific details of the rules within the set.

2425

"infoTypes": [ # List of infoTypes this rule set is applied to.

2426

{ # Type of information detected by the API.

2427

"name": "A String", # Name of the information type. Either a name of your choosing when

2428

# creating a CustomInfoType, or one of the names listed

2429

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

2430

# a built-in type. When sending Cloud DLP results to Data Catalog, infoType

2431

# names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

2432

},

2433

],

2434

"rules": [ # Set of rules to be applied to infoTypes. The rules are applied in order.

2435

{ # A single inspection rule to be applied to infoTypes, specified in

2436

# `InspectionRuleSet`.

2437

"hotwordRule": { # The rule that adjusts the likelihood of findings within a certain # Hotword-based detection rule.

2438

# proximity of hotwords.

2439

"proximity": { # Message for specifying a window around a finding to apply a detection # Proximity of the finding within which the entire hotword must reside.

2440

# The total length of the window cannot exceed 1000 characters. Note that

2441

# the finding itself will be included in the window, so that hotwords may

2442

# be used to match substrings of the finding itself. For example, the

2443

# certainty of a phone number regex "$\d{3}$ \d{3}-\d{4}" could be

2444

# adjusted upwards if the area code is known to be the local area code of

2445

# a company office using the hotword regex "$xxx$", where "xxx"

2446

# is the area code in question.

2447

# rule.

2448

"windowAfter": 42, # Number of characters after the finding to consider.

2449

"windowBefore": 42, # Number of characters before the finding to consider.

2450

},

2451

"likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as # Likelihood adjustment to apply to all matching findings.

2452

# part of a detection rule.

2453

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value.

2454

"relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of

2455

# levels. For example, if a finding would be `POSSIBLE` without the

2456

# detection rule and `relative_likelihood` is 1, then it is upgraded to

2457

# `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`.

2458

# Likelihood may never drop below `VERY_UNLIKELY` or exceed

2459

# `VERY_LIKELY`, so applying an adjustment of 1 followed by an

2460

# adjustment of -1 when base likelihood is `VERY_LIKELY` will result in

2461

# a final likelihood of `LIKELY`.

2462

},

2463

"hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword.

2464

"groupIndexes": [ # The index of the submatch to extract as findings. When not

2465

# specified, the entire match is returned. No more than 3 may be included.

2466

42,

2467

],

2468

"pattern": "A String", # Pattern defining the regular expression. Its syntax

2469

# (https://github.com/google/re2/wiki/Syntax) can be found under the

2470

# google/re2 repository on GitHub.

2471

},

2472

},

2473

"exclusionRule": { # The rule that specifies conditions when findings of infoTypes specified in # Exclusion rule.

2474

# `InspectionRuleSet` are removed from results.

2475

"matchingType": "A String", # How the rule is applied, see MatchingType documentation for details.

2476

"dictionary": { # Custom information type based on a dictionary of words or phrases. This can # Dictionary which defines the rule.

2477

# be used to match sensitive information specific to the data, such as a list

2478

# of employee IDs or job titles.

2479

#

2480

# Dictionary words are case-insensitive and all characters other than letters

2481

# and digits in the unicode [Basic Multilingual

2482

# Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane)

2483

# will be replaced with whitespace when scanning for matches, so the

2484

# dictionary phrase "Sam Johnson" will match all three phrases "sam johnson",

2485

# "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters

2486

# surrounding any match must be of a different type than the adjacent

2487

# characters within the word, so letters must be next to non-letters and

2488

# digits next to non-digits. For example, the dictionary word "jen" will

2489

# match the first three letters of the text "jen123" but will return no

2490

# matches for "jennifer".

2491

#

2492

# Dictionary words containing a large number of characters that are not

2493

# letters or digits may result in unexpected findings because such characters

2494

# are treated as whitespace. The

2495

# [limits](https://cloud.google.com/dlp/limits) page contains details about

2496

# the size limits of dictionaries. For dictionaries that do not fit within

2497

# these constraints, consider using `LargeCustomDictionaryConfig` in the

2498

# `StoredInfoType` API.

2499

"cloudStoragePath": { # Message representing a single file or path in Cloud Storage. # Newline-delimited file of words in Cloud Storage. Only a single file

2500

# is accepted.

2501

"path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage.

2502

# Example: gs://[BUCKET_NAME]/dictionary.txt

2503

},

2504

"wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for.

2505

"words": [ # Words or phrases defining the dictionary. The dictionary must contain

2506

# at least one phrase and every phrase must contain at least 2 characters

2507

# that are letters or digits. [required]

"A String",

],

},

},

"excludeInfoTypes": { # List of exclude infoTypes. # Set of infoTypes for which findings would affect this rule.

2513

"infoTypes": [ # InfoType list in ExclusionRule rule drops a finding when it overlaps or

2514

# contained within with a finding of an infoType from this list. For

2515

# example, for `InspectionRuleSet.info_types` containing "PHONE_NUMBER"` and

2516

# `exclusion_rule` containing `exclude_info_types.info_types` with

2517

# "EMAIL_ADDRESS" the phone number findings are dropped if they overlap

2518

# with EMAIL_ADDRESS finding.

2519

# That leads to "555-222-2222@example.org" to generate only a single

2520

# finding, namely email address.

2521

{ # Type of information detected by the API.

2522

"name": "A String", # Name of the information type. Either a name of your choosing when

2523

# creating a CustomInfoType, or one of the names listed

2524

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

2525

# a built-in type. When sending Cloud DLP results to Data Catalog, infoType

2526

# names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

},

],

},

"regex": { # Message defining a custom regular expression. # Regular expression which defines the rule.

2531

"groupIndexes": [ # The index of the submatch to extract as findings. When not

2532

# specified, the entire match is returned. No more than 3 may be included.

2533

42,

2534

],

2535

"pattern": "A String", # Pattern defining the regular expression. Its syntax

2536

# (https://github.com/google/re2/wiki/Syntax) can be found under the

2537

# google/re2 repository on GitHub.

},

},

},

],

},

],

"contentOptions": [ # List of options defining data content to scan.

2545

# If empty, text, images, and other content will be included.

2546

"A String",

2547

],

2548

"infoTypes": [ # Restricts what info_types to look for. The values must correspond to

2549

# InfoType values returned by ListInfoTypes or listed at

2550

# https://cloud.google.com/dlp/docs/infotypes-reference.

2551

#

2552

# When no InfoTypes or CustomInfoTypes are specified in a request, the

2553

# system may automatically choose what detectors to run. By default this may

2554

# be all types, but may change over time as detectors are updated.

2555

#

2556

# If you need precise control and predictability as to what detectors are

2557

# run you should specify specific InfoTypes listed in the reference,

2558

# otherwise a default list will be used, which may change over time.

2559

{ # Type of information detected by the API.

2560

"name": "A String", # Name of the information type. Either a name of your choosing when

2561

# creating a CustomInfoType, or one of the names listed

2562

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

2563

# a built-in type. When sending Cloud DLP results to Data Catalog, infoType

2564

# names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

2565

},

2566

],

2567

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2568

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2569

"name": "A String", # Unique resource name for the triggeredJob, assigned by the service when the

2570

# triggeredJob is created, for example

2571

# `projects/dlp-test-project/jobTriggers/53234423`.

2572

"displayName": "A String", # Display name (max 100 chars)

2573

"lastRunTime": "A String", # Output only. The timestamp of the last time this trigger executed.

2574

"createTime": "A String", # Output only. The creation timestamp of a triggeredJob.

2575

"description": "A String", # User provided description (max 256 chars)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2576

},

2577

"triggerId": "A String", # The trigger id can contain uppercase and lowercase letters,

2578

# numbers, and hyphens; that is, it must match the regular

2579

# expression: `[a-zA-Z\\d-_]+`. The maximum length is 100

2580

# characters. Can be empty to allow the system to generate one.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2581

}

2582

2583

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2590

2591

{ # Contains a configuration to make dlp api calls on a repeating basis.

2592

# See https://cloud.google.com/dlp/docs/concepts-job-triggers to learn more.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2593

"status": "A String", # Required. A status for this trigger.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2594

"triggers": [ # A list of triggers which will be OR'ed together. Only one in the list

2595

# needs to trigger for a job to be started. The list may contain only

2596

# a single Schedule trigger and must have at least one object.

2597

{ # What event needs to occur for a new job to be started.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2598

"manual": { # Job trigger option for hybrid jobs. Jobs must be manually created # For use with hybrid jobs. Jobs must be manually created and finished.

2599

# Early access feature is in a pre-release state and might change or have

2600

# limited support. For more information, see

2601

# https://cloud.google.com/products#product-launch-stages.

2602

# and finished.

2603

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2604

"schedule": { # Schedule for triggeredJobs. # Create a job on a repeating basis based on the elapse of time.

2605

"recurrencePeriodDuration": "A String", # With this option a job is started a regular periodic basis. For

2606

# example: every day (86400 seconds).

2607

#

2608

# A scheduled start time will be skipped if the previous

2609

# execution has not ended when its scheduled time occurs.

2610

#

2611

# This value must be set to a time duration greater than or equal

2612

# to 1 day and can be no longer than 60 days.

2613

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2614

},

2615

],

2616

"errors": [ # Output only. A stream of errors encountered when the trigger was activated. Repeated

2617

# errors may result in the JobTrigger automatically being paused.

2618

# Will return the last 100 errors. Whenever the JobTrigger is modified

2619

# this list will be cleared.

2620

{ # Details information about an error encountered during job execution or

2621

# the results of an unsuccessful activation of the JobTrigger.

2622

"timestamps": [ # The times the error occurred.

2623

"A String",

2624

],

2625

"details": { # The `Status` type defines a logical error model that is suitable for # Detailed error codes and messages.

2626

# different programming environments, including REST APIs and RPC APIs. It is

2627

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

2628

# three pieces of data: error code, error message, and error details.

2629

#

2630

# You can find out more about this error model and how to work with it in the

2631

# [API Design Guide](https://cloud.google.com/apis/design/errors).

2632

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

2633

"details": [ # A list of messages that carry the error details. There is a common set of

2634

# message types for APIs to use.

2635

{

2636

"a_key": "", # Properties of the object. Contains field @type with type URL.

2637

},

2638

],

2639

"message": "A String", # A developer-facing error message, which should be in English. Any

2640

# user-facing error message should be localized and sent in the

2641

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2642

},

2643

},

2644

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2645

"updateTime": "A String", # Output only. The last update timestamp of a triggeredJob.

2646

"inspectJob": { # Controls what and how to inspect for findings. # For inspect jobs, a snapshot of the configuration.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2647

"inspectTemplateName": "A String", # If provided, will be used as the default for all values in InspectConfig.

2648

# `inspect_config` will be merged into the values persisted as part of the

2649

# template.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2650

"actions": [ # Actions to execute at the completion of the job.

2651

{ # A task to execute on the completion of a job.

2652

# See https://cloud.google.com/dlp/docs/concepts-actions to learn more.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2653

"publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This # Enable Stackdriver metric dlp.googleapis.com/finding_count.

2654

# will publish a metric to stack driver on each infotype requested and

2655

# how many findings were found for it. CustomDetectors will be bucketed

2656

# as 'Custom' under the Stackdriver label 'info_type'.

2657

},

2658

"publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Cloud Data Catalog. Labels summarizing the # Publish findings to Cloud Datahub.

2659

# results of the DlpJob will be applied to the entry for the resource scanned

2660

# in Cloud Data Catalog. Any labels previously written by another DlpJob will

2661

# be deleted. InfoType naming patterns are strictly enforced when using this

2662

# feature. Note that the findings will be persisted in Cloud Data Catalog

2663

# storage and are governed by Data Catalog service-specific policy, see

2664

# https://cloud.google.com/terms/service-terms

2665

# Only a single instance of this action can be specified and only allowed if

2666

# all resources being scanned are BigQuery tables.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2667

# Compatible with: Inspect

2668

},

2669

"jobNotificationEmails": { # Enable email notification to project owners and editors on jobs's # Enable email notification for project owners and editors on job's

2670

# completion/failure.

2671

# completion/failure.

2672

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2673

"pubSub": { # Publish a message into given Pub/Sub topic when DlpJob has completed. The # Publish a notification to a pubsub topic.

2674

# message contains a single field, `DlpJobName`, which is equal to the

2675

# finished job's

2676

# [`DlpJob.name`](https://cloud.google.com/dlp/docs/reference/rest/v2/projects.dlpJobs#DlpJob).

2677

# Compatible with: Inspect, Risk

2678

"topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given

2679

# publishing access rights to the DLP API service account executing

2680

# the long running DlpJob sending the notifications.

2681

# Format is projects/{project}/topics/{topic}.

2682

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2683

"saveFindings": { # If set, the detailed findings will be persisted to the specified # Save resulting findings in a provided location.

2684

# OutputStorageConfig. Only a single instance of this action can be

2685

# specified.

2686

# Compatible with: Inspect, Risk

2687

"outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2688

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only

2689

# used for Inspect and must be unspecified for Risk jobs. Columns are derived

2690

# from the `Finding` object. If appending to an existing table, any columns

2691

# from the predefined schema that are missing will be added. No columns in

2692

# the existing table will be deleted.

2693

#

2694

# If unspecified, then all available columns will be used for a new table or

2695

# an (existing) table with no schema, and no changes will be made to an

2696

# existing table that has a schema.

2697

# Only for use with external storage.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2698

"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

2699

# dataset. If table_id is not set a new one will be generated

2700

# for you with the following format:

2701

# dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific timezone will be used for

2702

# generating the date details.

2703

#

2704

# For Inspect, each column in an existing output table must have the same

2705

# name, type, and mode of a field in the `Finding` object.

2706

#

2707

# For Risk, an existing output table should be the output of a previous

2708

# Risk analysis job run on the same source table, with the same privacy

2709

# metric and quasi-identifiers. Risk jobs that analyze the same table but

2710

# compute a different privacy metric, or use different sets of

2711

# quasi-identifiers, cannot store their results in the same table.

2712

# identified by its project_id, dataset_id, and table_name. Within a query

2713

# a table is often referenced with a string in the format of:

2714

# `<project_id>:<dataset_id>.<table_id>` or

2715

# `<project_id>.<dataset_id>.<table_id>`.

2716

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table.

2717

# If omitted, project ID is inferred from the API call.

2718

"datasetId": "A String", # Dataset ID of the table.

2719

"tableId": "A String", # Name of the table.

2720

},

2721

},

2722

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2723

"publishSummaryToCscc": { # Publish the result summary of a DlpJob to the Cloud Security # Publish summary to Cloud Security Command Center (Alpha).

2724

# Command Center (CSCC Alpha).

2725

# This action is only available for projects which are parts of

2726

# an organization and whitelisted for the alpha Cloud Security Command

2727

# Center.

2728

# The action will publish count of finding instances and their info types.

2729

# The summary of findings will be persisted in CSCC and are governed by CSCC

2730

# service-specific policy, see https://cloud.google.com/terms/service-terms

2731

# Only a single instance of this action can be specified.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2732

# Compatible with: Inspect

2733

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2734

},

2735

],

2736

"storageConfig": { # Shared message indicating Cloud storage type. # The data to scan.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2737

"cloudStorageOptions": { # Options defining a file or a set of files within a Google Cloud Storage # Google Cloud Storage options.

2738

# bucket.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2739

"bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The

2740

# number of bytes scanned is rounded down. Must be between 0 and 100,

2741

# inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one

2742

# of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.

2743

"fileTypes": [ # List of file type groups to include in the scan.

2744

# If empty, all files are scanned and available data format processors

2745

# are applied. In addition, the binary content of the selected files

2746

# is always scanned as well.

2747

# Images are scanned only as binary if the specified region

2748

# does not support image inspection and no file_types were specified.

2749

# Image inspection is restricted to 'global', 'us', 'asia', and 'europe'.

2750

"A String",

2751

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2752

"bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger

2753

# than this value then the rest of the bytes are omitted. Only one

2754

# of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2755

"filesLimitPercent": 42, # Limits the number of files to scan to this percentage of the input FileSet.

2756

# Number of files scanned is rounded down. Must be between 0 and 100,

2757

# inclusively. Both 0 and 100 means no limit. Defaults to 0.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2758

"fileSet": { # Set of files to scan. # The set of one or more files to scan.

2759

"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

2760

# `regex_file_set` must be set.

2761

# expressions are used to allow fine-grained control over which files in the

2762

# bucket to include.

2763

#

2764

# Included files are those that match at least one item in `include_regex` and

2765

# do not match any items in `exclude_regex`. Note that a file that matches

2766

# items from both lists will _not_ be included. For a match to occur, the

2767

# entire file path (i.e., everything in the url after the bucket name) must

2768

# match the regular expression.

2769

#

2770

# For example, given the input `{bucket_name: "mybucket", include_regex:

2771

# ["directory1/.*"], exclude_regex:

2772

# ["directory1/excluded.*"]}`:

2773

#

2774

# * `gs://mybucket/directory1/myfile` will be included

2775

# * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches

2776

# across `/`)

2777

# * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the

2778

# full path doesn't match any items in `include_regex`)

2779

# * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path

2780

# matches an item in `exclude_regex`)

2781

#

2782

# If `include_regex` is left empty, it will match all files by default

2783

# (this is equivalent to setting `include_regex: [".*"]`).

2784

#

2785

# Some other common use cases:

2786

#

2787

# * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all

2788

# files in `mybucket` except for .pdf files

2789

# * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will

2790

# include all files directly under `gs://mybucket/directory/`, without matching

2791

# across `/`

2792

"bucketName": "A String", # The name of a Cloud Storage bucket. Required.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2793

"excludeRegex": [ # A list of regular expressions matching file paths to exclude. All files in

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2794

# the bucket that match at least one of these regular expressions will be

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2795

# excluded from the scan.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2796

#

2797

# Regular expressions use RE2

2798

# [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found

2799

# under the google/re2 repository on GitHub.

2800

"A String",

2801

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2802

"includeRegex": [ # A list of regular expressions matching file paths to include. All files in

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2803

# the bucket that match at least one of these regular expressions will be

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2804

# included in the set of files, except for those that also match an item in

2805

# `exclude_regex`. Leaving this field empty will match all files by default

2806

# (this is equivalent to including `.*` in the list).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2807

#

2808

# Regular expressions use RE2

2809

# [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found

2810

# 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

2815

# `gs://<bucket>/<path>`. Trailing wildcard in the path is allowed.

2816

#

2817

# If the url ends in a trailing slash, the bucket or directory represented

2818

# by the url will be scanned non-recursively (content in sub-directories

2819

# will not be scanned). This means that `gs://mybucket/` is equivalent to

2820

# `gs://mybucket/*`, and `gs://mybucket/directory/` is equivalent to

2821

# `gs://mybucket/directory/*`.

2822

#

2823

# Exactly one of `url` or `regex_file_set` must be set.

2824

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2825

"sampleMethod": "A String",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2826

},

2827

"bigQueryOptions": { # Options defining BigQuery table and row identifiers. # BigQuery options.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2828

"sampleMethod": "A String",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2829

"tableReference": { # Message defining the location of a BigQuery table. A table is uniquely # Complete BigQuery table reference.

2830

# identified by its project_id, dataset_id, and table_name. Within a query

2831

# a table is often referenced with a string in the format of:

2832

# `<project_id>:<dataset_id>.<table_id>` or

2833

# `<project_id>.<dataset_id>.<table_id>`.

2834

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table.

2835

# If omitted, project ID is inferred from the API call.

2836

"datasetId": "A String", # Dataset ID of the table.

2837

"tableId": "A String", # Name of the table.

2838

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2839

"rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows

2840

# scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and

2841

# 100 means no limit. Defaults to 0. Only one of rows_limit and

2842

# rows_limit_percent can be specified. Cannot be used in conjunction with

2843

# TimespanConfig.

2844

"rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the

2845

# rest of the rows are omitted. If not set, or if set to 0, all rows will be

2846

# scanned. Only one of rows_limit and rows_limit_percent can be specified.

2847

# Cannot be used in conjunction with TimespanConfig.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2848

"identifyingFields": [ # Table fields that may uniquely identify a row within the table. When

2849

# `actions.saveFindings.outputConfig.table` is specified, the values of

2850

# columns specified here are available in the output table under

2851

# `location.content_locations.record_location.record_key.id_values`. Nested

2852

# fields such as `person.birthdate.year` are allowed.

2853

{ # General identifier of a data field in a storage service.

2854

"name": "A String", # Name describing the field.

2855

},

2856

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2857

"excludedFields": [ # References to fields excluded from scanning. This allows you to skip

2858

# inspection of entire columns which you know have no findings.

2859

{ # General identifier of a data field in a storage service.

2860

"name": "A String", # Name describing the field.

2861

},

2862

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2863

},

2864

"timespanConfig": { # Configuration of the timespan of the items to include in scanning.

2865

# Currently only supported when inspecting Google Cloud Storage and BigQuery.

2866

"timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items.

2867

# Used for data sources like Datastore and BigQuery.

2868

#

2869

# For BigQuery:

2870

# Required to filter out rows based on the given start and

2871

# end times. If not specified and the table was modified between the given

2872

# start and end times, the entire table will be scanned.

2873

# The valid data types of the timestamp field are: `INTEGER`, `DATE`,

2874

# `TIMESTAMP`, or `DATETIME` BigQuery column.

2875

#

2876

# For Datastore.

2877

# Valid data types of the timestamp field are: `TIMESTAMP`.

2878

# Datastore entity will be scanned if the timestamp property does not

2879

# exist or its value is empty or invalid.

2880

"name": "A String", # Name describing the field.

2881

},

2882

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out

2883

# a valid start_time to avoid scanning files that have not been modified

2884

# since the last time the JobTrigger executed. This will be based on the

2885

# time of the execution of the last run of the JobTrigger.

2886

"startTime": "A String", # Exclude files or rows older than this value.

2887

"endTime": "A String", # Exclude files or rows newer than this value.

2888

# If set to zero, no upper time limit is applied.

2889

},

2890

"datastoreOptions": { # Options defining a data set within Google Cloud Datastore. # Google Cloud Datastore options.

2891

"kind": { # A representation of a Datastore kind. # The kind to process.

2892

"name": "A String", # The name of the kind.

2893

},

2894

"partitionId": { # Datastore partition ID. # A partition ID identifies a grouping of entities. The grouping is always

2895

# by project and namespace, however the namespace ID may be empty.

2896

# A partition ID identifies a grouping of entities. The grouping is always

2897

# by project and namespace, however the namespace ID may be empty.

2898

#

2899

# A partition ID contains several dimensions:

2900

# project ID and namespace ID.

2901

"namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.

2902

"projectId": "A String", # The ID of the project to which the entities belong.

2903

},

2904

},

2905

"hybridOptions": { # Configuration to control jobs where the content being inspected is outside # Hybrid inspection options.

2906

# Early access feature is in a pre-release state and might change or have

2907

# limited support. For more information, see

2908

# https://cloud.google.com/products#product-launch-stages.

2909

# of Google Cloud Platform.

2910

"tableOptions": { # Instructions regarding the table content being inspected. # If the container is a table, additional information to make findings

2911

# meaningful such as the columns that are primary keys.

2912

"identifyingFields": [ # The columns that are the primary keys for table objects included in

2913

# ContentItem. A copy of this cell's value will stored alongside alongside

2914

# each finding so that the finding can be traced to the specific row it came

2915

# from. No more than 3 may be provided.

2916

{ # General identifier of a data field in a storage service.

2917

"name": "A String", # Name describing the field.

},

],

},

"requiredFindingLabelKeys": [ # These are labels that each inspection request must include within their

2922

# 'finding_labels' map. Request may contain others, but any missing one of

2923

# these will be rejected.

2924

#

2925

# Label keys must be between 1 and 63 characters long and must conform

2926

# to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.

2927

#

2928

# No more than 10 keys can be required.

2929

"A String",

2930

],

2931

"labels": { # To organize findings, these labels will be added to each finding.

2932

#

2933

# Label keys must be between 1 and 63 characters long and must conform

2934

# to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.

2935

#

2936

# Label values must be between 0 and 63 characters long and must conform

2937

# to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.

2938

#

2939

# No more than 10 labels can be associated with a given finding.

2940

#

2941

# Examples:

2942

# * `"environment" : "production"`

2943

# * `"pipeline" : "etl"`

2944

"a_key": "A String",

2945

},

2946

"description": "A String", # A short description of where the data is coming from. Will be stored once

2947

# in the job. 256 max length.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2948

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2949

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2950

"inspectConfig": { # Configuration description of the scanning process. # How and what to scan for.

2951

# When used with redactContent only info_types and min_likelihood are currently

2952

# used.

2953

"customInfoTypes": [ # CustomInfoTypes provided by the user. See

2954

# https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more.

2955

{ # Custom information type provided by the user. Used to find domain-specific

2956

# sensitive information configurable to the data in question.

2957

"dictionary": { # Custom information type based on a dictionary of words or phrases. This can # A list of phrases to detect as a CustomInfoType.

2958

# be used to match sensitive information specific to the data, such as a list

2959

# of employee IDs or job titles.

2960

#

2961

# Dictionary words are case-insensitive and all characters other than letters

2962

# and digits in the unicode [Basic Multilingual

2963

# Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane)

2964

# will be replaced with whitespace when scanning for matches, so the

2965

# dictionary phrase "Sam Johnson" will match all three phrases "sam johnson",

2966

# "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters

2967

# surrounding any match must be of a different type than the adjacent

2968

# characters within the word, so letters must be next to non-letters and

2969

# digits next to non-digits. For example, the dictionary word "jen" will

2970

# match the first three letters of the text "jen123" but will return no

2971

# matches for "jennifer".

2972

#

2973

# Dictionary words containing a large number of characters that are not

2974

# letters or digits may result in unexpected findings because such characters

2975

# are treated as whitespace. The

2976

# [limits](https://cloud.google.com/dlp/limits) page contains details about

2977

# the size limits of dictionaries. For dictionaries that do not fit within

2978

# these constraints, consider using `LargeCustomDictionaryConfig` in the

2979

# `StoredInfoType` API.

2980

"cloudStoragePath": { # Message representing a single file or path in Cloud Storage. # Newline-delimited file of words in Cloud Storage. Only a single file

2981

# is accepted.

2982

"path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage.

2983

# Example: gs://[BUCKET_NAME]/dictionary.txt

2984

},

2985

"wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for.

2986

"words": [ # Words or phrases defining the dictionary. The dictionary must contain

2987

# at least one phrase and every phrase must contain at least 2 characters

2988

# that are letters or digits. [required]

"A String",

],

},

},

"infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in

2994

# infoType, when the name matches one of existing infoTypes and that infoType

2995

# is specified in `InspectContent.info_types` field. Specifying the latter

2996

# adds findings to the one detected by the system. If built-in info type is

2997

# not specified in `InspectContent.info_types` list then the name is treated

2998

# as a custom info type.

2999

"name": "A String", # Name of the information type. Either a name of your choosing when

3000

# creating a CustomInfoType, or one of the names listed

3001

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

3002

# a built-in type. When sending Cloud DLP results to Data Catalog, infoType

3003

# names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

3004

},

3005

"likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be

3006

# altered by a detection rule if the finding meets the criteria specified by

3007

# the rule. Defaults to `VERY_LIKELY` if not specified.

3008

"detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType.

3009

# Rules are applied in order that they are specified. Not supported for the

3010

# `surrogate_type` CustomInfoType.

3011

{ # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a

3012

# `CustomInfoType` to alter behavior under certain circumstances, depending

3013

# on the specific details of the rule. Not supported for the `surrogate_type`

3014

# custom infoType.

3015

"hotwordRule": { # The rule that adjusts the likelihood of findings within a certain # Hotword-based detection rule.

3016

# proximity of hotwords.

3017

"proximity": { # Message for specifying a window around a finding to apply a detection # Proximity of the finding within which the entire hotword must reside.

3018

# The total length of the window cannot exceed 1000 characters. Note that

3019

# the finding itself will be included in the window, so that hotwords may

3020

# be used to match substrings of the finding itself. For example, the

3021

# certainty of a phone number regex "$\d{3}$ \d{3}-\d{4}" could be

3022

# adjusted upwards if the area code is known to be the local area code of

3023

# a company office using the hotword regex "$xxx$", where "xxx"

3024

# is the area code in question.

3025

# rule.

3026

"windowAfter": 42, # Number of characters after the finding to consider.

3027

"windowBefore": 42, # Number of characters before the finding to consider.

3028

},

3029

"likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as # Likelihood adjustment to apply to all matching findings.

3030

# part of a detection rule.

3031

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value.

3032

"relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of

3033

# levels. For example, if a finding would be `POSSIBLE` without the

3034

# detection rule and `relative_likelihood` is 1, then it is upgraded to

3035

# `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`.

3036

# Likelihood may never drop below `VERY_UNLIKELY` or exceed

3037

# `VERY_LIKELY`, so applying an adjustment of 1 followed by an

3038

# adjustment of -1 when base likelihood is `VERY_LIKELY` will result in

3039

# a final likelihood of `LIKELY`.

3040

},

3041

"hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword.

3042

"groupIndexes": [ # The index of the submatch to extract as findings. When not

3043

# specified, the entire match is returned. No more than 3 may be included.

3044

42,

3045

],

3046

"pattern": "A String", # Pattern defining the regular expression. Its syntax

3047

# (https://github.com/google/re2/wiki/Syntax) can be found under the

3048

# google/re2 repository on GitHub.

},

},

},

],

"surrogateType": { # Message for detecting output from deidentification transformations # Message for detecting output from deidentification transformations that

3054

# support reversing.

3055

# such as

3056

# [`CryptoReplaceFfxFpeConfig`](https://cloud.google.com/dlp/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig).

3057

# These types of transformations are

3058

# those that perform pseudonymization, thereby producing a "surrogate" as

3059

# output. This should be used in conjunction with a field on the

3060

# transformation such as `surrogate_info_type`. This CustomInfoType does

3061

# not support the use of `detection_rules`.

3062

},

3063

"regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType.

3064

"groupIndexes": [ # The index of the submatch to extract as findings. When not

3065

# specified, the entire match is returned. No more than 3 may be included.

3066

42,

3067

],

3068

"pattern": "A String", # Pattern defining the regular expression. Its syntax

3069

# (https://github.com/google/re2/wiki/Syntax) can be found under the

3070

# google/re2 repository on GitHub.

3071

},

3072

"storedType": { # A reference to a StoredInfoType to use with scanning. # Load an existing `StoredInfoType` resource for use in

3073

# `InspectDataSource`. Not currently supported in `InspectContent`.

3074

"name": "A String", # Resource name of the requested `StoredInfoType`, for example

3075

# `organizations/433245324/storedInfoTypes/432452342` or

3076

# `projects/project-id/storedInfoTypes/432452342`.

3077

"createTime": "A String", # Timestamp indicating when the version of the `StoredInfoType` used for

3078

# inspection was created. Output-only field, populated by the system.

3079

},

3080

"exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding

3081

# to be returned. It still can be used for rules matching.

3082

},

3083

],

3084

"minLikelihood": "A String", # Only returns findings equal or above this threshold. The default is

3085

# POSSIBLE.

3086

# See https://cloud.google.com/dlp/docs/likelihood to learn more.

3087

"limits": { # Configuration to control the number of findings returned. # Configuration to control the number of findings returned.

3088

"maxFindingsPerRequest": 42, # Max number of findings that will be returned per request/job.

3089

# When set within `InspectContentRequest`, the maximum returned is 2000

3090

# regardless if this is set higher.

3091

"maxFindingsPerInfoType": [ # Configuration of findings limit given for specified infoTypes.

3092

{ # Max findings configuration per infoType, per content item or long

3093

# running DlpJob.

3094

"infoType": { # Type of information detected by the API. # Type of information the findings limit applies to. Only one limit per

3095

# info_type should be provided. If InfoTypeLimit does not have an

3096

# info_type, the DLP API applies the limit against all info_types that

3097

# are found but not specified in another InfoTypeLimit.

3098

"name": "A String", # Name of the information type. Either a name of your choosing when

3099

# creating a CustomInfoType, or one of the names listed

3100

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

3101

# a built-in type. When sending Cloud DLP results to Data Catalog, infoType

3102

# names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

3103

},

3104

"maxFindings": 42, # Max findings limit for the given infoType.

3105

},

3106

],

3107

"maxFindingsPerItem": 42, # Max number of findings that will be returned for each item scanned.

3108

# When set within `InspectJobConfig`,

3109

# the maximum returned is 2000 regardless if this is set higher.

3110

# When set within `InspectContentRequest`, this field is ignored.

3111

},

3112

"excludeInfoTypes": True or False, # When true, excludes type information of the findings.

3113

"includeQuote": True or False, # When true, a contextual quote from the data that triggered a finding is

3114

# included in the response; see Finding.quote.

3115

"ruleSet": [ # Set of rules to apply to the findings for this InspectConfig.

3116

# Exclusion rules, contained in the set are executed in the end, other

3117

# rules are executed in the order they are specified for each info type.

3118

{ # Rule set for modifying a set of infoTypes to alter behavior under certain

3119

# circumstances, depending on the specific details of the rules within the set.

3120

"infoTypes": [ # List of infoTypes this rule set is applied to.

3121

{ # Type of information detected by the API.

3122

"name": "A String", # Name of the information type. Either a name of your choosing when

3123

# creating a CustomInfoType, or one of the names listed

3124

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

3125

# a built-in type. When sending Cloud DLP results to Data Catalog, infoType

3126

# names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

3127

},

3128

],

3129

"rules": [ # Set of rules to be applied to infoTypes. The rules are applied in order.

3130

{ # A single inspection rule to be applied to infoTypes, specified in

3131

# `InspectionRuleSet`.

3132

"hotwordRule": { # The rule that adjusts the likelihood of findings within a certain # Hotword-based detection rule.

3133

# proximity of hotwords.

3134

"proximity": { # Message for specifying a window around a finding to apply a detection # Proximity of the finding within which the entire hotword must reside.

3135

# The total length of the window cannot exceed 1000 characters. Note that

3136

# the finding itself will be included in the window, so that hotwords may

3137

# be used to match substrings of the finding itself. For example, the

3138

# certainty of a phone number regex "$\d{3}$ \d{3}-\d{4}" could be

3139

# adjusted upwards if the area code is known to be the local area code of

3140

# a company office using the hotword regex "$xxx$", where "xxx"

3141

# is the area code in question.

3142

# rule.

3143

"windowAfter": 42, # Number of characters after the finding to consider.

3144

"windowBefore": 42, # Number of characters before the finding to consider.

3145

},

3146

"likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as # Likelihood adjustment to apply to all matching findings.

3147

# part of a detection rule.

3148

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value.

3149

"relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of

3150

# levels. For example, if a finding would be `POSSIBLE` without the

3151

# detection rule and `relative_likelihood` is 1, then it is upgraded to

3152

# `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`.

3153

# Likelihood may never drop below `VERY_UNLIKELY` or exceed

3154

# `VERY_LIKELY`, so applying an adjustment of 1 followed by an

3155

# adjustment of -1 when base likelihood is `VERY_LIKELY` will result in

3156

# a final likelihood of `LIKELY`.

3157

},

3158

"hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword.

3159

"groupIndexes": [ # The index of the submatch to extract as findings. When not

3160

# specified, the entire match is returned. No more than 3 may be included.

3161

42,

3162

],

3163

"pattern": "A String", # Pattern defining the regular expression. Its syntax

3164

# (https://github.com/google/re2/wiki/Syntax) can be found under the

3165

# google/re2 repository on GitHub.

3166

},

3167

},

3168

"exclusionRule": { # The rule that specifies conditions when findings of infoTypes specified in # Exclusion rule.

3169

# `InspectionRuleSet` are removed from results.

3170

"matchingType": "A String", # How the rule is applied, see MatchingType documentation for details.

3171

"dictionary": { # Custom information type based on a dictionary of words or phrases. This can # Dictionary which defines the rule.

3172

# be used to match sensitive information specific to the data, such as a list

3173

# of employee IDs or job titles.

3174

#

3175

# Dictionary words are case-insensitive and all characters other than letters

3176

# and digits in the unicode [Basic Multilingual

3177

# Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane)

3178

# will be replaced with whitespace when scanning for matches, so the

3179

# dictionary phrase "Sam Johnson" will match all three phrases "sam johnson",

3180

# "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters

3181

# surrounding any match must be of a different type than the adjacent

3182

# characters within the word, so letters must be next to non-letters and

3183

# digits next to non-digits. For example, the dictionary word "jen" will

3184

# match the first three letters of the text "jen123" but will return no

3185

# matches for "jennifer".

3186

#

3187

# Dictionary words containing a large number of characters that are not

3188

# letters or digits may result in unexpected findings because such characters

3189

# are treated as whitespace. The

3190

# [limits](https://cloud.google.com/dlp/limits) page contains details about

3191

# the size limits of dictionaries. For dictionaries that do not fit within

3192

# these constraints, consider using `LargeCustomDictionaryConfig` in the

3193

# `StoredInfoType` API.

3194

"cloudStoragePath": { # Message representing a single file or path in Cloud Storage. # Newline-delimited file of words in Cloud Storage. Only a single file

3195

# is accepted.

3196

"path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage.

3197

# Example: gs://[BUCKET_NAME]/dictionary.txt

3198

},

3199

"wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for.

3200

"words": [ # Words or phrases defining the dictionary. The dictionary must contain

3201

# at least one phrase and every phrase must contain at least 2 characters

3202

# that are letters or digits. [required]

"A String",

],

},

},

"excludeInfoTypes": { # List of exclude infoTypes. # Set of infoTypes for which findings would affect this rule.

3208

"infoTypes": [ # InfoType list in ExclusionRule rule drops a finding when it overlaps or

3209

# contained within with a finding of an infoType from this list. For

3210

# example, for `InspectionRuleSet.info_types` containing "PHONE_NUMBER"` and

3211

# `exclusion_rule` containing `exclude_info_types.info_types` with

3212

# "EMAIL_ADDRESS" the phone number findings are dropped if they overlap

3213

# with EMAIL_ADDRESS finding.

3214

# That leads to "555-222-2222@example.org" to generate only a single

3215

# finding, namely email address.

3216

{ # Type of information detected by the API.

3217

"name": "A String", # Name of the information type. Either a name of your choosing when

3218

# creating a CustomInfoType, or one of the names listed

3219

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

3220

# a built-in type. When sending Cloud DLP results to Data Catalog, infoType

3221

# names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

},

],

},

"regex": { # Message defining a custom regular expression. # Regular expression which defines the rule.

3226

"groupIndexes": [ # The index of the submatch to extract as findings. When not

3227

# specified, the entire match is returned. No more than 3 may be included.

3228

42,

3229

],

3230

"pattern": "A String", # Pattern defining the regular expression. Its syntax

3231

# (https://github.com/google/re2/wiki/Syntax) can be found under the

3232

# google/re2 repository on GitHub.

},

},

},

],

},

],

"contentOptions": [ # List of options defining data content to scan.

3240

# If empty, text, images, and other content will be included.

3241

"A String",

3242

],

3243

"infoTypes": [ # Restricts what info_types to look for. The values must correspond to

3244

# InfoType values returned by ListInfoTypes or listed at

3245

# https://cloud.google.com/dlp/docs/infotypes-reference.

3246

#

3247

# When no InfoTypes or CustomInfoTypes are specified in a request, the

3248

# system may automatically choose what detectors to run. By default this may

3249

# be all types, but may change over time as detectors are updated.

3250

#

3251

# If you need precise control and predictability as to what detectors are

3252

# run you should specify specific InfoTypes listed in the reference,

3253

# otherwise a default list will be used, which may change over time.

3254

{ # Type of information detected by the API.

3255

"name": "A String", # Name of the information type. Either a name of your choosing when

3256

# creating a CustomInfoType, or one of the names listed

3257

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

3258

# a built-in type. When sending Cloud DLP results to Data Catalog, infoType

3259

# names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

3260

},

3261

],

3262

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3263

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3264

"name": "A String", # Unique resource name for the triggeredJob, assigned by the service when the

3265

# triggeredJob is created, for example

3266

# `projects/dlp-test-project/jobTriggers/53234423`.

3267

"displayName": "A String", # Display name (max 100 chars)

3268

"lastRunTime": "A String", # Output only. The timestamp of the last time this trigger executed.

3269

"createTime": "A String", # Output only. The creation timestamp of a triggeredJob.

3270

"description": "A String", # User provided description (max 256 chars)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="delete">delete(name, x__xgafv=None)</code>

3276

<pre>Deletes a job trigger.

3277

See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.

3278

3279

Args:

3280

name: string, Required. Resource name of the project and the triggeredJob, for example

3281

`projects/dlp-test-project/jobTriggers/53234423`. (required)

3282

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3289

3290

{ # A generic empty message that you can re-use to avoid defining duplicated

3291

# empty messages in your APIs. A typical example is to use it as the request

3292

# or the response type of an API method. For instance:

3293

#

3294

# service Foo {

3295

# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

3296

# }

3297

#

3298

# The JSON representation for `Empty` is empty JSON object `{}`.

}</pre>

</div>

<code class="details" id="get">get(name, x__xgafv=None)</code>

3304

<pre>Gets a job trigger.

3305

See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.

3306

3307

Args:

3308

name: string, Required. Resource name of the project and the triggeredJob, for example

3309

`projects/dlp-test-project/jobTriggers/53234423`. (required)

3310

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3317

3318

{ # Contains a configuration to make dlp api calls on a repeating basis.

3319

# See https://cloud.google.com/dlp/docs/concepts-job-triggers to learn more.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3320

"status": "A String", # Required. A status for this trigger.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3321

"triggers": [ # A list of triggers which will be OR'ed together. Only one in the list

3322

# needs to trigger for a job to be started. The list may contain only

3323

# a single Schedule trigger and must have at least one object.

3324

{ # What event needs to occur for a new job to be started.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3325

"manual": { # Job trigger option for hybrid jobs. Jobs must be manually created # For use with hybrid jobs. Jobs must be manually created and finished.

3326

# Early access feature is in a pre-release state and might change or have

3327

# limited support. For more information, see

3328

# https://cloud.google.com/products#product-launch-stages.

3329

# and finished.

3330

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3331

"schedule": { # Schedule for triggeredJobs. # Create a job on a repeating basis based on the elapse of time.

3332

"recurrencePeriodDuration": "A String", # With this option a job is started a regular periodic basis. For

3333

# example: every day (86400 seconds).

3334

#

3335

# A scheduled start time will be skipped if the previous

3336

# execution has not ended when its scheduled time occurs.

3337

#

3338

# This value must be set to a time duration greater than or equal

3339

# to 1 day and can be no longer than 60 days.

3340

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3341

},

3342

],

3343

"errors": [ # Output only. A stream of errors encountered when the trigger was activated. Repeated

3344

# errors may result in the JobTrigger automatically being paused.

3345

# Will return the last 100 errors. Whenever the JobTrigger is modified

3346

# this list will be cleared.

3347

{ # Details information about an error encountered during job execution or

3348

# the results of an unsuccessful activation of the JobTrigger.

3349

"timestamps": [ # The times the error occurred.

3350

"A String",

3351

],

3352

"details": { # The `Status` type defines a logical error model that is suitable for # Detailed error codes and messages.

3353

# different programming environments, including REST APIs and RPC APIs. It is

3354

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

3355

# three pieces of data: error code, error message, and error details.

3356

#

3357

# You can find out more about this error model and how to work with it in the

3358

# [API Design Guide](https://cloud.google.com/apis/design/errors).

3359

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

3360

"details": [ # A list of messages that carry the error details. There is a common set of

3361

# message types for APIs to use.

3362

{

3363

"a_key": "", # Properties of the object. Contains field @type with type URL.

3364

},

3365

],

3366

"message": "A String", # A developer-facing error message, which should be in English. Any

3367

# user-facing error message should be localized and sent in the

3368

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3369

},

3370

},

3371

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3372

"updateTime": "A String", # Output only. The last update timestamp of a triggeredJob.

3373

"inspectJob": { # Controls what and how to inspect for findings. # For inspect jobs, a snapshot of the configuration.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3374

"inspectTemplateName": "A String", # If provided, will be used as the default for all values in InspectConfig.

3375

# `inspect_config` will be merged into the values persisted as part of the

3376

# template.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3377

"actions": [ # Actions to execute at the completion of the job.

3378

{ # A task to execute on the completion of a job.

3379

# See https://cloud.google.com/dlp/docs/concepts-actions to learn more.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3380

"publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This # Enable Stackdriver metric dlp.googleapis.com/finding_count.

3381

# will publish a metric to stack driver on each infotype requested and

3382

# how many findings were found for it. CustomDetectors will be bucketed

3383

# as 'Custom' under the Stackdriver label 'info_type'.

3384

},

3385

"publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Cloud Data Catalog. Labels summarizing the # Publish findings to Cloud Datahub.

3386

# results of the DlpJob will be applied to the entry for the resource scanned

3387

# in Cloud Data Catalog. Any labels previously written by another DlpJob will

3388

# be deleted. InfoType naming patterns are strictly enforced when using this

3389

# feature. Note that the findings will be persisted in Cloud Data Catalog

3390

# storage and are governed by Data Catalog service-specific policy, see

3391

# https://cloud.google.com/terms/service-terms

3392

# Only a single instance of this action can be specified and only allowed if

3393

# all resources being scanned are BigQuery tables.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3394

# Compatible with: Inspect

3395

},

3396

"jobNotificationEmails": { # Enable email notification to project owners and editors on jobs's # Enable email notification for project owners and editors on job's

3397

# completion/failure.

3398

# completion/failure.

3399

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3400

"pubSub": { # Publish a message into given Pub/Sub topic when DlpJob has completed. The # Publish a notification to a pubsub topic.

3401

# message contains a single field, `DlpJobName`, which is equal to the

3402

# finished job's

3403

# [`DlpJob.name`](https://cloud.google.com/dlp/docs/reference/rest/v2/projects.dlpJobs#DlpJob).

3404

# Compatible with: Inspect, Risk

3405

"topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given

3406

# publishing access rights to the DLP API service account executing

3407

# the long running DlpJob sending the notifications.

3408

# Format is projects/{project}/topics/{topic}.

3409

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3410

"saveFindings": { # If set, the detailed findings will be persisted to the specified # Save resulting findings in a provided location.

3411

# OutputStorageConfig. Only a single instance of this action can be

3412

# specified.

3413

# Compatible with: Inspect, Risk

3414

"outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3415

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only

3416

# used for Inspect and must be unspecified for Risk jobs. Columns are derived

3417

# from the `Finding` object. If appending to an existing table, any columns

3418

# from the predefined schema that are missing will be added. No columns in

3419

# the existing table will be deleted.

3420

#

3421

# If unspecified, then all available columns will be used for a new table or

3422

# an (existing) table with no schema, and no changes will be made to an

3423

# existing table that has a schema.

3424

# Only for use with external storage.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3425

"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

3426

# dataset. If table_id is not set a new one will be generated

3427

# for you with the following format:

3428

# dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific timezone will be used for

3429

# generating the date details.

3430

#

3431

# For Inspect, each column in an existing output table must have the same

3432

# name, type, and mode of a field in the `Finding` object.

3433

#

3434

# For Risk, an existing output table should be the output of a previous

3435

# Risk analysis job run on the same source table, with the same privacy

3436

# metric and quasi-identifiers. Risk jobs that analyze the same table but

3437

# compute a different privacy metric, or use different sets of

3438

# quasi-identifiers, cannot store their results in the same table.

3439

# identified by its project_id, dataset_id, and table_name. Within a query

3440

# a table is often referenced with a string in the format of:

3441

# `<project_id>:<dataset_id>.<table_id>` or

3442

# `<project_id>.<dataset_id>.<table_id>`.

3443

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table.

3444

# If omitted, project ID is inferred from the API call.

3445

"datasetId": "A String", # Dataset ID of the table.

3446

"tableId": "A String", # Name of the table.

3447

},

3448

},

3449

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3450

"publishSummaryToCscc": { # Publish the result summary of a DlpJob to the Cloud Security # Publish summary to Cloud Security Command Center (Alpha).

3451

# Command Center (CSCC Alpha).

3452

# This action is only available for projects which are parts of

3453

# an organization and whitelisted for the alpha Cloud Security Command

3454

# Center.

3455

# The action will publish count of finding instances and their info types.

3456

# The summary of findings will be persisted in CSCC and are governed by CSCC

3457

# service-specific policy, see https://cloud.google.com/terms/service-terms

3458

# Only a single instance of this action can be specified.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3459

# Compatible with: Inspect

3460

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3461

},

3462

],

3463

"storageConfig": { # Shared message indicating Cloud storage type. # The data to scan.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3464

"cloudStorageOptions": { # Options defining a file or a set of files within a Google Cloud Storage # Google Cloud Storage options.

3465

# bucket.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3466

"bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The

3467

# number of bytes scanned is rounded down. Must be between 0 and 100,

3468

# inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one

3469

# of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.

3470

"fileTypes": [ # List of file type groups to include in the scan.

3471

# If empty, all files are scanned and available data format processors

3472

# are applied. In addition, the binary content of the selected files

3473

# is always scanned as well.

3474

# Images are scanned only as binary if the specified region

3475

# does not support image inspection and no file_types were specified.

3476

# Image inspection is restricted to 'global', 'us', 'asia', and 'europe'.

3477

"A String",

3478

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3479

"bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger

3480

# than this value then the rest of the bytes are omitted. Only one

3481

# of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3482

"filesLimitPercent": 42, # Limits the number of files to scan to this percentage of the input FileSet.

3483

# Number of files scanned is rounded down. Must be between 0 and 100,

3484

# inclusively. Both 0 and 100 means no limit. Defaults to 0.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3485

"fileSet": { # Set of files to scan. # The set of one or more files to scan.

3486

"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

3487

# `regex_file_set` must be set.

3488

# expressions are used to allow fine-grained control over which files in the

3489

# bucket to include.

3490

#

3491

# Included files are those that match at least one item in `include_regex` and

3492

# do not match any items in `exclude_regex`. Note that a file that matches

3493

# items from both lists will _not_ be included. For a match to occur, the

3494

# entire file path (i.e., everything in the url after the bucket name) must

3495

# match the regular expression.

3496

#

3497

# For example, given the input `{bucket_name: "mybucket", include_regex:

3498

# ["directory1/.*"], exclude_regex:

3499

# ["directory1/excluded.*"]}`:

3500

#

3501

# * `gs://mybucket/directory1/myfile` will be included

3502

# * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches

3503

# across `/`)

3504

# * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the

3505

# full path doesn't match any items in `include_regex`)

3506

# * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path

3507

# matches an item in `exclude_regex`)

3508

#

3509

# If `include_regex` is left empty, it will match all files by default

3510

# (this is equivalent to setting `include_regex: [".*"]`).

3511

#

3512

# Some other common use cases:

3513

#

3514

# * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all

3515

# files in `mybucket` except for .pdf files

3516

# * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will

3517

# include all files directly under `gs://mybucket/directory/`, without matching

3518

# across `/`

3519

"bucketName": "A String", # The name of a Cloud Storage bucket. Required.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3520

"excludeRegex": [ # A list of regular expressions matching file paths to exclude. All files in

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3521

# the bucket that match at least one of these regular expressions will be

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3522

# excluded from the scan.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3523

#

3524

# Regular expressions use RE2

3525

# [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found

3526

# under the google/re2 repository on GitHub.

3527

"A String",

3528

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3529

"includeRegex": [ # A list of regular expressions matching file paths to include. All files in

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3530

# the bucket that match at least one of these regular expressions will be

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3531

# included in the set of files, except for those that also match an item in

3532

# `exclude_regex`. Leaving this field empty will match all files by default

3533

# (this is equivalent to including `.*` in the list).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3534

#

3535

# Regular expressions use RE2

3536

# [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found

3537

# 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

3542

# `gs://<bucket>/<path>`. Trailing wildcard in the path is allowed.

3543

#

3544

# If the url ends in a trailing slash, the bucket or directory represented

3545

# by the url will be scanned non-recursively (content in sub-directories

3546

# will not be scanned). This means that `gs://mybucket/` is equivalent to

3547

# `gs://mybucket/*`, and `gs://mybucket/directory/` is equivalent to

3548

# `gs://mybucket/directory/*`.

3549

#

3550

# Exactly one of `url` or `regex_file_set` must be set.

3551

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3552

"sampleMethod": "A String",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3553

},

3554

"bigQueryOptions": { # Options defining BigQuery table and row identifiers. # BigQuery options.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3555

"sampleMethod": "A String",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3556

"tableReference": { # Message defining the location of a BigQuery table. A table is uniquely # Complete BigQuery table reference.

3557

# identified by its project_id, dataset_id, and table_name. Within a query

3558

# a table is often referenced with a string in the format of:

3559

# `<project_id>:<dataset_id>.<table_id>` or

3560

# `<project_id>.<dataset_id>.<table_id>`.

3561

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table.

3562

# If omitted, project ID is inferred from the API call.

3563

"datasetId": "A String", # Dataset ID of the table.

3564

"tableId": "A String", # Name of the table.

3565

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3566

"rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows

3567

# scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and

3568

# 100 means no limit. Defaults to 0. Only one of rows_limit and

3569

# rows_limit_percent can be specified. Cannot be used in conjunction with

3570

# TimespanConfig.

3571

"rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the

3572

# rest of the rows are omitted. If not set, or if set to 0, all rows will be

3573

# scanned. Only one of rows_limit and rows_limit_percent can be specified.

3574

# Cannot be used in conjunction with TimespanConfig.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3575

"identifyingFields": [ # Table fields that may uniquely identify a row within the table. When

3576

# `actions.saveFindings.outputConfig.table` is specified, the values of

3577

# columns specified here are available in the output table under

3578

# `location.content_locations.record_location.record_key.id_values`. Nested

3579

# fields such as `person.birthdate.year` are allowed.

3580

{ # General identifier of a data field in a storage service.

3581

"name": "A String", # Name describing the field.

3582

},

3583

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3584

"excludedFields": [ # References to fields excluded from scanning. This allows you to skip

3585

# inspection of entire columns which you know have no findings.

3586

{ # General identifier of a data field in a storage service.

3587

"name": "A String", # Name describing the field.

3588

},

3589

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3590

},

3591

"timespanConfig": { # Configuration of the timespan of the items to include in scanning.

3592

# Currently only supported when inspecting Google Cloud Storage and BigQuery.

3593

"timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items.

3594

# Used for data sources like Datastore and BigQuery.

3595

#

3596

# For BigQuery:

3597

# Required to filter out rows based on the given start and

3598

# end times. If not specified and the table was modified between the given

3599

# start and end times, the entire table will be scanned.

3600

# The valid data types of the timestamp field are: `INTEGER`, `DATE`,

3601

# `TIMESTAMP`, or `DATETIME` BigQuery column.

3602

#

3603

# For Datastore.

3604

# Valid data types of the timestamp field are: `TIMESTAMP`.

3605

# Datastore entity will be scanned if the timestamp property does not

3606

# exist or its value is empty or invalid.

3607

"name": "A String", # Name describing the field.

3608

},

3609

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out

3610

# a valid start_time to avoid scanning files that have not been modified

3611

# since the last time the JobTrigger executed. This will be based on the

3612

# time of the execution of the last run of the JobTrigger.

3613

"startTime": "A String", # Exclude files or rows older than this value.

3614

"endTime": "A String", # Exclude files or rows newer than this value.

3615

# If set to zero, no upper time limit is applied.

3616

},

3617

"datastoreOptions": { # Options defining a data set within Google Cloud Datastore. # Google Cloud Datastore options.

3618

"kind": { # A representation of a Datastore kind. # The kind to process.

3619

"name": "A String", # The name of the kind.

3620

},

3621

"partitionId": { # Datastore partition ID. # A partition ID identifies a grouping of entities. The grouping is always

3622

# by project and namespace, however the namespace ID may be empty.

3623

# A partition ID identifies a grouping of entities. The grouping is always

3624

# by project and namespace, however the namespace ID may be empty.

3625

#

3626

# A partition ID contains several dimensions:

3627

# project ID and namespace ID.

3628

"namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.

3629

"projectId": "A String", # The ID of the project to which the entities belong.

3630

},

3631

},

3632

"hybridOptions": { # Configuration to control jobs where the content being inspected is outside # Hybrid inspection options.

3633

# Early access feature is in a pre-release state and might change or have

3634

# limited support. For more information, see

3635

# https://cloud.google.com/products#product-launch-stages.

3636

# of Google Cloud Platform.

3637

"tableOptions": { # Instructions regarding the table content being inspected. # If the container is a table, additional information to make findings

3638

# meaningful such as the columns that are primary keys.

3639

"identifyingFields": [ # The columns that are the primary keys for table objects included in

3640

# ContentItem. A copy of this cell's value will stored alongside alongside

3641

# each finding so that the finding can be traced to the specific row it came

3642

# from. No more than 3 may be provided.

3643

{ # General identifier of a data field in a storage service.

3644

"name": "A String", # Name describing the field.

},

],

},

"requiredFindingLabelKeys": [ # These are labels that each inspection request must include within their

3649

# 'finding_labels' map. Request may contain others, but any missing one of

3650

# these will be rejected.

3651

#

3652

# Label keys must be between 1 and 63 characters long and must conform

3653

# to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.

3654

#

3655

# No more than 10 keys can be required.

3656

"A String",

3657

],

3658

"labels": { # To organize findings, these labels will be added to each finding.

3659

#

3660

# Label keys must be between 1 and 63 characters long and must conform

3661

# to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.

3662

#

3663

# Label values must be between 0 and 63 characters long and must conform

3664

# to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.

3665

#

3666

# No more than 10 labels can be associated with a given finding.

3667

#

3668

# Examples:

3669

# * `"environment" : "production"`

3670

# * `"pipeline" : "etl"`

3671

"a_key": "A String",

3672

},

3673

"description": "A String", # A short description of where the data is coming from. Will be stored once

3674

# in the job. 256 max length.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3675

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3676

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3677

"inspectConfig": { # Configuration description of the scanning process. # How and what to scan for.

3678

# When used with redactContent only info_types and min_likelihood are currently

3679

# used.

3680

"customInfoTypes": [ # CustomInfoTypes provided by the user. See

3681

# https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more.

3682

{ # Custom information type provided by the user. Used to find domain-specific

3683

# sensitive information configurable to the data in question.

3684

"dictionary": { # Custom information type based on a dictionary of words or phrases. This can # A list of phrases to detect as a CustomInfoType.

3685

# be used to match sensitive information specific to the data, such as a list

3686

# of employee IDs or job titles.

3687

#

3688

# Dictionary words are case-insensitive and all characters other than letters

3689

# and digits in the unicode [Basic Multilingual

3690

# Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane)

3691

# will be replaced with whitespace when scanning for matches, so the

3692

# dictionary phrase "Sam Johnson" will match all three phrases "sam johnson",

3693

# "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters

3694

# surrounding any match must be of a different type than the adjacent

3695

# characters within the word, so letters must be next to non-letters and

3696

# digits next to non-digits. For example, the dictionary word "jen" will

3697

# match the first three letters of the text "jen123" but will return no

3698

# matches for "jennifer".

3699

#

3700

# Dictionary words containing a large number of characters that are not

3701

# letters or digits may result in unexpected findings because such characters

3702

# are treated as whitespace. The

3703

# [limits](https://cloud.google.com/dlp/limits) page contains details about

3704

# the size limits of dictionaries. For dictionaries that do not fit within

3705

# these constraints, consider using `LargeCustomDictionaryConfig` in the

3706

# `StoredInfoType` API.

3707

"cloudStoragePath": { # Message representing a single file or path in Cloud Storage. # Newline-delimited file of words in Cloud Storage. Only a single file

3708

# is accepted.

3709

"path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage.

3710

# Example: gs://[BUCKET_NAME]/dictionary.txt

3711

},

3712

"wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for.

3713

"words": [ # Words or phrases defining the dictionary. The dictionary must contain

3714

# at least one phrase and every phrase must contain at least 2 characters

3715

# that are letters or digits. [required]

"A String",

],

},

},

"infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in

3721

# infoType, when the name matches one of existing infoTypes and that infoType

3722

# is specified in `InspectContent.info_types` field. Specifying the latter

3723

# adds findings to the one detected by the system. If built-in info type is

3724

# not specified in `InspectContent.info_types` list then the name is treated

3725

# as a custom info type.

3726

"name": "A String", # Name of the information type. Either a name of your choosing when

3727

# creating a CustomInfoType, or one of the names listed

3728

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

3729

# a built-in type. When sending Cloud DLP results to Data Catalog, infoType

3730

# names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

3731

},

3732

"likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be

3733

# altered by a detection rule if the finding meets the criteria specified by

3734

# the rule. Defaults to `VERY_LIKELY` if not specified.

3735

"detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType.

3736

# Rules are applied in order that they are specified. Not supported for the

3737

# `surrogate_type` CustomInfoType.

3738

{ # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a

3739

# `CustomInfoType` to alter behavior under certain circumstances, depending

3740

# on the specific details of the rule. Not supported for the `surrogate_type`

3741

# custom infoType.

3742

"hotwordRule": { # The rule that adjusts the likelihood of findings within a certain # Hotword-based detection rule.

3743

# proximity of hotwords.

3744

"proximity": { # Message for specifying a window around a finding to apply a detection # Proximity of the finding within which the entire hotword must reside.

3745

# The total length of the window cannot exceed 1000 characters. Note that

3746

# the finding itself will be included in the window, so that hotwords may

3747

# be used to match substrings of the finding itself. For example, the

3748

# certainty of a phone number regex "$\d{3}$ \d{3}-\d{4}" could be

3749

# adjusted upwards if the area code is known to be the local area code of

3750

# a company office using the hotword regex "$xxx$", where "xxx"

3751

# is the area code in question.

3752

# rule.

3753

"windowAfter": 42, # Number of characters after the finding to consider.

3754

"windowBefore": 42, # Number of characters before the finding to consider.

3755

},

3756

"likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as # Likelihood adjustment to apply to all matching findings.

3757

# part of a detection rule.

3758

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value.

3759

"relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of

3760

# levels. For example, if a finding would be `POSSIBLE` without the

3761

# detection rule and `relative_likelihood` is 1, then it is upgraded to

3762

# `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`.

3763

# Likelihood may never drop below `VERY_UNLIKELY` or exceed

3764

# `VERY_LIKELY`, so applying an adjustment of 1 followed by an

3765

# adjustment of -1 when base likelihood is `VERY_LIKELY` will result in

3766

# a final likelihood of `LIKELY`.

3767

},

3768

"hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword.

3769

"groupIndexes": [ # The index of the submatch to extract as findings. When not

3770

# specified, the entire match is returned. No more than 3 may be included.

3771

42,

3772

],

3773

"pattern": "A String", # Pattern defining the regular expression. Its syntax

3774

# (https://github.com/google/re2/wiki/Syntax) can be found under the

3775

# google/re2 repository on GitHub.

},

},

},

],

"surrogateType": { # Message for detecting output from deidentification transformations # Message for detecting output from deidentification transformations that

3781

# support reversing.

3782

# such as

3783

# [`CryptoReplaceFfxFpeConfig`](https://cloud.google.com/dlp/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig).

3784

# These types of transformations are

3785

# those that perform pseudonymization, thereby producing a "surrogate" as

3786

# output. This should be used in conjunction with a field on the

3787

# transformation such as `surrogate_info_type`. This CustomInfoType does

3788

# not support the use of `detection_rules`.

3789

},

3790

"regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType.

3791

"groupIndexes": [ # The index of the submatch to extract as findings. When not

3792

# specified, the entire match is returned. No more than 3 may be included.

3793

42,

3794

],

3795

"pattern": "A String", # Pattern defining the regular expression. Its syntax

3796

# (https://github.com/google/re2/wiki/Syntax) can be found under the

3797

# google/re2 repository on GitHub.

3798

},

3799

"storedType": { # A reference to a StoredInfoType to use with scanning. # Load an existing `StoredInfoType` resource for use in

3800

# `InspectDataSource`. Not currently supported in `InspectContent`.

3801

"name": "A String", # Resource name of the requested `StoredInfoType`, for example

3802

# `organizations/433245324/storedInfoTypes/432452342` or

3803

# `projects/project-id/storedInfoTypes/432452342`.

3804

"createTime": "A String", # Timestamp indicating when the version of the `StoredInfoType` used for

3805

# inspection was created. Output-only field, populated by the system.

3806

},

3807

"exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding

3808

# to be returned. It still can be used for rules matching.

3809

},

3810

],

3811

"minLikelihood": "A String", # Only returns findings equal or above this threshold. The default is

3812

# POSSIBLE.

3813

# See https://cloud.google.com/dlp/docs/likelihood to learn more.

3814

"limits": { # Configuration to control the number of findings returned. # Configuration to control the number of findings returned.

3815

"maxFindingsPerRequest": 42, # Max number of findings that will be returned per request/job.

3816

# When set within `InspectContentRequest`, the maximum returned is 2000

3817

# regardless if this is set higher.

3818

"maxFindingsPerInfoType": [ # Configuration of findings limit given for specified infoTypes.

3819

{ # Max findings configuration per infoType, per content item or long

3820

# running DlpJob.

3821

"infoType": { # Type of information detected by the API. # Type of information the findings limit applies to. Only one limit per

3822

# info_type should be provided. If InfoTypeLimit does not have an

3823

# info_type, the DLP API applies the limit against all info_types that

3824

# are found but not specified in another InfoTypeLimit.

3825

"name": "A String", # Name of the information type. Either a name of your choosing when

3826

# creating a CustomInfoType, or one of the names listed

3827

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

3828

# a built-in type. When sending Cloud DLP results to Data Catalog, infoType

3829

# names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

3830

},

3831

"maxFindings": 42, # Max findings limit for the given infoType.

3832

},

3833

],

3834

"maxFindingsPerItem": 42, # Max number of findings that will be returned for each item scanned.

3835

# When set within `InspectJobConfig`,

3836

# the maximum returned is 2000 regardless if this is set higher.

3837

# When set within `InspectContentRequest`, this field is ignored.

3838

},

3839

"excludeInfoTypes": True or False, # When true, excludes type information of the findings.

3840

"includeQuote": True or False, # When true, a contextual quote from the data that triggered a finding is

3841

# included in the response; see Finding.quote.

3842

"ruleSet": [ # Set of rules to apply to the findings for this InspectConfig.

3843

# Exclusion rules, contained in the set are executed in the end, other

3844

# rules are executed in the order they are specified for each info type.

3845

{ # Rule set for modifying a set of infoTypes to alter behavior under certain

3846

# circumstances, depending on the specific details of the rules within the set.

3847

"infoTypes": [ # List of infoTypes this rule set is applied to.

3848

{ # Type of information detected by the API.

3849

"name": "A String", # Name of the information type. Either a name of your choosing when

3850

# creating a CustomInfoType, or one of the names listed

3851

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

3852

# a built-in type. When sending Cloud DLP results to Data Catalog, infoType

3853

# names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

3854

},

3855

],

3856

"rules": [ # Set of rules to be applied to infoTypes. The rules are applied in order.

3857

{ # A single inspection rule to be applied to infoTypes, specified in

3858

# `InspectionRuleSet`.

3859

"hotwordRule": { # The rule that adjusts the likelihood of findings within a certain # Hotword-based detection rule.

3860

# proximity of hotwords.

3861

"proximity": { # Message for specifying a window around a finding to apply a detection # Proximity of the finding within which the entire hotword must reside.

3862

# The total length of the window cannot exceed 1000 characters. Note that

3863

# the finding itself will be included in the window, so that hotwords may

3864

# be used to match substrings of the finding itself. For example, the

3865

# certainty of a phone number regex "$\d{3}$ \d{3}-\d{4}" could be

3866

# adjusted upwards if the area code is known to be the local area code of

3867

# a company office using the hotword regex "$xxx$", where "xxx"

3868

# is the area code in question.

3869

# rule.

3870

"windowAfter": 42, # Number of characters after the finding to consider.

3871

"windowBefore": 42, # Number of characters before the finding to consider.

3872

},

3873

"likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as # Likelihood adjustment to apply to all matching findings.

3874

# part of a detection rule.

3875

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value.

3876

"relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of

3877

# levels. For example, if a finding would be `POSSIBLE` without the

3878

# detection rule and `relative_likelihood` is 1, then it is upgraded to

3879

# `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`.

3880

# Likelihood may never drop below `VERY_UNLIKELY` or exceed

3881

# `VERY_LIKELY`, so applying an adjustment of 1 followed by an

3882

# adjustment of -1 when base likelihood is `VERY_LIKELY` will result in

3883

# a final likelihood of `LIKELY`.

3884

},

3885

"hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword.

3886

"groupIndexes": [ # The index of the submatch to extract as findings. When not

3887

# specified, the entire match is returned. No more than 3 may be included.

3888

42,

3889

],

3890

"pattern": "A String", # Pattern defining the regular expression. Its syntax

3891

# (https://github.com/google/re2/wiki/Syntax) can be found under the

3892

# google/re2 repository on GitHub.

3893

},

3894

},

3895

"exclusionRule": { # The rule that specifies conditions when findings of infoTypes specified in # Exclusion rule.

3896

# `InspectionRuleSet` are removed from results.

3897

"matchingType": "A String", # How the rule is applied, see MatchingType documentation for details.

3898

"dictionary": { # Custom information type based on a dictionary of words or phrases. This can # Dictionary which defines the rule.

3899

# be used to match sensitive information specific to the data, such as a list

3900

# of employee IDs or job titles.

3901

#

3902

# Dictionary words are case-insensitive and all characters other than letters

3903

# and digits in the unicode [Basic Multilingual

3904

# Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane)

3905

# will be replaced with whitespace when scanning for matches, so the

3906

# dictionary phrase "Sam Johnson" will match all three phrases "sam johnson",

3907

# "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters

3908

# surrounding any match must be of a different type than the adjacent

3909

# characters within the word, so letters must be next to non-letters and

3910

# digits next to non-digits. For example, the dictionary word "jen" will

3911

# match the first three letters of the text "jen123" but will return no

3912

# matches for "jennifer".

3913

#

3914

# Dictionary words containing a large number of characters that are not

3915

# letters or digits may result in unexpected findings because such characters

3916

# are treated as whitespace. The

3917

# [limits](https://cloud.google.com/dlp/limits) page contains details about

3918

# the size limits of dictionaries. For dictionaries that do not fit within

3919

# these constraints, consider using `LargeCustomDictionaryConfig` in the

3920

# `StoredInfoType` API.

3921

"cloudStoragePath": { # Message representing a single file or path in Cloud Storage. # Newline-delimited file of words in Cloud Storage. Only a single file

3922

# is accepted.

3923

"path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage.

3924

# Example: gs://[BUCKET_NAME]/dictionary.txt

3925

},

3926

"wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for.

3927

"words": [ # Words or phrases defining the dictionary. The dictionary must contain

3928

# at least one phrase and every phrase must contain at least 2 characters

3929

# that are letters or digits. [required]

"A String",

],

},

},

"excludeInfoTypes": { # List of exclude infoTypes. # Set of infoTypes for which findings would affect this rule.

3935

"infoTypes": [ # InfoType list in ExclusionRule rule drops a finding when it overlaps or

3936

# contained within with a finding of an infoType from this list. For

3937

# example, for `InspectionRuleSet.info_types` containing "PHONE_NUMBER"` and

3938

# `exclusion_rule` containing `exclude_info_types.info_types` with

3939

# "EMAIL_ADDRESS" the phone number findings are dropped if they overlap

3940

# with EMAIL_ADDRESS finding.

3941

# That leads to "555-222-2222@example.org" to generate only a single

3942

# finding, namely email address.

3943

{ # Type of information detected by the API.

3944

"name": "A String", # Name of the information type. Either a name of your choosing when

3945

# creating a CustomInfoType, or one of the names listed

3946

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

3947

# a built-in type. When sending Cloud DLP results to Data Catalog, infoType

3948

# names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

},

],

},

"regex": { # Message defining a custom regular expression. # Regular expression which defines the rule.

3953

"groupIndexes": [ # The index of the submatch to extract as findings. When not

3954

# specified, the entire match is returned. No more than 3 may be included.

3955

42,

3956

],

3957

"pattern": "A String", # Pattern defining the regular expression. Its syntax

3958

# (https://github.com/google/re2/wiki/Syntax) can be found under the

3959

# google/re2 repository on GitHub.

},

},

},

],

},

],

"contentOptions": [ # List of options defining data content to scan.

3967

# If empty, text, images, and other content will be included.

3968

"A String",

3969

],

3970

"infoTypes": [ # Restricts what info_types to look for. The values must correspond to

3971

# InfoType values returned by ListInfoTypes or listed at

3972

# https://cloud.google.com/dlp/docs/infotypes-reference.

3973

#

3974

# When no InfoTypes or CustomInfoTypes are specified in a request, the

3975

# system may automatically choose what detectors to run. By default this may

3976

# be all types, but may change over time as detectors are updated.

3977

#

3978

# If you need precise control and predictability as to what detectors are

3979

# run you should specify specific InfoTypes listed in the reference,

3980

# otherwise a default list will be used, which may change over time.

3981

{ # Type of information detected by the API.

3982

"name": "A String", # Name of the information type. Either a name of your choosing when

3983

# creating a CustomInfoType, or one of the names listed

3984

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

3985

# a built-in type. When sending Cloud DLP results to Data Catalog, infoType

3986

# names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

3987

},

3988

],

3989

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3990

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3991

"name": "A String", # Unique resource name for the triggeredJob, assigned by the service when the

3992

# triggeredJob is created, for example

3993

# `projects/dlp-test-project/jobTriggers/53234423`.

3994

"displayName": "A String", # Display name (max 100 chars)

3995

"lastRunTime": "A String", # Output only. The timestamp of the last time this trigger executed.

3996

"createTime": "A String", # Output only. The creation timestamp of a triggeredJob.

3997

"description": "A String", # User provided description (max 256 chars)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="hybridInspect">hybridInspect(name, body=None, x__xgafv=None)</code>

4003

<pre>Inspect hybrid content and store findings to a trigger. The inspection

4004

will be processed asynchronously. To review the findings monitor the

4005

jobs within the trigger.

4006

Early access feature is in a pre-release state and might change or have

4007

limited support. For more information, see

4008

https://cloud.google.com/products#product-launch-stages.

4009

4010

Args:

4011

name: string, Required. Resource name of the trigger to execute a hybrid inspect on, for example

4012

`projects/dlp-test-project/jobTriggers/53234423`. (required)

4013

body: object, The request body.

4014

The object takes the form of:

4015

4016

{ # Request to search for potentially sensitive info in a custom location.

4017

"hybridItem": { # An individual hybrid item to inspect. Will be stored temporarily during # The item to inspect.

4018

# processing.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4019

"item": { # Container structure for the content to inspect. # The item to inspect.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4020

"value": "A String", # String data to inspect or redact.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

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

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4025

"table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. # Structured content for inspection. See

4026

# https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to

4027

# learn more.

4028

# See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to

4029

# learn more.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4030

"headers": [ # Headers of the table.

4031

{ # General identifier of a data field in a storage service.

4032

"name": "A String", # Name describing the field.

4033

},

4034

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4035

"rows": [ # Rows of the table.

4036

{ # Values of the row.

4037

"values": [ # Individual cells.

4038

{ # Set of primitive values supported by the system.

4039

# Note that for the purposes of inspection or transformation, the number

4040

# of bytes considered to comprise a 'Value' is based on its representation

4041

# as a UTF-8 encoded string. For example, if 'integer_value' is set to

4042

# 123456789, the number of bytes would be counted as 9, even though an

4043

# int64 only holds up to 8 bytes of data.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4044

"integerValue": "A String", # integer

4045

"timeValue": { # Represents a time of day. The date and time zone are either not significant # time of day

4046

# or are specified elsewhere. An API may choose to allow leap seconds. Related

4047

# types are google.type.Date and `google.protobuf.Timestamp`.

4048

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

4049

# allow the value 60 if it allows leap-seconds.

4050

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

4051

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

4052

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

4053

# to allow the value "24:00:00" for scenarios like business closing time.

4054

},

4055

"dayOfWeekValue": "A String", # day of week

4056

"floatValue": 3.14, # float

4057

"stringValue": "A String", # string

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4058

"timestampValue": "A String", # timestamp

4059

"dateValue": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # date

4060

# and time zone are either specified elsewhere or are not significant. The date

4061

# is relative to the Proleptic Gregorian Calendar. This can represent:

4062

#

4063

# * A full date, with non-zero year, month and day values

4064

# * A month and day value, with a zero year, e.g. an anniversary

4065

# * A year on its own, with zero month and day values

4066

# * A year and month value, with a zero day, e.g. a credit card expiration date

4067

#

4068

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4069

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

4070

# month and day.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4071

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

4072

# a year.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4073

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

4074

# if specifying a year by itself or a year and month where the day is not

4075

# significant.

4076

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4077

"booleanValue": True or False, # boolean

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

},

],

},

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4082

},

4083

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4084

"findingDetails": { # Populate to associate additional data with each finding. # Supplementary information that will be added to each finding.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4085

"tableOptions": { # Instructions regarding the table content being inspected. # If the container is a table, additional information to make findings

4086

# meaningful such as the columns that are primary keys. If not known ahead

4087

# of time, can also be set within each inspect hybrid call and the two

4088

# will be merged. Note that identifying_fields will only be stored to

4089

# BigQuery, and only if the BigQuery action has been included.

4090

"identifyingFields": [ # The columns that are the primary keys for table objects included in

4091

# ContentItem. A copy of this cell's value will stored alongside alongside

4092

# each finding so that the finding can be traced to the specific row it came

4093

# from. No more than 3 may be provided.

4094

{ # General identifier of a data field in a storage service.

4095

"name": "A String", # Name describing the field.

4096

},

4097

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4098

},

4099

"labels": { # Labels to represent user provided metadata about the data being inspected.

4100

# If configured by the job, some key values may be required.

4101

# The labels associated with `Finding`'s produced by hybrid

4102

# inspection.

4103

#

4104

# Label keys must be between 1 and 63 characters long and must conform

4105

# to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.

4106

#

4107

# Label values must be between 0 and 63 characters long and must conform

4108

# to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.

4109

#

4110

# No more than 10 labels can be associated with a given finding.

4111

#

4112

# Examples:

4113

# * `"environment" : "production"`

4114

# * `"pipeline" : "etl"`

4115

"a_key": "A String",

4116

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4117

"fileOffset": "A String", # Offset in bytes of the line, from the beginning of the file, where the

4118

# finding is located. Populate if the item being scanned is only part of a

4119

# bigger item, such as a shard of a file and you want to track the absolute

4120

# position of the finding.

4121

"rowOffset": "A String", # Offset of the row for tables. Populate if the row(s) being scanned are

4122

# part of a bigger dataset and you want to keep track of their absolute

4123

# position.

4124

"containerDetails": { # Represents a container that may contain DLP findings. # Details about the container where the content being inspected is from.

4125

# Examples of a container include a file, table, or database record.

4126

"updateTime": "A String", # Findings container modification timestamp, if applicable.

4127

# For Google Cloud Storage contains last file modification timestamp.

4128

# For BigQuery table contains last_modified_time property.

4129

# For Datastore - not populated.

4130

"projectId": "A String", # Project where the finding was found.

4131

# Can be different from the project that owns the finding.

4132

"rootPath": "A String", # The root of the container.

4133

# Examples:

4134

# - For BigQuery table `project_id:dataset_id.table_id`, the root is

4135

# `dataset_id`

4136

# - For Google Cloud Storage file `gs://bucket/folder/filename.txt`, the root

4137

# is `gs://bucket`

4138

"version": "A String", # Findings container version, if available

4139

# ("generation" for Google Cloud Storage).

4140

"fullPath": "A String", # A string representation of the full container name.

4141

# Examples:

4142

# - BigQuery: 'Project:DataSetId.TableId'

4143

# - Google Cloud Storage: 'gs://Bucket/folders/filename.txt'

4144

"type": "A String", # Container type, for example BigQuery or Google Cloud Storage.

4145

"relativePath": "A String", # The rest of the path after the root.

4146

# Examples:

4147

# - For BigQuery table `project_id:dataset_id.table_id`, the relative path is

4148

# `table_id`

4149

# - Google Cloud Storage file `gs://bucket/folder/filename.txt`, the relative

4150

# path is `folder/filename.txt`

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4151

},

Bu Sun Kim

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:

4163

4164

{ # Quota exceeded errors will be thrown once quota has been met.

}</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4169

<code class="details" id="list">list(parent, locationId=None, pageToken=None, filter=None, pageSize=None, orderBy=None, x__xgafv=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4170

<pre>Lists job triggers.

4171

See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.

4172

4173

Args:

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4174

parent: string, Required. Parent resource name.

4175

- Format:projects/[PROJECT-ID]

4176

- Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] (required)

4177

locationId: string, Deprecated. This field has no effect.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4178

pageToken: string, Page token to continue retrieval. Comes from previous call

4179

to ListJobTriggers. `order_by` field must not

4180

change for subsequent calls.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4181

filter: string, Allows filtering.

Supported syntax:

* Filter expressions are made up of one or more restrictions.

4186

* Restrictions can be combined by `AND` or `OR` logical operators. A

4187

sequence of restrictions implicitly uses `AND`.

4188

* A restriction has the form of `{field} {operator} {value}`.

4189

* Supported fields/values for inspect jobs:

4190

- `status` - HEALTHY|PAUSED|CANCELLED

4191

- `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY

4192

- 'last_run_time` - RFC 3339 formatted timestamp, surrounded by

4193

quotation marks. Nanoseconds are ignored.

4194

- 'error_count' - Number of errors that have occurred while running.

4195

* The operator must be `=` or `!=` for status and inspected_storage.

Examples:

* inspected_storage = cloud_storage AND status = HEALTHY

4200

* inspected_storage = cloud_storage OR inspected_storage = bigquery

4201

* inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY)

4202

* last_run_time > \"2017-12-12T00:00:00+00:00\"

4203

4204

The length of this field should be no more than 500 characters.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4205

pageSize: integer, Size of the page, can be limited by a server.

4206

orderBy: string, Comma separated list of triggeredJob fields to order by,

4207

followed by `asc` or `desc` postfix. This list is case-insensitive,

4208

default sorting order is ascending, redundant space characters are

4209

insignificant.

4210

4211

Example: `name asc,update_time, create_time desc`

4212

4213

Supported fields are:

4214

4215

- `create_time`: corresponds to time the JobTrigger was created.

4216

- `update_time`: corresponds to time the JobTrigger was last updated.

4217

- `last_run_time`: corresponds to the last time the JobTrigger ran.

4218

- `name`: corresponds to JobTrigger's name.

4219

- `display_name`: corresponds to JobTrigger's display name.

4220

- `status`: corresponds to JobTrigger's status.

Bu Sun Kim

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

2020-07-22 17:02:09 -0700

[diff] [blame^]

4233

"status": "A String", # Required. A status for this trigger.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4234

"triggers": [ # A list of triggers which will be OR'ed together. Only one in the list

4235

# needs to trigger for a job to be started. The list may contain only

4236

# a single Schedule trigger and must have at least one object.

4237

{ # What event needs to occur for a new job to be started.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4238

"manual": { # Job trigger option for hybrid jobs. Jobs must be manually created # For use with hybrid jobs. Jobs must be manually created and finished.

4239

# Early access feature is in a pre-release state and might change or have

4240

# limited support. For more information, see

4241

# https://cloud.google.com/products#product-launch-stages.

4242

# and finished.

4243

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4244

"schedule": { # Schedule for triggeredJobs. # Create a job on a repeating basis based on the elapse of time.

4245

"recurrencePeriodDuration": "A String", # With this option a job is started a regular periodic basis. For

4246

# example: every day (86400 seconds).

4247

#

4248

# A scheduled start time will be skipped if the previous

4249

# execution has not ended when its scheduled time occurs.

4250

#

4251

# This value must be set to a time duration greater than or equal

4252

# to 1 day and can be no longer than 60 days.

4253

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4254

},

4255

],

4256

"errors": [ # Output only. A stream of errors encountered when the trigger was activated. Repeated

4257

# errors may result in the JobTrigger automatically being paused.

4258

# Will return the last 100 errors. Whenever the JobTrigger is modified

4259

# this list will be cleared.

4260

{ # Details information about an error encountered during job execution or

4261

# the results of an unsuccessful activation of the JobTrigger.

4262

"timestamps": [ # The times the error occurred.

4263

"A String",

4264

],

4265

"details": { # The `Status` type defines a logical error model that is suitable for # Detailed error codes and messages.

4266

# different programming environments, including REST APIs and RPC APIs. It is

4267

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

4268

# three pieces of data: error code, error message, and error details.

4269

#

4270

# You can find out more about this error model and how to work with it in the

4271

# [API Design Guide](https://cloud.google.com/apis/design/errors).

4272

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

4273

"details": [ # A list of messages that carry the error details. There is a common set of

4274

# message types for APIs to use.

4275

{

4276

"a_key": "", # Properties of the object. Contains field @type with type URL.

4277

},

4278

],

4279

"message": "A String", # A developer-facing error message, which should be in English. Any

4280

# user-facing error message should be localized and sent in the

4281

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4282

},

4283

},

4284

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4285

"updateTime": "A String", # Output only. The last update timestamp of a triggeredJob.

4286

"inspectJob": { # Controls what and how to inspect for findings. # For inspect jobs, a snapshot of the configuration.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4287

"inspectTemplateName": "A String", # If provided, will be used as the default for all values in InspectConfig.

4288

# `inspect_config` will be merged into the values persisted as part of the

4289

# template.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4290

"actions": [ # Actions to execute at the completion of the job.

4291

{ # A task to execute on the completion of a job.

4292

# See https://cloud.google.com/dlp/docs/concepts-actions to learn more.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4293

"publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This # Enable Stackdriver metric dlp.googleapis.com/finding_count.

4294

# will publish a metric to stack driver on each infotype requested and

4295

# how many findings were found for it. CustomDetectors will be bucketed

4296

# as 'Custom' under the Stackdriver label 'info_type'.

4297

},

4298

"publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Cloud Data Catalog. Labels summarizing the # Publish findings to Cloud Datahub.

4299

# results of the DlpJob will be applied to the entry for the resource scanned

4300

# in Cloud Data Catalog. Any labels previously written by another DlpJob will

4301

# be deleted. InfoType naming patterns are strictly enforced when using this

4302

# feature. Note that the findings will be persisted in Cloud Data Catalog

4303

# storage and are governed by Data Catalog service-specific policy, see

4304

# https://cloud.google.com/terms/service-terms

4305

# Only a single instance of this action can be specified and only allowed if

4306

# all resources being scanned are BigQuery tables.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4307

# Compatible with: Inspect

4308

},

4309

"jobNotificationEmails": { # Enable email notification to project owners and editors on jobs's # Enable email notification for project owners and editors on job's

4310

# completion/failure.

4311

# completion/failure.

4312

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4313

"pubSub": { # Publish a message into given Pub/Sub topic when DlpJob has completed. The # Publish a notification to a pubsub topic.

4314

# message contains a single field, `DlpJobName`, which is equal to the

4315

# finished job's

4316

# [`DlpJob.name`](https://cloud.google.com/dlp/docs/reference/rest/v2/projects.dlpJobs#DlpJob).

4317

# Compatible with: Inspect, Risk

4318

"topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given

4319

# publishing access rights to the DLP API service account executing

4320

# the long running DlpJob sending the notifications.

4321

# Format is projects/{project}/topics/{topic}.

4322

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4323

"saveFindings": { # If set, the detailed findings will be persisted to the specified # Save resulting findings in a provided location.

4324

# OutputStorageConfig. Only a single instance of this action can be

4325

# specified.

4326

# Compatible with: Inspect, Risk

4327

"outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4328

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only

4329

# used for Inspect and must be unspecified for Risk jobs. Columns are derived

4330

# from the `Finding` object. If appending to an existing table, any columns

4331

# from the predefined schema that are missing will be added. No columns in

4332

# the existing table will be deleted.

4333

#

4334

# If unspecified, then all available columns will be used for a new table or

4335

# an (existing) table with no schema, and no changes will be made to an

4336

# existing table that has a schema.

4337

# Only for use with external storage.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4338

"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

4339

# dataset. If table_id is not set a new one will be generated

4340

# for you with the following format:

4341

# dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific timezone will be used for

4342

# generating the date details.

4343

#

4344

# For Inspect, each column in an existing output table must have the same

4345

# name, type, and mode of a field in the `Finding` object.

4346

#

4347

# For Risk, an existing output table should be the output of a previous

4348

# Risk analysis job run on the same source table, with the same privacy

4349

# metric and quasi-identifiers. Risk jobs that analyze the same table but

4350

# compute a different privacy metric, or use different sets of

4351

# quasi-identifiers, cannot store their results in the same table.

4352

# identified by its project_id, dataset_id, and table_name. Within a query

4353

# a table is often referenced with a string in the format of:

4354

# `<project_id>:<dataset_id>.<table_id>` or

4355

# `<project_id>.<dataset_id>.<table_id>`.

4356

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table.

4357

# If omitted, project ID is inferred from the API call.

4358

"datasetId": "A String", # Dataset ID of the table.

4359

"tableId": "A String", # Name of the table.

4360

},

4361

},

4362

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4363

"publishSummaryToCscc": { # Publish the result summary of a DlpJob to the Cloud Security # Publish summary to Cloud Security Command Center (Alpha).

4364

# Command Center (CSCC Alpha).

4365

# This action is only available for projects which are parts of

4366

# an organization and whitelisted for the alpha Cloud Security Command

4367

# Center.

4368

# The action will publish count of finding instances and their info types.

4369

# The summary of findings will be persisted in CSCC and are governed by CSCC

4370

# service-specific policy, see https://cloud.google.com/terms/service-terms

4371

# Only a single instance of this action can be specified.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4372

# Compatible with: Inspect

4373

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4374

},

4375

],

4376

"storageConfig": { # Shared message indicating Cloud storage type. # The data to scan.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4377

"cloudStorageOptions": { # Options defining a file or a set of files within a Google Cloud Storage # Google Cloud Storage options.

4378

# bucket.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4379

"bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The

4380

# number of bytes scanned is rounded down. Must be between 0 and 100,

4381

# inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one

4382

# of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.

4383

"fileTypes": [ # List of file type groups to include in the scan.

4384

# If empty, all files are scanned and available data format processors

4385

# are applied. In addition, the binary content of the selected files

4386

# is always scanned as well.

4387

# Images are scanned only as binary if the specified region

4388

# does not support image inspection and no file_types were specified.

4389

# Image inspection is restricted to 'global', 'us', 'asia', and 'europe'.

4390

"A String",

4391

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4392

"bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger

4393

# than this value then the rest of the bytes are omitted. Only one

4394

# of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4395

"filesLimitPercent": 42, # Limits the number of files to scan to this percentage of the input FileSet.

4396

# Number of files scanned is rounded down. Must be between 0 and 100,

4397

# inclusively. Both 0 and 100 means no limit. Defaults to 0.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4398

"fileSet": { # Set of files to scan. # The set of one or more files to scan.

4399

"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

4400

# `regex_file_set` must be set.

4401

# expressions are used to allow fine-grained control over which files in the

4402

# bucket to include.

4403

#

4404

# Included files are those that match at least one item in `include_regex` and

4405

# do not match any items in `exclude_regex`. Note that a file that matches

4406

# items from both lists will _not_ be included. For a match to occur, the

4407

# entire file path (i.e., everything in the url after the bucket name) must

4408

# match the regular expression.

4409

#

4410

# For example, given the input `{bucket_name: "mybucket", include_regex:

4411

# ["directory1/.*"], exclude_regex:

4412

# ["directory1/excluded.*"]}`:

4413

#

4414

# * `gs://mybucket/directory1/myfile` will be included

4415

# * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches

4416

# across `/`)

4417

# * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the

4418

# full path doesn't match any items in `include_regex`)

4419

# * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path

4420

# matches an item in `exclude_regex`)

4421

#

4422

# If `include_regex` is left empty, it will match all files by default

4423

# (this is equivalent to setting `include_regex: [".*"]`).

4424

#

4425

# Some other common use cases:

4426

#

4427

# * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all

4428

# files in `mybucket` except for .pdf files

4429

# * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will

4430

# include all files directly under `gs://mybucket/directory/`, without matching

4431

# across `/`

4432

"bucketName": "A String", # The name of a Cloud Storage bucket. Required.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4433

"excludeRegex": [ # A list of regular expressions matching file paths to exclude. All files in

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4434

# the bucket that match at least one of these regular expressions will be

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4435

# excluded from the scan.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4436

#

4437

# Regular expressions use RE2

4438

# [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found

4439

# under the google/re2 repository on GitHub.

4440

"A String",

4441

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4442

"includeRegex": [ # A list of regular expressions matching file paths to include. All files in

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4443

# the bucket that match at least one of these regular expressions will be

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4444

# included in the set of files, except for those that also match an item in

4445

# `exclude_regex`. Leaving this field empty will match all files by default

4446

# (this is equivalent to including `.*` in the list).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4447

#

4448

# Regular expressions use RE2

4449

# [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found

4450

# 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

4455

# `gs://<bucket>/<path>`. Trailing wildcard in the path is allowed.

4456

#

4457

# If the url ends in a trailing slash, the bucket or directory represented

4458

# by the url will be scanned non-recursively (content in sub-directories

4459

# will not be scanned). This means that `gs://mybucket/` is equivalent to

4460

# `gs://mybucket/*`, and `gs://mybucket/directory/` is equivalent to

4461

# `gs://mybucket/directory/*`.

4462

#

4463

# Exactly one of `url` or `regex_file_set` must be set.

4464

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4465

"sampleMethod": "A String",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4466

},

4467

"bigQueryOptions": { # Options defining BigQuery table and row identifiers. # BigQuery options.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4468

"sampleMethod": "A String",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4469

"tableReference": { # Message defining the location of a BigQuery table. A table is uniquely # Complete BigQuery table reference.

4470

# identified by its project_id, dataset_id, and table_name. Within a query

4471

# a table is often referenced with a string in the format of:

4472

# `<project_id>:<dataset_id>.<table_id>` or

4473

# `<project_id>.<dataset_id>.<table_id>`.

4474

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table.

4475

# If omitted, project ID is inferred from the API call.

4476

"datasetId": "A String", # Dataset ID of the table.

4477

"tableId": "A String", # Name of the table.

4478

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4479

"rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows

4480

# scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and

4481

# 100 means no limit. Defaults to 0. Only one of rows_limit and

4482

# rows_limit_percent can be specified. Cannot be used in conjunction with

4483

# TimespanConfig.

4484

"rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the

4485

# rest of the rows are omitted. If not set, or if set to 0, all rows will be

4486

# scanned. Only one of rows_limit and rows_limit_percent can be specified.

4487

# Cannot be used in conjunction with TimespanConfig.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4488

"identifyingFields": [ # Table fields that may uniquely identify a row within the table. When

4489

# `actions.saveFindings.outputConfig.table` is specified, the values of

4490

# columns specified here are available in the output table under

4491

# `location.content_locations.record_location.record_key.id_values`. Nested

4492

# fields such as `person.birthdate.year` are allowed.

4493

{ # General identifier of a data field in a storage service.

4494

"name": "A String", # Name describing the field.

4495

},

4496

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4497

"excludedFields": [ # References to fields excluded from scanning. This allows you to skip

4498

# inspection of entire columns which you know have no findings.

4499

{ # General identifier of a data field in a storage service.

4500

"name": "A String", # Name describing the field.

4501

},

4502

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4503

},

4504

"timespanConfig": { # Configuration of the timespan of the items to include in scanning.

4505

# Currently only supported when inspecting Google Cloud Storage and BigQuery.

4506

"timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items.

4507

# Used for data sources like Datastore and BigQuery.

4508

#

4509

# For BigQuery:

4510

# Required to filter out rows based on the given start and

4511

# end times. If not specified and the table was modified between the given

4512

# start and end times, the entire table will be scanned.

4513

# The valid data types of the timestamp field are: `INTEGER`, `DATE`,

4514

# `TIMESTAMP`, or `DATETIME` BigQuery column.

4515

#

4516

# For Datastore.

4517

# Valid data types of the timestamp field are: `TIMESTAMP`.

4518

# Datastore entity will be scanned if the timestamp property does not

4519

# exist or its value is empty or invalid.

4520

"name": "A String", # Name describing the field.

4521

},

4522

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out

4523

# a valid start_time to avoid scanning files that have not been modified

4524

# since the last time the JobTrigger executed. This will be based on the

4525

# time of the execution of the last run of the JobTrigger.

4526

"startTime": "A String", # Exclude files or rows older than this value.

4527

"endTime": "A String", # Exclude files or rows newer than this value.

4528

# If set to zero, no upper time limit is applied.

4529

},

4530

"datastoreOptions": { # Options defining a data set within Google Cloud Datastore. # Google Cloud Datastore options.

4531

"kind": { # A representation of a Datastore kind. # The kind to process.

4532

"name": "A String", # The name of the kind.

4533

},

4534

"partitionId": { # Datastore partition ID. # A partition ID identifies a grouping of entities. The grouping is always

4535

# by project and namespace, however the namespace ID may be empty.

4536

# A partition ID identifies a grouping of entities. The grouping is always

4537

# by project and namespace, however the namespace ID may be empty.

4538

#

4539

# A partition ID contains several dimensions:

4540

# project ID and namespace ID.

4541

"namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.

4542

"projectId": "A String", # The ID of the project to which the entities belong.

4543

},

4544

},

4545

"hybridOptions": { # Configuration to control jobs where the content being inspected is outside # Hybrid inspection options.

4546

# Early access feature is in a pre-release state and might change or have

4547

# limited support. For more information, see

4548

# https://cloud.google.com/products#product-launch-stages.

4549

# of Google Cloud Platform.

4550

"tableOptions": { # Instructions regarding the table content being inspected. # If the container is a table, additional information to make findings

4551

# meaningful such as the columns that are primary keys.

4552

"identifyingFields": [ # The columns that are the primary keys for table objects included in

4553

# ContentItem. A copy of this cell's value will stored alongside alongside

4554

# each finding so that the finding can be traced to the specific row it came

4555

# from. No more than 3 may be provided.

4556

{ # General identifier of a data field in a storage service.

4557

"name": "A String", # Name describing the field.

},

],

},

"requiredFindingLabelKeys": [ # These are labels that each inspection request must include within their

4562

# 'finding_labels' map. Request may contain others, but any missing one of

4563

# these will be rejected.

4564

#

4565

# Label keys must be between 1 and 63 characters long and must conform

4566

# to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.

4567

#

4568

# No more than 10 keys can be required.

4569

"A String",

4570

],

4571

"labels": { # To organize findings, these labels will be added to each finding.

4572

#

4573

# Label keys must be between 1 and 63 characters long and must conform

4574

# to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.

4575

#

4576

# Label values must be between 0 and 63 characters long and must conform

4577

# to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.

4578

#

4579

# No more than 10 labels can be associated with a given finding.

4580

#

4581

# Examples:

4582

# * `"environment" : "production"`

4583

# * `"pipeline" : "etl"`

4584

"a_key": "A String",

4585

},

4586

"description": "A String", # A short description of where the data is coming from. Will be stored once

4587

# in the job. 256 max length.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4588

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4589

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4590

"inspectConfig": { # Configuration description of the scanning process. # How and what to scan for.

4591

# When used with redactContent only info_types and min_likelihood are currently

4592

# used.

4593

"customInfoTypes": [ # CustomInfoTypes provided by the user. See

4594

# https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more.

4595

{ # Custom information type provided by the user. Used to find domain-specific

4596

# sensitive information configurable to the data in question.

4597

"dictionary": { # Custom information type based on a dictionary of words or phrases. This can # A list of phrases to detect as a CustomInfoType.

4598

# be used to match sensitive information specific to the data, such as a list

4599

# of employee IDs or job titles.

4600

#

4601

# Dictionary words are case-insensitive and all characters other than letters

4602

# and digits in the unicode [Basic Multilingual

4603

# Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane)

4604

# will be replaced with whitespace when scanning for matches, so the

4605

# dictionary phrase "Sam Johnson" will match all three phrases "sam johnson",

4606

# "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters

4607

# surrounding any match must be of a different type than the adjacent

4608

# characters within the word, so letters must be next to non-letters and

4609

# digits next to non-digits. For example, the dictionary word "jen" will

4610

# match the first three letters of the text "jen123" but will return no

4611

# matches for "jennifer".

4612

#

4613

# Dictionary words containing a large number of characters that are not

4614

# letters or digits may result in unexpected findings because such characters

4615

# are treated as whitespace. The

4616

# [limits](https://cloud.google.com/dlp/limits) page contains details about

4617

# the size limits of dictionaries. For dictionaries that do not fit within

4618

# these constraints, consider using `LargeCustomDictionaryConfig` in the

4619

# `StoredInfoType` API.

4620

"cloudStoragePath": { # Message representing a single file or path in Cloud Storage. # Newline-delimited file of words in Cloud Storage. Only a single file

4621

# is accepted.

4622

"path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage.

4623

# Example: gs://[BUCKET_NAME]/dictionary.txt

4624

},

4625

"wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for.

4626

"words": [ # Words or phrases defining the dictionary. The dictionary must contain

4627

# at least one phrase and every phrase must contain at least 2 characters

4628

# that are letters or digits. [required]

"A String",

],

},

},

"infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in

4634

# infoType, when the name matches one of existing infoTypes and that infoType

4635

# is specified in `InspectContent.info_types` field. Specifying the latter

4636

# adds findings to the one detected by the system. If built-in info type is

4637

# not specified in `InspectContent.info_types` list then the name is treated

4638

# as a custom info type.

4639

"name": "A String", # Name of the information type. Either a name of your choosing when

4640

# creating a CustomInfoType, or one of the names listed

4641

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

4642

# a built-in type. When sending Cloud DLP results to Data Catalog, infoType

4643

# names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

4644

},

4645

"likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be

4646

# altered by a detection rule if the finding meets the criteria specified by

4647

# the rule. Defaults to `VERY_LIKELY` if not specified.

4648

"detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType.

4649

# Rules are applied in order that they are specified. Not supported for the

4650

# `surrogate_type` CustomInfoType.

4651

{ # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a

4652

# `CustomInfoType` to alter behavior under certain circumstances, depending

4653

# on the specific details of the rule. Not supported for the `surrogate_type`

4654

# custom infoType.

4655

"hotwordRule": { # The rule that adjusts the likelihood of findings within a certain # Hotword-based detection rule.

4656

# proximity of hotwords.

4657

"proximity": { # Message for specifying a window around a finding to apply a detection # Proximity of the finding within which the entire hotword must reside.

4658

# The total length of the window cannot exceed 1000 characters. Note that

4659

# the finding itself will be included in the window, so that hotwords may

4660

# be used to match substrings of the finding itself. For example, the

4661

# certainty of a phone number regex "$\d{3}$ \d{3}-\d{4}" could be

4662

# adjusted upwards if the area code is known to be the local area code of

4663

# a company office using the hotword regex "$xxx$", where "xxx"

4664

# is the area code in question.

4665

# rule.

4666

"windowAfter": 42, # Number of characters after the finding to consider.

4667

"windowBefore": 42, # Number of characters before the finding to consider.

4668

},

4669

"likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as # Likelihood adjustment to apply to all matching findings.

4670

# part of a detection rule.

4671

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value.

4672

"relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of

4673

# levels. For example, if a finding would be `POSSIBLE` without the

4674

# detection rule and `relative_likelihood` is 1, then it is upgraded to

4675

# `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`.

4676

# Likelihood may never drop below `VERY_UNLIKELY` or exceed

4677

# `VERY_LIKELY`, so applying an adjustment of 1 followed by an

4678

# adjustment of -1 when base likelihood is `VERY_LIKELY` will result in

4679

# a final likelihood of `LIKELY`.

4680

},

4681

"hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword.

4682

"groupIndexes": [ # The index of the submatch to extract as findings. When not

4683

# specified, the entire match is returned. No more than 3 may be included.

4684

42,

4685

],

4686

"pattern": "A String", # Pattern defining the regular expression. Its syntax

4687

# (https://github.com/google/re2/wiki/Syntax) can be found under the

4688

# google/re2 repository on GitHub.

},

},

},

],

"surrogateType": { # Message for detecting output from deidentification transformations # Message for detecting output from deidentification transformations that

4694

# support reversing.

4695

# such as

4696

# [`CryptoReplaceFfxFpeConfig`](https://cloud.google.com/dlp/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig).

4697

# These types of transformations are

4698

# those that perform pseudonymization, thereby producing a "surrogate" as

4699

# output. This should be used in conjunction with a field on the

4700

# transformation such as `surrogate_info_type`. This CustomInfoType does

4701

# not support the use of `detection_rules`.

4702

},

4703

"regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType.

4704

"groupIndexes": [ # The index of the submatch to extract as findings. When not

4705

# specified, the entire match is returned. No more than 3 may be included.

4706

42,

4707

],

4708

"pattern": "A String", # Pattern defining the regular expression. Its syntax

4709

# (https://github.com/google/re2/wiki/Syntax) can be found under the

4710

# google/re2 repository on GitHub.

4711

},

4712

"storedType": { # A reference to a StoredInfoType to use with scanning. # Load an existing `StoredInfoType` resource for use in

4713

# `InspectDataSource`. Not currently supported in `InspectContent`.

4714

"name": "A String", # Resource name of the requested `StoredInfoType`, for example

4715

# `organizations/433245324/storedInfoTypes/432452342` or

4716

# `projects/project-id/storedInfoTypes/432452342`.

4717

"createTime": "A String", # Timestamp indicating when the version of the `StoredInfoType` used for

4718

# inspection was created. Output-only field, populated by the system.

4719

},

4720

"exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding

4721

# to be returned. It still can be used for rules matching.

4722

},

4723

],

4724

"minLikelihood": "A String", # Only returns findings equal or above this threshold. The default is

4725

# POSSIBLE.

4726

# See https://cloud.google.com/dlp/docs/likelihood to learn more.

4727

"limits": { # Configuration to control the number of findings returned. # Configuration to control the number of findings returned.

4728

"maxFindingsPerRequest": 42, # Max number of findings that will be returned per request/job.

4729

# When set within `InspectContentRequest`, the maximum returned is 2000

4730

# regardless if this is set higher.

4731

"maxFindingsPerInfoType": [ # Configuration of findings limit given for specified infoTypes.

4732

{ # Max findings configuration per infoType, per content item or long

4733

# running DlpJob.

4734

"infoType": { # Type of information detected by the API. # Type of information the findings limit applies to. Only one limit per

4735

# info_type should be provided. If InfoTypeLimit does not have an

4736

# info_type, the DLP API applies the limit against all info_types that

4737

# are found but not specified in another InfoTypeLimit.

4738

"name": "A String", # Name of the information type. Either a name of your choosing when

4739

# creating a CustomInfoType, or one of the names listed

4740

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

4741

# a built-in type. When sending Cloud DLP results to Data Catalog, infoType

4742

# names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

4743

},

4744

"maxFindings": 42, # Max findings limit for the given infoType.

4745

},

4746

],

4747

"maxFindingsPerItem": 42, # Max number of findings that will be returned for each item scanned.

4748

# When set within `InspectJobConfig`,

4749

# the maximum returned is 2000 regardless if this is set higher.

4750

# When set within `InspectContentRequest`, this field is ignored.

4751

},

4752

"excludeInfoTypes": True or False, # When true, excludes type information of the findings.

4753

"includeQuote": True or False, # When true, a contextual quote from the data that triggered a finding is

4754

# included in the response; see Finding.quote.

4755

"ruleSet": [ # Set of rules to apply to the findings for this InspectConfig.

4756

# Exclusion rules, contained in the set are executed in the end, other

4757

# rules are executed in the order they are specified for each info type.

4758

{ # Rule set for modifying a set of infoTypes to alter behavior under certain

4759

# circumstances, depending on the specific details of the rules within the set.

4760

"infoTypes": [ # List of infoTypes this rule set is applied to.

4761

{ # Type of information detected by the API.

4762

"name": "A String", # Name of the information type. Either a name of your choosing when

4763

# creating a CustomInfoType, or one of the names listed

4764

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

4765

# a built-in type. When sending Cloud DLP results to Data Catalog, infoType

4766

# names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

4767

},

4768

],

4769

"rules": [ # Set of rules to be applied to infoTypes. The rules are applied in order.

4770

{ # A single inspection rule to be applied to infoTypes, specified in

4771

# `InspectionRuleSet`.

4772

"hotwordRule": { # The rule that adjusts the likelihood of findings within a certain # Hotword-based detection rule.

4773

# proximity of hotwords.

4774

"proximity": { # Message for specifying a window around a finding to apply a detection # Proximity of the finding within which the entire hotword must reside.

4775

# The total length of the window cannot exceed 1000 characters. Note that

4776

# the finding itself will be included in the window, so that hotwords may

4777

# be used to match substrings of the finding itself. For example, the

4778

# certainty of a phone number regex "$\d{3}$ \d{3}-\d{4}" could be

4779

# adjusted upwards if the area code is known to be the local area code of

4780

# a company office using the hotword regex "$xxx$", where "xxx"

4781

# is the area code in question.

4782

# rule.

4783

"windowAfter": 42, # Number of characters after the finding to consider.

4784

"windowBefore": 42, # Number of characters before the finding to consider.

4785

},

4786

"likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as # Likelihood adjustment to apply to all matching findings.

4787

# part of a detection rule.

4788

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value.

4789

"relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of

4790

# levels. For example, if a finding would be `POSSIBLE` without the

4791

# detection rule and `relative_likelihood` is 1, then it is upgraded to

4792

# `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`.

4793

# Likelihood may never drop below `VERY_UNLIKELY` or exceed

4794

# `VERY_LIKELY`, so applying an adjustment of 1 followed by an

4795

# adjustment of -1 when base likelihood is `VERY_LIKELY` will result in

4796

# a final likelihood of `LIKELY`.

4797

},

4798

"hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword.

4799

"groupIndexes": [ # The index of the submatch to extract as findings. When not

4800

# specified, the entire match is returned. No more than 3 may be included.

4801

42,

4802

],

4803

"pattern": "A String", # Pattern defining the regular expression. Its syntax

4804

# (https://github.com/google/re2/wiki/Syntax) can be found under the

4805

# google/re2 repository on GitHub.

4806

},

4807

},

4808

"exclusionRule": { # The rule that specifies conditions when findings of infoTypes specified in # Exclusion rule.

4809

# `InspectionRuleSet` are removed from results.

4810

"matchingType": "A String", # How the rule is applied, see MatchingType documentation for details.

4811

"dictionary": { # Custom information type based on a dictionary of words or phrases. This can # Dictionary which defines the rule.

4812

# be used to match sensitive information specific to the data, such as a list

4813

# of employee IDs or job titles.

4814

#

4815

# Dictionary words are case-insensitive and all characters other than letters

4816

# and digits in the unicode [Basic Multilingual

4817

# Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane)

4818

# will be replaced with whitespace when scanning for matches, so the

4819

# dictionary phrase "Sam Johnson" will match all three phrases "sam johnson",

4820

# "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters

4821

# surrounding any match must be of a different type than the adjacent

4822

# characters within the word, so letters must be next to non-letters and

4823

# digits next to non-digits. For example, the dictionary word "jen" will

4824

# match the first three letters of the text "jen123" but will return no

4825

# matches for "jennifer".

4826

#

4827

# Dictionary words containing a large number of characters that are not

4828

# letters or digits may result in unexpected findings because such characters

4829

# are treated as whitespace. The

4830

# [limits](https://cloud.google.com/dlp/limits) page contains details about

4831

# the size limits of dictionaries. For dictionaries that do not fit within

4832

# these constraints, consider using `LargeCustomDictionaryConfig` in the

4833

# `StoredInfoType` API.

4834

"cloudStoragePath": { # Message representing a single file or path in Cloud Storage. # Newline-delimited file of words in Cloud Storage. Only a single file

4835

# is accepted.

4836

"path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage.

4837

# Example: gs://[BUCKET_NAME]/dictionary.txt

4838

},

4839

"wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for.

4840

"words": [ # Words or phrases defining the dictionary. The dictionary must contain

4841

# at least one phrase and every phrase must contain at least 2 characters

4842

# that are letters or digits. [required]

"A String",

],

},

},

"excludeInfoTypes": { # List of exclude infoTypes. # Set of infoTypes for which findings would affect this rule.

4848

"infoTypes": [ # InfoType list in ExclusionRule rule drops a finding when it overlaps or

4849

# contained within with a finding of an infoType from this list. For

4850

# example, for `InspectionRuleSet.info_types` containing "PHONE_NUMBER"` and

4851

# `exclusion_rule` containing `exclude_info_types.info_types` with

4852

# "EMAIL_ADDRESS" the phone number findings are dropped if they overlap

4853

# with EMAIL_ADDRESS finding.

4854

# That leads to "555-222-2222@example.org" to generate only a single

4855

# finding, namely email address.

4856

{ # Type of information detected by the API.

4857

"name": "A String", # Name of the information type. Either a name of your choosing when

4858

# creating a CustomInfoType, or one of the names listed

4859

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

4860

# a built-in type. When sending Cloud DLP results to Data Catalog, infoType

4861

# names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

},

],

},

"regex": { # Message defining a custom regular expression. # Regular expression which defines the rule.

4866

"groupIndexes": [ # The index of the submatch to extract as findings. When not

4867

# specified, the entire match is returned. No more than 3 may be included.

4868

42,

4869

],

4870

"pattern": "A String", # Pattern defining the regular expression. Its syntax

4871

# (https://github.com/google/re2/wiki/Syntax) can be found under the

4872

# google/re2 repository on GitHub.

},

},

},

],

},

],

"contentOptions": [ # List of options defining data content to scan.

4880

# If empty, text, images, and other content will be included.

4881

"A String",

4882

],

4883

"infoTypes": [ # Restricts what info_types to look for. The values must correspond to

4884

# InfoType values returned by ListInfoTypes or listed at

4885

# https://cloud.google.com/dlp/docs/infotypes-reference.

4886

#

4887

# When no InfoTypes or CustomInfoTypes are specified in a request, the

4888

# system may automatically choose what detectors to run. By default this may

4889

# be all types, but may change over time as detectors are updated.

4890

#

4891

# If you need precise control and predictability as to what detectors are

4892

# run you should specify specific InfoTypes listed in the reference,

4893

# otherwise a default list will be used, which may change over time.

4894

{ # Type of information detected by the API.

4895

"name": "A String", # Name of the information type. Either a name of your choosing when

4896

# creating a CustomInfoType, or one of the names listed

4897

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

4898

# a built-in type. When sending Cloud DLP results to Data Catalog, infoType

4899

# names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

4900

},

4901

],

4902

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4903

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4904

"name": "A String", # Unique resource name for the triggeredJob, assigned by the service when the

4905

# triggeredJob is created, for example

4906

# `projects/dlp-test-project/jobTriggers/53234423`.

4907

"displayName": "A String", # Display name (max 100 chars)

4908

"lastRunTime": "A String", # Output only. The timestamp of the last time this trigger executed.

4909

"createTime": "A String", # Output only. The creation timestamp of a triggeredJob.

4910

"description": "A String", # User provided description (max 256 chars)

Bu Sun Kim

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

2020-07-22 17:02:09 -0700

[diff] [blame^]

4944

"updateMask": "A String", # Mask to control which fields get updated.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4945

"jobTrigger": { # Contains a configuration to make dlp api calls on a repeating basis. # New JobTrigger value.

4946

# See https://cloud.google.com/dlp/docs/concepts-job-triggers to learn more.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4947

"status": "A String", # Required. A status for this trigger.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4948

"triggers": [ # A list of triggers which will be OR'ed together. Only one in the list

4949

# needs to trigger for a job to be started. The list may contain only

4950

# a single Schedule trigger and must have at least one object.

4951

{ # What event needs to occur for a new job to be started.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4952

"manual": { # Job trigger option for hybrid jobs. Jobs must be manually created # For use with hybrid jobs. Jobs must be manually created and finished.

4953

# Early access feature is in a pre-release state and might change or have

4954

# limited support. For more information, see

4955

# https://cloud.google.com/products#product-launch-stages.

4956

# and finished.

4957

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4958

"schedule": { # Schedule for triggeredJobs. # Create a job on a repeating basis based on the elapse of time.

4959

"recurrencePeriodDuration": "A String", # With this option a job is started a regular periodic basis. For

4960

# example: every day (86400 seconds).

4961

#

4962

# A scheduled start time will be skipped if the previous

4963

# execution has not ended when its scheduled time occurs.

4964

#

4965

# This value must be set to a time duration greater than or equal

4966

# to 1 day and can be no longer than 60 days.

4967

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4968

},

4969

],

4970

"errors": [ # Output only. A stream of errors encountered when the trigger was activated. Repeated

4971

# errors may result in the JobTrigger automatically being paused.

4972

# Will return the last 100 errors. Whenever the JobTrigger is modified

4973

# this list will be cleared.

4974

{ # Details information about an error encountered during job execution or

4975

# the results of an unsuccessful activation of the JobTrigger.

4976

"timestamps": [ # The times the error occurred.

4977

"A String",

4978

],

4979

"details": { # The `Status` type defines a logical error model that is suitable for # Detailed error codes and messages.

4980

# different programming environments, including REST APIs and RPC APIs. It is

4981

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

4982

# three pieces of data: error code, error message, and error details.

4983

#

4984

# You can find out more about this error model and how to work with it in the

4985

# [API Design Guide](https://cloud.google.com/apis/design/errors).

4986

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

4987

"details": [ # A list of messages that carry the error details. There is a common set of

4988

# message types for APIs to use.

4989

{

4990

"a_key": "", # Properties of the object. Contains field @type with type URL.

4991

},

4992

],

4993

"message": "A String", # A developer-facing error message, which should be in English. Any

4994

# user-facing error message should be localized and sent in the

4995

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4996

},

4997

},

4998

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4999

"updateTime": "A String", # Output only. The last update timestamp of a triggeredJob.

5000

"inspectJob": { # Controls what and how to inspect for findings. # For inspect jobs, a snapshot of the configuration.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5001

"inspectTemplateName": "A String", # If provided, will be used as the default for all values in InspectConfig.

5002

# `inspect_config` will be merged into the values persisted as part of the

5003

# template.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5004

"actions": [ # Actions to execute at the completion of the job.

5005

{ # A task to execute on the completion of a job.

5006

# See https://cloud.google.com/dlp/docs/concepts-actions to learn more.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5007

"publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This # Enable Stackdriver metric dlp.googleapis.com/finding_count.

5008

# will publish a metric to stack driver on each infotype requested and

5009

# how many findings were found for it. CustomDetectors will be bucketed

5010

# as 'Custom' under the Stackdriver label 'info_type'.

5011

},

5012

"publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Cloud Data Catalog. Labels summarizing the # Publish findings to Cloud Datahub.

5013

# results of the DlpJob will be applied to the entry for the resource scanned

5014

# in Cloud Data Catalog. Any labels previously written by another DlpJob will

5015

# be deleted. InfoType naming patterns are strictly enforced when using this

5016

# feature. Note that the findings will be persisted in Cloud Data Catalog

5017

# storage and are governed by Data Catalog service-specific policy, see

5018

# https://cloud.google.com/terms/service-terms

5019

# Only a single instance of this action can be specified and only allowed if

5020

# all resources being scanned are BigQuery tables.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5021

# Compatible with: Inspect

5022

},

5023

"jobNotificationEmails": { # Enable email notification to project owners and editors on jobs's # Enable email notification for project owners and editors on job's

5024

# completion/failure.

5025

# completion/failure.

5026

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5027

"pubSub": { # Publish a message into given Pub/Sub topic when DlpJob has completed. The # Publish a notification to a pubsub topic.

5028

# message contains a single field, `DlpJobName`, which is equal to the

5029

# finished job's

5030

# [`DlpJob.name`](https://cloud.google.com/dlp/docs/reference/rest/v2/projects.dlpJobs#DlpJob).

5031

# Compatible with: Inspect, Risk

5032

"topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given

5033

# publishing access rights to the DLP API service account executing

5034

# the long running DlpJob sending the notifications.

5035

# Format is projects/{project}/topics/{topic}.

5036

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5037

"saveFindings": { # If set, the detailed findings will be persisted to the specified # Save resulting findings in a provided location.

5038

# OutputStorageConfig. Only a single instance of this action can be

5039

# specified.

5040

# Compatible with: Inspect, Risk

5041

"outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5042

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only

5043

# used for Inspect and must be unspecified for Risk jobs. Columns are derived

5044

# from the `Finding` object. If appending to an existing table, any columns

5045

# from the predefined schema that are missing will be added. No columns in

5046

# the existing table will be deleted.

5047

#

5048

# If unspecified, then all available columns will be used for a new table or

5049

# an (existing) table with no schema, and no changes will be made to an

5050

# existing table that has a schema.

5051

# Only for use with external storage.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5052

"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

5053

# dataset. If table_id is not set a new one will be generated

5054

# for you with the following format:

5055

# dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific timezone will be used for

5056

# generating the date details.

5057

#

5058

# For Inspect, each column in an existing output table must have the same

5059

# name, type, and mode of a field in the `Finding` object.

5060

#

5061

# For Risk, an existing output table should be the output of a previous

5062

# Risk analysis job run on the same source table, with the same privacy

5063

# metric and quasi-identifiers. Risk jobs that analyze the same table but

5064

# compute a different privacy metric, or use different sets of

5065

# quasi-identifiers, cannot store their results in the same table.

5066

# identified by its project_id, dataset_id, and table_name. Within a query

5067

# a table is often referenced with a string in the format of:

5068

# `<project_id>:<dataset_id>.<table_id>` or

5069

# `<project_id>.<dataset_id>.<table_id>`.

5070

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table.

5071

# If omitted, project ID is inferred from the API call.

5072

"datasetId": "A String", # Dataset ID of the table.

5073

"tableId": "A String", # Name of the table.

5074

},

5075

},

5076

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5077

"publishSummaryToCscc": { # Publish the result summary of a DlpJob to the Cloud Security # Publish summary to Cloud Security Command Center (Alpha).

5078

# Command Center (CSCC Alpha).

5079

# This action is only available for projects which are parts of

5080

# an organization and whitelisted for the alpha Cloud Security Command

5081

# Center.

5082

# The action will publish count of finding instances and their info types.

5083

# The summary of findings will be persisted in CSCC and are governed by CSCC

5084

# service-specific policy, see https://cloud.google.com/terms/service-terms

5085

# Only a single instance of this action can be specified.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5086

# Compatible with: Inspect

5087

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5088

},

5089

],

5090

"storageConfig": { # Shared message indicating Cloud storage type. # The data to scan.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5091

"cloudStorageOptions": { # Options defining a file or a set of files within a Google Cloud Storage # Google Cloud Storage options.

5092

# bucket.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5093

"bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The

5094

# number of bytes scanned is rounded down. Must be between 0 and 100,

5095

# inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one

5096

# of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.

5097

"fileTypes": [ # List of file type groups to include in the scan.

5098

# If empty, all files are scanned and available data format processors

5099

# are applied. In addition, the binary content of the selected files

5100

# is always scanned as well.

5101

# Images are scanned only as binary if the specified region

5102

# does not support image inspection and no file_types were specified.

5103

# Image inspection is restricted to 'global', 'us', 'asia', and 'europe'.

5104

"A String",

5105

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5106

"bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger

5107

# than this value then the rest of the bytes are omitted. Only one

5108

# of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5109

"filesLimitPercent": 42, # Limits the number of files to scan to this percentage of the input FileSet.

5110

# Number of files scanned is rounded down. Must be between 0 and 100,

5111

# inclusively. Both 0 and 100 means no limit. Defaults to 0.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5112

"fileSet": { # Set of files to scan. # The set of one or more files to scan.

5113

"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

5114

# `regex_file_set` must be set.

5115

# expressions are used to allow fine-grained control over which files in the

5116

# bucket to include.

5117

#

5118

# Included files are those that match at least one item in `include_regex` and

5119

# do not match any items in `exclude_regex`. Note that a file that matches

5120

# items from both lists will _not_ be included. For a match to occur, the

5121

# entire file path (i.e., everything in the url after the bucket name) must

5122

# match the regular expression.

5123

#

5124

# For example, given the input `{bucket_name: "mybucket", include_regex:

5125

# ["directory1/.*"], exclude_regex:

5126

# ["directory1/excluded.*"]}`:

5127

#

5128

# * `gs://mybucket/directory1/myfile` will be included

5129

# * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches

5130

# across `/`)

5131

# * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the

5132

# full path doesn't match any items in `include_regex`)

5133

# * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path

5134

# matches an item in `exclude_regex`)

5135

#

5136

# If `include_regex` is left empty, it will match all files by default

5137

# (this is equivalent to setting `include_regex: [".*"]`).

5138

#

5139

# Some other common use cases:

5140

#

5141

# * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all

5142

# files in `mybucket` except for .pdf files

5143

# * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will

5144

# include all files directly under `gs://mybucket/directory/`, without matching

5145

# across `/`

5146

"bucketName": "A String", # The name of a Cloud Storage bucket. Required.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5147

"excludeRegex": [ # A list of regular expressions matching file paths to exclude. All files in

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5148

# the bucket that match at least one of these regular expressions will be

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5149

# excluded from the scan.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5150

#

5151

# Regular expressions use RE2

5152

# [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found

5153

# under the google/re2 repository on GitHub.

5154

"A String",

5155

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5156

"includeRegex": [ # A list of regular expressions matching file paths to include. All files in

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5157

# the bucket that match at least one of these regular expressions will be

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5158

# included in the set of files, except for those that also match an item in

5159

# `exclude_regex`. Leaving this field empty will match all files by default

5160

# (this is equivalent to including `.*` in the list).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5161

#

5162

# Regular expressions use RE2

5163

# [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found

5164

# 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

5169

# `gs://<bucket>/<path>`. Trailing wildcard in the path is allowed.

5170

#

5171

# If the url ends in a trailing slash, the bucket or directory represented

5172

# by the url will be scanned non-recursively (content in sub-directories

5173

# will not be scanned). This means that `gs://mybucket/` is equivalent to

5174

# `gs://mybucket/*`, and `gs://mybucket/directory/` is equivalent to

5175

# `gs://mybucket/directory/*`.

5176

#

5177

# Exactly one of `url` or `regex_file_set` must be set.

5178

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5179

"sampleMethod": "A String",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5180

},

5181

"bigQueryOptions": { # Options defining BigQuery table and row identifiers. # BigQuery options.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5182

"sampleMethod": "A String",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5183

"tableReference": { # Message defining the location of a BigQuery table. A table is uniquely # Complete BigQuery table reference.

5184

# identified by its project_id, dataset_id, and table_name. Within a query

5185

# a table is often referenced with a string in the format of:

5186

# `<project_id>:<dataset_id>.<table_id>` or

5187

# `<project_id>.<dataset_id>.<table_id>`.

5188

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table.

5189

# If omitted, project ID is inferred from the API call.

5190

"datasetId": "A String", # Dataset ID of the table.

5191

"tableId": "A String", # Name of the table.

5192

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5193

"rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows

5194

# scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and

5195

# 100 means no limit. Defaults to 0. Only one of rows_limit and

5196

# rows_limit_percent can be specified. Cannot be used in conjunction with

5197

# TimespanConfig.

5198

"rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the

5199

# rest of the rows are omitted. If not set, or if set to 0, all rows will be

5200

# scanned. Only one of rows_limit and rows_limit_percent can be specified.

5201

# Cannot be used in conjunction with TimespanConfig.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5202

"identifyingFields": [ # Table fields that may uniquely identify a row within the table. When

5203

# `actions.saveFindings.outputConfig.table` is specified, the values of

5204

# columns specified here are available in the output table under

5205

# `location.content_locations.record_location.record_key.id_values`. Nested

5206

# fields such as `person.birthdate.year` are allowed.

5207

{ # General identifier of a data field in a storage service.

5208

"name": "A String", # Name describing the field.

5209

},

5210

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5211

"excludedFields": [ # References to fields excluded from scanning. This allows you to skip

5212

# inspection of entire columns which you know have no findings.

5213

{ # General identifier of a data field in a storage service.

5214

"name": "A String", # Name describing the field.

5215

},

5216

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5217

},

5218

"timespanConfig": { # Configuration of the timespan of the items to include in scanning.

5219

# Currently only supported when inspecting Google Cloud Storage and BigQuery.

5220

"timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items.

5221

# Used for data sources like Datastore and BigQuery.

5222

#

5223

# For BigQuery:

5224

# Required to filter out rows based on the given start and

5225

# end times. If not specified and the table was modified between the given

5226

# start and end times, the entire table will be scanned.

5227

# The valid data types of the timestamp field are: `INTEGER`, `DATE`,

5228

# `TIMESTAMP`, or `DATETIME` BigQuery column.

5229

#

5230

# For Datastore.

5231

# Valid data types of the timestamp field are: `TIMESTAMP`.

5232

# Datastore entity will be scanned if the timestamp property does not

5233

# exist or its value is empty or invalid.

5234

"name": "A String", # Name describing the field.

5235

},

5236

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out

5237

# a valid start_time to avoid scanning files that have not been modified

5238

# since the last time the JobTrigger executed. This will be based on the

5239

# time of the execution of the last run of the JobTrigger.

5240

"startTime": "A String", # Exclude files or rows older than this value.

5241

"endTime": "A String", # Exclude files or rows newer than this value.

5242

# If set to zero, no upper time limit is applied.

5243

},

5244

"datastoreOptions": { # Options defining a data set within Google Cloud Datastore. # Google Cloud Datastore options.

5245

"kind": { # A representation of a Datastore kind. # The kind to process.

5246

"name": "A String", # The name of the kind.

5247

},

5248

"partitionId": { # Datastore partition ID. # A partition ID identifies a grouping of entities. The grouping is always

5249

# by project and namespace, however the namespace ID may be empty.

5250

# A partition ID identifies a grouping of entities. The grouping is always

5251

# by project and namespace, however the namespace ID may be empty.

5252

#

5253

# A partition ID contains several dimensions:

5254

# project ID and namespace ID.

5255

"namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.

5256

"projectId": "A String", # The ID of the project to which the entities belong.

5257

},

5258

},

5259

"hybridOptions": { # Configuration to control jobs where the content being inspected is outside # Hybrid inspection options.

5260

# Early access feature is in a pre-release state and might change or have

5261

# limited support. For more information, see

5262

# https://cloud.google.com/products#product-launch-stages.

5263

# of Google Cloud Platform.

5264

"tableOptions": { # Instructions regarding the table content being inspected. # If the container is a table, additional information to make findings

5265

# meaningful such as the columns that are primary keys.

5266

"identifyingFields": [ # The columns that are the primary keys for table objects included in

5267

# ContentItem. A copy of this cell's value will stored alongside alongside

5268

# each finding so that the finding can be traced to the specific row it came

5269

# from. No more than 3 may be provided.

5270

{ # General identifier of a data field in a storage service.

5271

"name": "A String", # Name describing the field.

},

],

},

"requiredFindingLabelKeys": [ # These are labels that each inspection request must include within their

5276

# 'finding_labels' map. Request may contain others, but any missing one of

5277

# these will be rejected.

5278

#

5279

# Label keys must be between 1 and 63 characters long and must conform

5280

# to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.

5281

#

5282

# No more than 10 keys can be required.

5283

"A String",

5284

],

5285

"labels": { # To organize findings, these labels will be added to each finding.

5286

#

5287

# Label keys must be between 1 and 63 characters long and must conform

5288

# to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.

5289

#

5290

# Label values must be between 0 and 63 characters long and must conform

5291

# to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.

5292

#

5293

# No more than 10 labels can be associated with a given finding.

5294

#

5295

# Examples:

5296

# * `"environment" : "production"`

5297

# * `"pipeline" : "etl"`

5298

"a_key": "A String",

5299

},

5300

"description": "A String", # A short description of where the data is coming from. Will be stored once

5301

# in the job. 256 max length.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5302

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5303

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5304

"inspectConfig": { # Configuration description of the scanning process. # How and what to scan for.

5305

# When used with redactContent only info_types and min_likelihood are currently

5306

# used.

5307

"customInfoTypes": [ # CustomInfoTypes provided by the user. See

5308

# https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more.

5309

{ # Custom information type provided by the user. Used to find domain-specific

5310

# sensitive information configurable to the data in question.

5311

"dictionary": { # Custom information type based on a dictionary of words or phrases. This can # A list of phrases to detect as a CustomInfoType.

5312

# be used to match sensitive information specific to the data, such as a list

5313

# of employee IDs or job titles.

5314

#

5315

# Dictionary words are case-insensitive and all characters other than letters

5316

# and digits in the unicode [Basic Multilingual

5317

# Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane)

5318

# will be replaced with whitespace when scanning for matches, so the

5319

# dictionary phrase "Sam Johnson" will match all three phrases "sam johnson",

5320

# "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters

5321

# surrounding any match must be of a different type than the adjacent

5322

# characters within the word, so letters must be next to non-letters and

5323

# digits next to non-digits. For example, the dictionary word "jen" will

5324

# match the first three letters of the text "jen123" but will return no

5325

# matches for "jennifer".

5326

#

5327

# Dictionary words containing a large number of characters that are not

5328

# letters or digits may result in unexpected findings because such characters

5329

# are treated as whitespace. The

5330

# [limits](https://cloud.google.com/dlp/limits) page contains details about

5331

# the size limits of dictionaries. For dictionaries that do not fit within

5332

# these constraints, consider using `LargeCustomDictionaryConfig` in the

5333

# `StoredInfoType` API.

5334

"cloudStoragePath": { # Message representing a single file or path in Cloud Storage. # Newline-delimited file of words in Cloud Storage. Only a single file

5335

# is accepted.

5336

"path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage.

5337

# Example: gs://[BUCKET_NAME]/dictionary.txt

5338

},

5339

"wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for.

5340

"words": [ # Words or phrases defining the dictionary. The dictionary must contain

5341

# at least one phrase and every phrase must contain at least 2 characters

5342

# that are letters or digits. [required]

"A String",

],

},

},

"infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in

5348

# infoType, when the name matches one of existing infoTypes and that infoType

5349

# is specified in `InspectContent.info_types` field. Specifying the latter

5350

# adds findings to the one detected by the system. If built-in info type is

5351

# not specified in `InspectContent.info_types` list then the name is treated

5352

# as a custom info type.

5353

"name": "A String", # Name of the information type. Either a name of your choosing when

5354

# creating a CustomInfoType, or one of the names listed

5355

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

5356

# a built-in type. When sending Cloud DLP results to Data Catalog, infoType

5357

# names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

5358

},

5359

"likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be

5360

# altered by a detection rule if the finding meets the criteria specified by

5361

# the rule. Defaults to `VERY_LIKELY` if not specified.

5362

"detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType.

5363

# Rules are applied in order that they are specified. Not supported for the

5364

# `surrogate_type` CustomInfoType.

5365

{ # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a

5366

# `CustomInfoType` to alter behavior under certain circumstances, depending

5367

# on the specific details of the rule. Not supported for the `surrogate_type`

5368

# custom infoType.

5369

"hotwordRule": { # The rule that adjusts the likelihood of findings within a certain # Hotword-based detection rule.

5370

# proximity of hotwords.

5371

"proximity": { # Message for specifying a window around a finding to apply a detection # Proximity of the finding within which the entire hotword must reside.

5372

# The total length of the window cannot exceed 1000 characters. Note that

5373

# the finding itself will be included in the window, so that hotwords may

5374

# be used to match substrings of the finding itself. For example, the

5375

# certainty of a phone number regex "$\d{3}$ \d{3}-\d{4}" could be

5376

# adjusted upwards if the area code is known to be the local area code of

5377

# a company office using the hotword regex "$xxx$", where "xxx"

5378

# is the area code in question.

5379

# rule.

5380

"windowAfter": 42, # Number of characters after the finding to consider.

5381

"windowBefore": 42, # Number of characters before the finding to consider.

5382

},

5383

"likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as # Likelihood adjustment to apply to all matching findings.

5384

# part of a detection rule.

5385

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value.

5386

"relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of

5387

# levels. For example, if a finding would be `POSSIBLE` without the

5388

# detection rule and `relative_likelihood` is 1, then it is upgraded to

5389

# `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`.

5390

# Likelihood may never drop below `VERY_UNLIKELY` or exceed

5391

# `VERY_LIKELY`, so applying an adjustment of 1 followed by an

5392

# adjustment of -1 when base likelihood is `VERY_LIKELY` will result in

5393

# a final likelihood of `LIKELY`.

5394

},

5395

"hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword.

5396

"groupIndexes": [ # The index of the submatch to extract as findings. When not

5397

# specified, the entire match is returned. No more than 3 may be included.

5398

42,

5399

],

5400

"pattern": "A String", # Pattern defining the regular expression. Its syntax

5401

# (https://github.com/google/re2/wiki/Syntax) can be found under the

5402

# google/re2 repository on GitHub.

},

},

},

],

"surrogateType": { # Message for detecting output from deidentification transformations # Message for detecting output from deidentification transformations that

5408

# support reversing.

5409

# such as

5410

# [`CryptoReplaceFfxFpeConfig`](https://cloud.google.com/dlp/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig).

5411

# These types of transformations are

5412

# those that perform pseudonymization, thereby producing a "surrogate" as

5413

# output. This should be used in conjunction with a field on the

5414

# transformation such as `surrogate_info_type`. This CustomInfoType does

5415

# not support the use of `detection_rules`.

5416

},

5417

"regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType.

5418

"groupIndexes": [ # The index of the submatch to extract as findings. When not

5419

# specified, the entire match is returned. No more than 3 may be included.

5420

42,

5421

],

5422

"pattern": "A String", # Pattern defining the regular expression. Its syntax

5423

# (https://github.com/google/re2/wiki/Syntax) can be found under the

5424

# google/re2 repository on GitHub.

5425

},

5426

"storedType": { # A reference to a StoredInfoType to use with scanning. # Load an existing `StoredInfoType` resource for use in

5427

# `InspectDataSource`. Not currently supported in `InspectContent`.

5428

"name": "A String", # Resource name of the requested `StoredInfoType`, for example

5429

# `organizations/433245324/storedInfoTypes/432452342` or

5430

# `projects/project-id/storedInfoTypes/432452342`.

5431

"createTime": "A String", # Timestamp indicating when the version of the `StoredInfoType` used for

5432

# inspection was created. Output-only field, populated by the system.

5433

},

5434

"exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding

5435

# to be returned. It still can be used for rules matching.

5436

},

5437

],

5438

"minLikelihood": "A String", # Only returns findings equal or above this threshold. The default is

5439

# POSSIBLE.

5440

# See https://cloud.google.com/dlp/docs/likelihood to learn more.

5441

"limits": { # Configuration to control the number of findings returned. # Configuration to control the number of findings returned.

5442

"maxFindingsPerRequest": 42, # Max number of findings that will be returned per request/job.

5443

# When set within `InspectContentRequest`, the maximum returned is 2000

5444

# regardless if this is set higher.

5445

"maxFindingsPerInfoType": [ # Configuration of findings limit given for specified infoTypes.

5446

{ # Max findings configuration per infoType, per content item or long

5447

# running DlpJob.

5448

"infoType": { # Type of information detected by the API. # Type of information the findings limit applies to. Only one limit per

5449

# info_type should be provided. If InfoTypeLimit does not have an

5450

# info_type, the DLP API applies the limit against all info_types that

5451

# are found but not specified in another InfoTypeLimit.

5452

"name": "A String", # Name of the information type. Either a name of your choosing when

5453

# creating a CustomInfoType, or one of the names listed

5454

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

5455

# a built-in type. When sending Cloud DLP results to Data Catalog, infoType

5456

# names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

5457

},

5458

"maxFindings": 42, # Max findings limit for the given infoType.

5459

},

5460

],

5461

"maxFindingsPerItem": 42, # Max number of findings that will be returned for each item scanned.

5462

# When set within `InspectJobConfig`,

5463

# the maximum returned is 2000 regardless if this is set higher.

5464

# When set within `InspectContentRequest`, this field is ignored.

5465

},

5466

"excludeInfoTypes": True or False, # When true, excludes type information of the findings.

5467

"includeQuote": True or False, # When true, a contextual quote from the data that triggered a finding is

5468

# included in the response; see Finding.quote.

5469

"ruleSet": [ # Set of rules to apply to the findings for this InspectConfig.

5470

# Exclusion rules, contained in the set are executed in the end, other

5471

# rules are executed in the order they are specified for each info type.

5472

{ # Rule set for modifying a set of infoTypes to alter behavior under certain

5473

# circumstances, depending on the specific details of the rules within the set.

5474

"infoTypes": [ # List of infoTypes this rule set is applied to.

5475

{ # Type of information detected by the API.

5476

"name": "A String", # Name of the information type. Either a name of your choosing when

5477

# creating a CustomInfoType, or one of the names listed

5478

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

5479

# a built-in type. When sending Cloud DLP results to Data Catalog, infoType

5480

# names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

5481

},

5482

],

5483

"rules": [ # Set of rules to be applied to infoTypes. The rules are applied in order.

5484

{ # A single inspection rule to be applied to infoTypes, specified in

5485

# `InspectionRuleSet`.

5486

"hotwordRule": { # The rule that adjusts the likelihood of findings within a certain # Hotword-based detection rule.

5487

# proximity of hotwords.

5488

"proximity": { # Message for specifying a window around a finding to apply a detection # Proximity of the finding within which the entire hotword must reside.

5489

# The total length of the window cannot exceed 1000 characters. Note that

5490

# the finding itself will be included in the window, so that hotwords may

5491

# be used to match substrings of the finding itself. For example, the

5492

# certainty of a phone number regex "$\d{3}$ \d{3}-\d{4}" could be

5493

# adjusted upwards if the area code is known to be the local area code of

5494

# a company office using the hotword regex "$xxx$", where "xxx"

5495

# is the area code in question.

5496

# rule.

5497

"windowAfter": 42, # Number of characters after the finding to consider.

5498

"windowBefore": 42, # Number of characters before the finding to consider.

5499

},

5500

"likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as # Likelihood adjustment to apply to all matching findings.

5501

# part of a detection rule.

5502

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value.

5503

"relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of

5504

# levels. For example, if a finding would be `POSSIBLE` without the

5505

# detection rule and `relative_likelihood` is 1, then it is upgraded to

5506

# `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`.

5507

# Likelihood may never drop below `VERY_UNLIKELY` or exceed

5508

# `VERY_LIKELY`, so applying an adjustment of 1 followed by an

5509

# adjustment of -1 when base likelihood is `VERY_LIKELY` will result in

5510

# a final likelihood of `LIKELY`.

5511

},

5512

"hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword.

5513

"groupIndexes": [ # The index of the submatch to extract as findings. When not

5514

# specified, the entire match is returned. No more than 3 may be included.

5515

42,

5516

],

5517

"pattern": "A String", # Pattern defining the regular expression. Its syntax

5518

# (https://github.com/google/re2/wiki/Syntax) can be found under the

5519

# google/re2 repository on GitHub.

5520

},

5521

},

5522

"exclusionRule": { # The rule that specifies conditions when findings of infoTypes specified in # Exclusion rule.

5523

# `InspectionRuleSet` are removed from results.

5524

"matchingType": "A String", # How the rule is applied, see MatchingType documentation for details.

5525

"dictionary": { # Custom information type based on a dictionary of words or phrases. This can # Dictionary which defines the rule.

5526

# be used to match sensitive information specific to the data, such as a list

5527

# of employee IDs or job titles.

5528

#

5529

# Dictionary words are case-insensitive and all characters other than letters

5530

# and digits in the unicode [Basic Multilingual

5531

# Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane)

5532

# will be replaced with whitespace when scanning for matches, so the

5533

# dictionary phrase "Sam Johnson" will match all three phrases "sam johnson",

5534

# "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters

5535

# surrounding any match must be of a different type than the adjacent

5536

# characters within the word, so letters must be next to non-letters and

5537

# digits next to non-digits. For example, the dictionary word "jen" will

5538

# match the first three letters of the text "jen123" but will return no

5539

# matches for "jennifer".

5540

#

5541

# Dictionary words containing a large number of characters that are not

5542

# letters or digits may result in unexpected findings because such characters

5543

# are treated as whitespace. The

5544

# [limits](https://cloud.google.com/dlp/limits) page contains details about

5545

# the size limits of dictionaries. For dictionaries that do not fit within

5546

# these constraints, consider using `LargeCustomDictionaryConfig` in the

5547

# `StoredInfoType` API.

5548

"cloudStoragePath": { # Message representing a single file or path in Cloud Storage. # Newline-delimited file of words in Cloud Storage. Only a single file

5549

# is accepted.

5550

"path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage.

5551

# Example: gs://[BUCKET_NAME]/dictionary.txt

5552

},

5553

"wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for.

5554

"words": [ # Words or phrases defining the dictionary. The dictionary must contain

5555

# at least one phrase and every phrase must contain at least 2 characters

5556

# that are letters or digits. [required]

"A String",

],

},

},

"excludeInfoTypes": { # List of exclude infoTypes. # Set of infoTypes for which findings would affect this rule.

5562

"infoTypes": [ # InfoType list in ExclusionRule rule drops a finding when it overlaps or

5563

# contained within with a finding of an infoType from this list. For

5564

# example, for `InspectionRuleSet.info_types` containing "PHONE_NUMBER"` and

5565

# `exclusion_rule` containing `exclude_info_types.info_types` with

5566

# "EMAIL_ADDRESS" the phone number findings are dropped if they overlap

5567

# with EMAIL_ADDRESS finding.

5568

# That leads to "555-222-2222@example.org" to generate only a single

5569

# finding, namely email address.

5570

{ # Type of information detected by the API.

5571

"name": "A String", # Name of the information type. Either a name of your choosing when

5572

# creating a CustomInfoType, or one of the names listed

5573

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

5574

# a built-in type. When sending Cloud DLP results to Data Catalog, infoType

5575

# names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

},

],

},

"regex": { # Message defining a custom regular expression. # Regular expression which defines the rule.

5580

"groupIndexes": [ # The index of the submatch to extract as findings. When not

5581

# specified, the entire match is returned. No more than 3 may be included.

5582

42,

5583

],

5584

"pattern": "A String", # Pattern defining the regular expression. Its syntax

5585

# (https://github.com/google/re2/wiki/Syntax) can be found under the

5586

# google/re2 repository on GitHub.

},

},

},

],

},

],

"contentOptions": [ # List of options defining data content to scan.

5594

# If empty, text, images, and other content will be included.

5595

"A String",

5596

],

5597

"infoTypes": [ # Restricts what info_types to look for. The values must correspond to

5598

# InfoType values returned by ListInfoTypes or listed at

5599

# https://cloud.google.com/dlp/docs/infotypes-reference.

5600

#

5601

# When no InfoTypes or CustomInfoTypes are specified in a request, the

5602

# system may automatically choose what detectors to run. By default this may

5603

# be all types, but may change over time as detectors are updated.

5604

#

5605

# If you need precise control and predictability as to what detectors are

5606

# run you should specify specific InfoTypes listed in the reference,

5607

# otherwise a default list will be used, which may change over time.

5608

{ # Type of information detected by the API.

5609

"name": "A String", # Name of the information type. Either a name of your choosing when

5610

# creating a CustomInfoType, or one of the names listed

5611

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

5612

# a built-in type. When sending Cloud DLP results to Data Catalog, infoType

5613

# names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

5614

},

5615

],

5616

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5617

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5618

"name": "A String", # Unique resource name for the triggeredJob, assigned by the service when the

5619

# triggeredJob is created, for example

5620

# `projects/dlp-test-project/jobTriggers/53234423`.

5621

"displayName": "A String", # Display name (max 100 chars)

5622

"lastRunTime": "A String", # Output only. The timestamp of the last time this trigger executed.

5623

"createTime": "A String", # Output only. The creation timestamp of a triggeredJob.

5624

"description": "A String", # User provided description (max 256 chars)

Bu Sun Kim

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:

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

2020-07-22 17:02:09 -0700

[diff] [blame^]

5638

"status": "A String", # Required. A status for this trigger.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5639

"triggers": [ # A list of triggers which will be OR'ed together. Only one in the list

5640

# needs to trigger for a job to be started. The list may contain only

5641

# a single Schedule trigger and must have at least one object.

5642

{ # What event needs to occur for a new job to be started.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5643

"manual": { # Job trigger option for hybrid jobs. Jobs must be manually created # For use with hybrid jobs. Jobs must be manually created and finished.

5644

# Early access feature is in a pre-release state and might change or have

5645

# limited support. For more information, see

5646

# https://cloud.google.com/products#product-launch-stages.

5647

# and finished.

5648

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5649

"schedule": { # Schedule for triggeredJobs. # Create a job on a repeating basis based on the elapse of time.

5650

"recurrencePeriodDuration": "A String", # With this option a job is started a regular periodic basis. For

5651

# example: every day (86400 seconds).

5652

#

5653

# A scheduled start time will be skipped if the previous

5654

# execution has not ended when its scheduled time occurs.

5655

#

5656

# This value must be set to a time duration greater than or equal

5657

# to 1 day and can be no longer than 60 days.

5658

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5659

},

5660

],

5661

"errors": [ # Output only. A stream of errors encountered when the trigger was activated. Repeated

5662

# errors may result in the JobTrigger automatically being paused.

5663

# Will return the last 100 errors. Whenever the JobTrigger is modified

5664

# this list will be cleared.

5665

{ # Details information about an error encountered during job execution or

5666

# the results of an unsuccessful activation of the JobTrigger.

5667

"timestamps": [ # The times the error occurred.

5668

"A String",

5669

],

5670

"details": { # The `Status` type defines a logical error model that is suitable for # Detailed error codes and messages.

5671

# different programming environments, including REST APIs and RPC APIs. It is

5672

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

5673

# three pieces of data: error code, error message, and error details.

5674

#

5675

# You can find out more about this error model and how to work with it in the

5676

# [API Design Guide](https://cloud.google.com/apis/design/errors).

5677

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

5678

"details": [ # A list of messages that carry the error details. There is a common set of

5679

# message types for APIs to use.

5680

{

5681

"a_key": "", # Properties of the object. Contains field @type with type URL.

5682

},

5683

],

5684

"message": "A String", # A developer-facing error message, which should be in English. Any

5685

# user-facing error message should be localized and sent in the

5686

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5687

},

5688

},

5689

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5690

"updateTime": "A String", # Output only. The last update timestamp of a triggeredJob.

5691

"inspectJob": { # Controls what and how to inspect for findings. # For inspect jobs, a snapshot of the configuration.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5692

"inspectTemplateName": "A String", # If provided, will be used as the default for all values in InspectConfig.

5693

# `inspect_config` will be merged into the values persisted as part of the

5694

# template.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5695

"actions": [ # Actions to execute at the completion of the job.

5696

{ # A task to execute on the completion of a job.

5697

# See https://cloud.google.com/dlp/docs/concepts-actions to learn more.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5698

"publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This # Enable Stackdriver metric dlp.googleapis.com/finding_count.

5699

# will publish a metric to stack driver on each infotype requested and

5700

# how many findings were found for it. CustomDetectors will be bucketed

5701

# as 'Custom' under the Stackdriver label 'info_type'.

5702

},

5703

"publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Cloud Data Catalog. Labels summarizing the # Publish findings to Cloud Datahub.

5704

# results of the DlpJob will be applied to the entry for the resource scanned

5705

# in Cloud Data Catalog. Any labels previously written by another DlpJob will

5706

# be deleted. InfoType naming patterns are strictly enforced when using this

5707

# feature. Note that the findings will be persisted in Cloud Data Catalog

5708

# storage and are governed by Data Catalog service-specific policy, see

5709

# https://cloud.google.com/terms/service-terms

5710

# Only a single instance of this action can be specified and only allowed if

5711

# all resources being scanned are BigQuery tables.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5712

# Compatible with: Inspect

5713

},

5714

"jobNotificationEmails": { # Enable email notification to project owners and editors on jobs's # Enable email notification for project owners and editors on job's

5715

# completion/failure.

5716

# completion/failure.

5717

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5718

"pubSub": { # Publish a message into given Pub/Sub topic when DlpJob has completed. The # Publish a notification to a pubsub topic.

5719

# message contains a single field, `DlpJobName`, which is equal to the

5720

# finished job's

5721

# [`DlpJob.name`](https://cloud.google.com/dlp/docs/reference/rest/v2/projects.dlpJobs#DlpJob).

5722

# Compatible with: Inspect, Risk

5723

"topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given

5724

# publishing access rights to the DLP API service account executing

5725

# the long running DlpJob sending the notifications.

5726

# Format is projects/{project}/topics/{topic}.

5727

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5728

"saveFindings": { # If set, the detailed findings will be persisted to the specified # Save resulting findings in a provided location.

5729

# OutputStorageConfig. Only a single instance of this action can be

5730

# specified.

5731

# Compatible with: Inspect, Risk

5732

"outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5733

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only

5734

# used for Inspect and must be unspecified for Risk jobs. Columns are derived

5735

# from the `Finding` object. If appending to an existing table, any columns

5736

# from the predefined schema that are missing will be added. No columns in

5737

# the existing table will be deleted.

5738

#

5739

# If unspecified, then all available columns will be used for a new table or

5740

# an (existing) table with no schema, and no changes will be made to an

5741

# existing table that has a schema.

5742

# Only for use with external storage.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5743

"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

5744

# dataset. If table_id is not set a new one will be generated

5745

# for you with the following format:

5746

# dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific timezone will be used for

5747

# generating the date details.

5748

#

5749

# For Inspect, each column in an existing output table must have the same

5750

# name, type, and mode of a field in the `Finding` object.

5751

#

5752

# For Risk, an existing output table should be the output of a previous

5753

# Risk analysis job run on the same source table, with the same privacy

5754

# metric and quasi-identifiers. Risk jobs that analyze the same table but

5755

# compute a different privacy metric, or use different sets of

5756

# quasi-identifiers, cannot store their results in the same table.

5757

# identified by its project_id, dataset_id, and table_name. Within a query

5758

# a table is often referenced with a string in the format of:

5759

# `<project_id>:<dataset_id>.<table_id>` or

5760

# `<project_id>.<dataset_id>.<table_id>`.

5761

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table.

5762

# If omitted, project ID is inferred from the API call.

5763

"datasetId": "A String", # Dataset ID of the table.

5764

"tableId": "A String", # Name of the table.

5765

},

5766

},

5767

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5768

"publishSummaryToCscc": { # Publish the result summary of a DlpJob to the Cloud Security # Publish summary to Cloud Security Command Center (Alpha).

5769

# Command Center (CSCC Alpha).

5770

# This action is only available for projects which are parts of

5771

# an organization and whitelisted for the alpha Cloud Security Command

5772

# Center.

5773

# The action will publish count of finding instances and their info types.

5774

# The summary of findings will be persisted in CSCC and are governed by CSCC

5775

# service-specific policy, see https://cloud.google.com/terms/service-terms

5776

# Only a single instance of this action can be specified.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5777

# Compatible with: Inspect

5778

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5779

},

5780

],

5781

"storageConfig": { # Shared message indicating Cloud storage type. # The data to scan.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5782

"cloudStorageOptions": { # Options defining a file or a set of files within a Google Cloud Storage # Google Cloud Storage options.

5783

# bucket.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5784

"bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The

5785

# number of bytes scanned is rounded down. Must be between 0 and 100,

5786

# inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one

5787

# of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.

5788

"fileTypes": [ # List of file type groups to include in the scan.

5789

# If empty, all files are scanned and available data format processors

5790

# are applied. In addition, the binary content of the selected files

5791

# is always scanned as well.

5792

# Images are scanned only as binary if the specified region

5793

# does not support image inspection and no file_types were specified.

5794

# Image inspection is restricted to 'global', 'us', 'asia', and 'europe'.

5795

"A String",

5796

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5797

"bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger

5798

# than this value then the rest of the bytes are omitted. Only one

5799

# of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5800

"filesLimitPercent": 42, # Limits the number of files to scan to this percentage of the input FileSet.

5801

# Number of files scanned is rounded down. Must be between 0 and 100,

5802

# inclusively. Both 0 and 100 means no limit. Defaults to 0.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5803

"fileSet": { # Set of files to scan. # The set of one or more files to scan.

5804

"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

5805

# `regex_file_set` must be set.

5806

# expressions are used to allow fine-grained control over which files in the

5807

# bucket to include.

5808

#

5809

# Included files are those that match at least one item in `include_regex` and

5810

# do not match any items in `exclude_regex`. Note that a file that matches

5811

# items from both lists will _not_ be included. For a match to occur, the

5812

# entire file path (i.e., everything in the url after the bucket name) must

5813

# match the regular expression.

5814

#

5815

# For example, given the input `{bucket_name: "mybucket", include_regex:

5816

# ["directory1/.*"], exclude_regex:

5817

# ["directory1/excluded.*"]}`:

5818

#

5819

# * `gs://mybucket/directory1/myfile` will be included

5820

# * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches

5821

# across `/`)

5822

# * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the

5823

# full path doesn't match any items in `include_regex`)

5824

# * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path

5825

# matches an item in `exclude_regex`)

5826

#

5827

# If `include_regex` is left empty, it will match all files by default

5828

# (this is equivalent to setting `include_regex: [".*"]`).

5829

#

5830

# Some other common use cases:

5831

#

5832

# * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all

5833

# files in `mybucket` except for .pdf files

5834

# * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will

5835

# include all files directly under `gs://mybucket/directory/`, without matching

5836

# across `/`

5837

"bucketName": "A String", # The name of a Cloud Storage bucket. Required.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5838

"excludeRegex": [ # A list of regular expressions matching file paths to exclude. All files in

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5839

# the bucket that match at least one of these regular expressions will be

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5840

# excluded from the scan.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5841

#

5842

# Regular expressions use RE2

5843

# [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found

5844

# under the google/re2 repository on GitHub.

5845

"A String",

5846

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5847

"includeRegex": [ # A list of regular expressions matching file paths to include. All files in

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5848

# the bucket that match at least one of these regular expressions will be

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5849

# included in the set of files, except for those that also match an item in

5850

# `exclude_regex`. Leaving this field empty will match all files by default

5851

# (this is equivalent to including `.*` in the list).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5852

#

5853

# Regular expressions use RE2

5854

# [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found

5855

# 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

5860

# `gs://<bucket>/<path>`. Trailing wildcard in the path is allowed.

5861

#

5862

# If the url ends in a trailing slash, the bucket or directory represented

5863

# by the url will be scanned non-recursively (content in sub-directories

5864

# will not be scanned). This means that `gs://mybucket/` is equivalent to

5865

# `gs://mybucket/*`, and `gs://mybucket/directory/` is equivalent to

5866

# `gs://mybucket/directory/*`.

5867

#

5868

# Exactly one of `url` or `regex_file_set` must be set.

5869

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5870

"sampleMethod": "A String",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5871

},

5872

"bigQueryOptions": { # Options defining BigQuery table and row identifiers. # BigQuery options.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5873

"sampleMethod": "A String",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5874

"tableReference": { # Message defining the location of a BigQuery table. A table is uniquely # Complete BigQuery table reference.

5875

# identified by its project_id, dataset_id, and table_name. Within a query

5876

# a table is often referenced with a string in the format of:

5877

# `<project_id>:<dataset_id>.<table_id>` or

5878

# `<project_id>.<dataset_id>.<table_id>`.

5879

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table.

5880

# If omitted, project ID is inferred from the API call.

5881

"datasetId": "A String", # Dataset ID of the table.

5882

"tableId": "A String", # Name of the table.

5883

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5884

"rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows

5885

# scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and

5886

# 100 means no limit. Defaults to 0. Only one of rows_limit and

5887

# rows_limit_percent can be specified. Cannot be used in conjunction with

5888

# TimespanConfig.

5889

"rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the

5890

# rest of the rows are omitted. If not set, or if set to 0, all rows will be

5891

# scanned. Only one of rows_limit and rows_limit_percent can be specified.

5892

# Cannot be used in conjunction with TimespanConfig.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5893

"identifyingFields": [ # Table fields that may uniquely identify a row within the table. When

5894

# `actions.saveFindings.outputConfig.table` is specified, the values of

5895

# columns specified here are available in the output table under

5896

# `location.content_locations.record_location.record_key.id_values`. Nested

5897

# fields such as `person.birthdate.year` are allowed.

5898

{ # General identifier of a data field in a storage service.

5899

"name": "A String", # Name describing the field.

5900

},

5901

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5902

"excludedFields": [ # References to fields excluded from scanning. This allows you to skip

5903

# inspection of entire columns which you know have no findings.

5904

{ # General identifier of a data field in a storage service.

5905

"name": "A String", # Name describing the field.

5906

},

5907

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5908

},

5909

"timespanConfig": { # Configuration of the timespan of the items to include in scanning.

5910

# Currently only supported when inspecting Google Cloud Storage and BigQuery.

5911

"timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items.

5912

# Used for data sources like Datastore and BigQuery.

5913

#

5914

# For BigQuery:

5915

# Required to filter out rows based on the given start and

5916

# end times. If not specified and the table was modified between the given

5917

# start and end times, the entire table will be scanned.

5918

# The valid data types of the timestamp field are: `INTEGER`, `DATE`,

5919

# `TIMESTAMP`, or `DATETIME` BigQuery column.

5920

#

5921

# For Datastore.

5922

# Valid data types of the timestamp field are: `TIMESTAMP`.

5923

# Datastore entity will be scanned if the timestamp property does not

5924

# exist or its value is empty or invalid.

5925

"name": "A String", # Name describing the field.

5926

},

5927

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out

5928

# a valid start_time to avoid scanning files that have not been modified

5929

# since the last time the JobTrigger executed. This will be based on the

5930

# time of the execution of the last run of the JobTrigger.

5931

"startTime": "A String", # Exclude files or rows older than this value.

5932

"endTime": "A String", # Exclude files or rows newer than this value.

5933

# If set to zero, no upper time limit is applied.

5934

},

5935

"datastoreOptions": { # Options defining a data set within Google Cloud Datastore. # Google Cloud Datastore options.

5936

"kind": { # A representation of a Datastore kind. # The kind to process.

5937

"name": "A String", # The name of the kind.

5938

},

5939

"partitionId": { # Datastore partition ID. # A partition ID identifies a grouping of entities. The grouping is always

5940

# by project and namespace, however the namespace ID may be empty.

5941

# A partition ID identifies a grouping of entities. The grouping is always

5942

# by project and namespace, however the namespace ID may be empty.

5943

#

5944

# A partition ID contains several dimensions:

5945

# project ID and namespace ID.

5946

"namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.

5947

"projectId": "A String", # The ID of the project to which the entities belong.

5948

},

5949

},

5950

"hybridOptions": { # Configuration to control jobs where the content being inspected is outside # Hybrid inspection options.

5951

# Early access feature is in a pre-release state and might change or have

5952

# limited support. For more information, see

5953

# https://cloud.google.com/products#product-launch-stages.

5954

# of Google Cloud Platform.

5955

"tableOptions": { # Instructions regarding the table content being inspected. # If the container is a table, additional information to make findings

5956

# meaningful such as the columns that are primary keys.

5957

"identifyingFields": [ # The columns that are the primary keys for table objects included in

5958

# ContentItem. A copy of this cell's value will stored alongside alongside

5959

# each finding so that the finding can be traced to the specific row it came

5960

# from. No more than 3 may be provided.

5961

{ # General identifier of a data field in a storage service.

5962

"name": "A String", # Name describing the field.

},

],

},

"requiredFindingLabelKeys": [ # These are labels that each inspection request must include within their

5967

# 'finding_labels' map. Request may contain others, but any missing one of

5968

# these will be rejected.

5969

#

5970

# Label keys must be between 1 and 63 characters long and must conform

5971

# to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.

5972

#

5973

# No more than 10 keys can be required.

5974

"A String",

5975

],

5976

"labels": { # To organize findings, these labels will be added to each finding.

5977

#

5978

# Label keys must be between 1 and 63 characters long and must conform

5979

# to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.

5980

#

5981

# Label values must be between 0 and 63 characters long and must conform

5982

# to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.

5983

#

5984

# No more than 10 labels can be associated with a given finding.

5985

#

5986

# Examples:

5987

# * `"environment" : "production"`

5988

# * `"pipeline" : "etl"`

5989

"a_key": "A String",

5990

},

5991

"description": "A String", # A short description of where the data is coming from. Will be stored once

5992

# in the job. 256 max length.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5993

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5994

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5995

"inspectConfig": { # Configuration description of the scanning process. # How and what to scan for.

5996

# When used with redactContent only info_types and min_likelihood are currently

5997

# used.

5998

"customInfoTypes": [ # CustomInfoTypes provided by the user. See

5999

# https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more.

6000

{ # Custom information type provided by the user. Used to find domain-specific

6001

# sensitive information configurable to the data in question.

6002

"dictionary": { # Custom information type based on a dictionary of words or phrases. This can # A list of phrases to detect as a CustomInfoType.

6003

# be used to match sensitive information specific to the data, such as a list

6004

# of employee IDs or job titles.

6005

#

6006

# Dictionary words are case-insensitive and all characters other than letters

6007

# and digits in the unicode [Basic Multilingual

6008

# Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane)

6009

# will be replaced with whitespace when scanning for matches, so the

6010

# dictionary phrase "Sam Johnson" will match all three phrases "sam johnson",

6011

# "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters

6012

# surrounding any match must be of a different type than the adjacent

6013

# characters within the word, so letters must be next to non-letters and

6014

# digits next to non-digits. For example, the dictionary word "jen" will

6015

# match the first three letters of the text "jen123" but will return no

6016

# matches for "jennifer".

6017

#

6018

# Dictionary words containing a large number of characters that are not

6019

# letters or digits may result in unexpected findings because such characters

6020

# are treated as whitespace. The

6021

# [limits](https://cloud.google.com/dlp/limits) page contains details about

6022

# the size limits of dictionaries. For dictionaries that do not fit within

6023

# these constraints, consider using `LargeCustomDictionaryConfig` in the

6024

# `StoredInfoType` API.

6025

"cloudStoragePath": { # Message representing a single file or path in Cloud Storage. # Newline-delimited file of words in Cloud Storage. Only a single file

6026

# is accepted.

6027

"path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage.

6028

# Example: gs://[BUCKET_NAME]/dictionary.txt

6029

},

6030

"wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for.

6031

"words": [ # Words or phrases defining the dictionary. The dictionary must contain

6032

# at least one phrase and every phrase must contain at least 2 characters

6033

# that are letters or digits. [required]

"A String",

],

},

},

"infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in

6039

# infoType, when the name matches one of existing infoTypes and that infoType

6040

# is specified in `InspectContent.info_types` field. Specifying the latter

6041

# adds findings to the one detected by the system. If built-in info type is

6042

# not specified in `InspectContent.info_types` list then the name is treated

6043

# as a custom info type.

6044

"name": "A String", # Name of the information type. Either a name of your choosing when

6045

# creating a CustomInfoType, or one of the names listed

6046

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

6047

# a built-in type. When sending Cloud DLP results to Data Catalog, infoType

6048

# names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

6049

},

6050

"likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be

6051

# altered by a detection rule if the finding meets the criteria specified by

6052

# the rule. Defaults to `VERY_LIKELY` if not specified.

6053

"detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType.

6054

# Rules are applied in order that they are specified. Not supported for the

6055

# `surrogate_type` CustomInfoType.

6056

{ # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a

6057

# `CustomInfoType` to alter behavior under certain circumstances, depending

6058

# on the specific details of the rule. Not supported for the `surrogate_type`

6059

# custom infoType.

6060

"hotwordRule": { # The rule that adjusts the likelihood of findings within a certain # Hotword-based detection rule.

6061

# proximity of hotwords.

6062

"proximity": { # Message for specifying a window around a finding to apply a detection # Proximity of the finding within which the entire hotword must reside.

6063

# The total length of the window cannot exceed 1000 characters. Note that

6064

# the finding itself will be included in the window, so that hotwords may

6065

# be used to match substrings of the finding itself. For example, the

6066

# certainty of a phone number regex "$\d{3}$ \d{3}-\d{4}" could be

6067

# adjusted upwards if the area code is known to be the local area code of

6068

# a company office using the hotword regex "$xxx$", where "xxx"

6069

# is the area code in question.

6070

# rule.

6071

"windowAfter": 42, # Number of characters after the finding to consider.

6072

"windowBefore": 42, # Number of characters before the finding to consider.

6073

},

6074

"likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as # Likelihood adjustment to apply to all matching findings.

6075

# part of a detection rule.

6076

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value.

6077

"relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of

6078

# levels. For example, if a finding would be `POSSIBLE` without the

6079

# detection rule and `relative_likelihood` is 1, then it is upgraded to

6080

# `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`.

6081

# Likelihood may never drop below `VERY_UNLIKELY` or exceed

6082

# `VERY_LIKELY`, so applying an adjustment of 1 followed by an

6083

# adjustment of -1 when base likelihood is `VERY_LIKELY` will result in

6084

# a final likelihood of `LIKELY`.

6085

},

6086

"hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword.

6087

"groupIndexes": [ # The index of the submatch to extract as findings. When not

6088

# specified, the entire match is returned. No more than 3 may be included.

6089

42,

6090

],

6091

"pattern": "A String", # Pattern defining the regular expression. Its syntax

6092

# (https://github.com/google/re2/wiki/Syntax) can be found under the

6093

# google/re2 repository on GitHub.

},

},

},

],

"surrogateType": { # Message for detecting output from deidentification transformations # Message for detecting output from deidentification transformations that

6099

# support reversing.

6100

# such as

6101

# [`CryptoReplaceFfxFpeConfig`](https://cloud.google.com/dlp/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig).

6102

# These types of transformations are

6103

# those that perform pseudonymization, thereby producing a "surrogate" as

6104

# output. This should be used in conjunction with a field on the

6105

# transformation such as `surrogate_info_type`. This CustomInfoType does

6106

# not support the use of `detection_rules`.

6107

},

6108

"regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType.

6109

"groupIndexes": [ # The index of the submatch to extract as findings. When not

6110

# specified, the entire match is returned. No more than 3 may be included.

6111

42,

6112

],

6113

"pattern": "A String", # Pattern defining the regular expression. Its syntax

6114

# (https://github.com/google/re2/wiki/Syntax) can be found under the

6115

# google/re2 repository on GitHub.

6116

},

6117

"storedType": { # A reference to a StoredInfoType to use with scanning. # Load an existing `StoredInfoType` resource for use in

6118

# `InspectDataSource`. Not currently supported in `InspectContent`.

6119

"name": "A String", # Resource name of the requested `StoredInfoType`, for example

6120

# `organizations/433245324/storedInfoTypes/432452342` or

6121

# `projects/project-id/storedInfoTypes/432452342`.

6122

"createTime": "A String", # Timestamp indicating when the version of the `StoredInfoType` used for

6123

# inspection was created. Output-only field, populated by the system.

6124

},

6125

"exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding

6126

# to be returned. It still can be used for rules matching.

6127

},

6128

],

6129

"minLikelihood": "A String", # Only returns findings equal or above this threshold. The default is

6130

# POSSIBLE.

6131

# See https://cloud.google.com/dlp/docs/likelihood to learn more.

6132

"limits": { # Configuration to control the number of findings returned. # Configuration to control the number of findings returned.

6133

"maxFindingsPerRequest": 42, # Max number of findings that will be returned per request/job.

6134

# When set within `InspectContentRequest`, the maximum returned is 2000

6135

# regardless if this is set higher.

6136

"maxFindingsPerInfoType": [ # Configuration of findings limit given for specified infoTypes.

6137

{ # Max findings configuration per infoType, per content item or long

6138

# running DlpJob.

6139

"infoType": { # Type of information detected by the API. # Type of information the findings limit applies to. Only one limit per

6140

# info_type should be provided. If InfoTypeLimit does not have an

6141

# info_type, the DLP API applies the limit against all info_types that

6142

# are found but not specified in another InfoTypeLimit.

6143

"name": "A String", # Name of the information type. Either a name of your choosing when

6144

# creating a CustomInfoType, or one of the names listed

6145

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

6146

# a built-in type. When sending Cloud DLP results to Data Catalog, infoType

6147

# names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

6148

},

6149

"maxFindings": 42, # Max findings limit for the given infoType.

6150

},

6151

],

6152

"maxFindingsPerItem": 42, # Max number of findings that will be returned for each item scanned.

6153

# When set within `InspectJobConfig`,

6154

# the maximum returned is 2000 regardless if this is set higher.

6155

# When set within `InspectContentRequest`, this field is ignored.

6156

},

6157

"excludeInfoTypes": True or False, # When true, excludes type information of the findings.

6158

"includeQuote": True or False, # When true, a contextual quote from the data that triggered a finding is

6159

# included in the response; see Finding.quote.

6160

"ruleSet": [ # Set of rules to apply to the findings for this InspectConfig.

6161

# Exclusion rules, contained in the set are executed in the end, other

6162

# rules are executed in the order they are specified for each info type.

6163

{ # Rule set for modifying a set of infoTypes to alter behavior under certain

6164

# circumstances, depending on the specific details of the rules within the set.

6165

"infoTypes": [ # List of infoTypes this rule set is applied to.

6166

{ # Type of information detected by the API.

6167

"name": "A String", # Name of the information type. Either a name of your choosing when

6168

# creating a CustomInfoType, or one of the names listed

6169

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

6170

# a built-in type. When sending Cloud DLP results to Data Catalog, infoType

6171

# names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

6172

},

6173

],

6174

"rules": [ # Set of rules to be applied to infoTypes. The rules are applied in order.

6175

{ # A single inspection rule to be applied to infoTypes, specified in

6176

# `InspectionRuleSet`.

6177

"hotwordRule": { # The rule that adjusts the likelihood of findings within a certain # Hotword-based detection rule.

6178

# proximity of hotwords.

6179

"proximity": { # Message for specifying a window around a finding to apply a detection # Proximity of the finding within which the entire hotword must reside.

6180

# The total length of the window cannot exceed 1000 characters. Note that

6181

# the finding itself will be included in the window, so that hotwords may

6182

# be used to match substrings of the finding itself. For example, the

6183

# certainty of a phone number regex "$\d{3}$ \d{3}-\d{4}" could be

6184

# adjusted upwards if the area code is known to be the local area code of

6185

# a company office using the hotword regex "$xxx$", where "xxx"

6186

# is the area code in question.

6187

# rule.

6188

"windowAfter": 42, # Number of characters after the finding to consider.

6189

"windowBefore": 42, # Number of characters before the finding to consider.

6190

},

6191

"likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as # Likelihood adjustment to apply to all matching findings.

6192

# part of a detection rule.

6193

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value.

6194

"relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of

6195

# levels. For example, if a finding would be `POSSIBLE` without the

6196

# detection rule and `relative_likelihood` is 1, then it is upgraded to

6197

# `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`.

6198

# Likelihood may never drop below `VERY_UNLIKELY` or exceed

6199

# `VERY_LIKELY`, so applying an adjustment of 1 followed by an

6200

# adjustment of -1 when base likelihood is `VERY_LIKELY` will result in

6201

# a final likelihood of `LIKELY`.

6202

},

6203

"hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword.

6204

"groupIndexes": [ # The index of the submatch to extract as findings. When not

6205

# specified, the entire match is returned. No more than 3 may be included.

6206

42,

6207

],

6208

"pattern": "A String", # Pattern defining the regular expression. Its syntax

6209

# (https://github.com/google/re2/wiki/Syntax) can be found under the

6210

# google/re2 repository on GitHub.

6211

},

6212

},

6213

"exclusionRule": { # The rule that specifies conditions when findings of infoTypes specified in # Exclusion rule.

6214

# `InspectionRuleSet` are removed from results.

6215

"matchingType": "A String", # How the rule is applied, see MatchingType documentation for details.

6216

"dictionary": { # Custom information type based on a dictionary of words or phrases. This can # Dictionary which defines the rule.

6217

# be used to match sensitive information specific to the data, such as a list

6218

# of employee IDs or job titles.

6219

#

6220

# Dictionary words are case-insensitive and all characters other than letters

6221

# and digits in the unicode [Basic Multilingual

6222

# Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane)

6223

# will be replaced with whitespace when scanning for matches, so the

6224

# dictionary phrase "Sam Johnson" will match all three phrases "sam johnson",

6225

# "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters

6226

# surrounding any match must be of a different type than the adjacent

6227

# characters within the word, so letters must be next to non-letters and

6228

# digits next to non-digits. For example, the dictionary word "jen" will

6229

# match the first three letters of the text "jen123" but will return no

6230

# matches for "jennifer".

6231

#

6232

# Dictionary words containing a large number of characters that are not

6233

# letters or digits may result in unexpected findings because such characters

6234

# are treated as whitespace. The

6235

# [limits](https://cloud.google.com/dlp/limits) page contains details about

6236

# the size limits of dictionaries. For dictionaries that do not fit within

6237

# these constraints, consider using `LargeCustomDictionaryConfig` in the

6238

# `StoredInfoType` API.

6239

"cloudStoragePath": { # Message representing a single file or path in Cloud Storage. # Newline-delimited file of words in Cloud Storage. Only a single file

6240

# is accepted.

6241

"path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage.

6242

# Example: gs://[BUCKET_NAME]/dictionary.txt

6243

},

6244

"wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for.

6245

"words": [ # Words or phrases defining the dictionary. The dictionary must contain

6246

# at least one phrase and every phrase must contain at least 2 characters

6247

# that are letters or digits. [required]

"A String",

],

},

},

"excludeInfoTypes": { # List of exclude infoTypes. # Set of infoTypes for which findings would affect this rule.

6253

"infoTypes": [ # InfoType list in ExclusionRule rule drops a finding when it overlaps or

6254

# contained within with a finding of an infoType from this list. For

6255

# example, for `InspectionRuleSet.info_types` containing "PHONE_NUMBER"` and

6256

# `exclusion_rule` containing `exclude_info_types.info_types` with

6257

# "EMAIL_ADDRESS" the phone number findings are dropped if they overlap

6258

# with EMAIL_ADDRESS finding.

6259

# That leads to "555-222-2222@example.org" to generate only a single

6260

# finding, namely email address.

6261

{ # Type of information detected by the API.

6262

"name": "A String", # Name of the information type. Either a name of your choosing when

6263

# creating a CustomInfoType, or one of the names listed

6264

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

6265

# a built-in type. When sending Cloud DLP results to Data Catalog, infoType

6266

# names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

},

],

},

"regex": { # Message defining a custom regular expression. # Regular expression which defines the rule.

6271

"groupIndexes": [ # The index of the submatch to extract as findings. When not

6272

# specified, the entire match is returned. No more than 3 may be included.

6273

42,

6274

],

6275

"pattern": "A String", # Pattern defining the regular expression. Its syntax

6276

# (https://github.com/google/re2/wiki/Syntax) can be found under the

6277

# google/re2 repository on GitHub.

},

},

},

],

},

],

"contentOptions": [ # List of options defining data content to scan.

6285

# If empty, text, images, and other content will be included.

6286

"A String",

6287

],

6288

"infoTypes": [ # Restricts what info_types to look for. The values must correspond to

6289

# InfoType values returned by ListInfoTypes or listed at

6290

# https://cloud.google.com/dlp/docs/infotypes-reference.

6291

#

6292

# When no InfoTypes or CustomInfoTypes are specified in a request, the

6293

# system may automatically choose what detectors to run. By default this may

6294

# be all types, but may change over time as detectors are updated.

6295

#

6296

# If you need precise control and predictability as to what detectors are

6297

# run you should specify specific InfoTypes listed in the reference,

6298

# otherwise a default list will be used, which may change over time.

6299

{ # Type of information detected by the API.

6300

"name": "A String", # Name of the information type. Either a name of your choosing when

6301

# creating a CustomInfoType, or one of the names listed

6302

# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying

6303

# a built-in type. When sending Cloud DLP results to Data Catalog, infoType

6304

# names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

6305

},

6306

],

6307

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6308

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

6309

"name": "A String", # Unique resource name for the triggeredJob, assigned by the service when the

6310

# triggeredJob is created, for example

6311

# `projects/dlp-test-project/jobTriggers/53234423`.

6312

"displayName": "A String", # Display name (max 100 chars)

6313

"lastRunTime": "A String", # Output only. The timestamp of the last time this trigger executed.

6314

"createTime": "A String", # Output only. The creation timestamp of a triggeredJob.

6315

"description": "A String", # User provided description (max 256 chars)

Bu Sun Kim