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

2020-10-06 16:46:05 -0700

[diff] [blame]

79

<p class="firstline">Activate a job trigger. Causes the immediate execute of a trigger instead of waiting on the trigger event to occur.</p>

80

81

<code><a href="#close">close()</a></code></p>

82

<p class="firstline">Close httplib2 connections.</p>

Bu Sun Kim

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

[diff] [blame]

83

Bu Sun Kim

d059ad8

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

[diff] [blame]

84

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

85

<p class="firstline">Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.</p>

Bu Sun Kim

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

[diff] [blame]

86

87

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

88

<p class="firstline">Deletes a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.</p>

Bu Sun Kim

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

[diff] [blame]

89

90

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

91

<p class="firstline">Gets a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.</p>

Bu Sun Kim

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

[diff] [blame]

92

93

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

94

<p class="firstline">Inspect hybrid content and store findings to a trigger. The inspection will be processed asynchronously. To review the findings monitor the jobs within the trigger. Early access feature is in a pre-release state and might change or have limited support. For more information, see https://cloud.google.com/products#product-launch-stages.</p>

Bu Sun Kim

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

[diff] [blame]

95

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

96

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

97

<p class="firstline">Lists job triggers. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.</p>

Bu Sun Kim

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

[diff] [blame]

98

99

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

100

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

101

102

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

103

<p class="firstline">Updates a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.</p>

Bu Sun Kim

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

[diff] [blame]

104

<h3>Method Details</h3>

105

106

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

107

<pre>Activate a job trigger. Causes the immediate execute of a trigger instead of waiting on the trigger event to occur.

Bu Sun Kim

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

[diff] [blame]

108

109

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

110

name: string, Required. Resource name of the trigger to activate, for example `projects/dlp-test-project/jobTriggers/53234423`. (required)

Bu Sun Kim

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

[diff] [blame]

111

body: object, The request body.

112

The object takes the form of:

113

114

{ # Request message for ActivateJobTrigger.

115

}

116

117

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

124

125

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

126

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

127

"requestedOptions": { # Risk analysis options. # The configuration used for this job.

128

"jobConfig": { # Configuration for a risk analysis job. See https://cloud.google.com/dlp/docs/concepts-risk-analysis to learn more. # The job config for the risk job.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

129

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

130

"kMapEstimationConfig": { # Reidentifiability metric. This corresponds to a risk model similar to what is called "journalist risk" in the literature, except the attack dataset is statistically modeled instead of being perfectly known. This can be done using publicly available data (like the US Census), or using a custom statistical model (indicated as one or several BigQuery tables), or by extrapolating from the distribution of values in the input dataset. # k-map

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

131

"auxiliaryTables": [ # Several auxiliary tables can be used in the analysis. Each custom_tag used to tag a quasi-identifiers column must appear in exactly one column of one auxiliary table.

132

{ # An auxiliary table contains statistical information on the relative frequency of different quasi-identifiers values. It has one or several quasi-identifiers columns, and one column that indicates the relative frequency of each quasi-identifier tuple. If a tuple is present in the data but not in the auxiliary table, the corresponding relative frequency is assumed to be zero (and thus, the tuple is highly reidentifiable).

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

133

"relativeFrequency": { # General identifier of a data field in a storage service. # Required. The relative frequency column must contain a floating-point number between 0 and 1 (inclusive). Null values are assumed to be zero.

134

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

135

},

136

"table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Required. Auxiliary table location.

137

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

138

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

139

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call.

140

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

141

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

142

{ # A quasi-identifier column has a custom_tag, used to know which column in the data corresponds to which column in the statistical model.

143

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

144

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

145

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

146

},

147

},

148

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

149

},

150

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

151

"regionCode": "A String", # ISO 3166-1 alpha-2 region code to use in the statistical modeling. Set if no column is tagged with a region-specific InfoType (like US_ZIP_5) or a region code.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

152

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

153

{ # A column with a semantic tag attached.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

154

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

155

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

156

},

157

"inferred": { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. # If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data

158

},

159

"customTag": "A String", # A column can be tagged with a custom tag. In this case, the user must indicate an auxiliary table that contains statistical information on the possible values of this column (below).

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

160

"infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter.

161

"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

162

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

163

},

164

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

165

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

166

"deltaPresenceEstimationConfig": { # δ-presence metric, used to estimate how likely it is for an attacker to figure out that one given individual appears in a de-identified dataset. Similarly to the k-map metric, we cannot compute δ-presence exactly without knowing the attack dataset, so we use a statistical model instead. # delta-presence

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

167

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

168

{ # A column with a semantic tag attached.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

169

"infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter.

170

"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

171

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

172

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

173

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

174

},

175

"inferred": { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. # If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data

176

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

177

"customTag": "A String", # A column can be tagged with a custom tag. In this case, the user must indicate an auxiliary table that contains statistical information on the possible values of this column (below).

178

},

179

],

180

"regionCode": "A String", # ISO 3166-1 alpha-2 region code to use in the statistical modeling. Set if no column is tagged with a region-specific InfoType (like US_ZIP_5) or a region code.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

181

"auxiliaryTables": [ # Several auxiliary tables can be used in the analysis. Each custom_tag used to tag a quasi-identifiers field must appear in exactly one field of one auxiliary table.

182

{ # An auxiliary table containing statistical information on the relative frequency of different quasi-identifiers values. It has one or several quasi-identifiers columns, and one column that indicates the relative frequency of each quasi-identifier tuple. If a tuple is present in the data but not in the auxiliary table, the corresponding relative frequency is assumed to be zero (and thus, the tuple is highly reidentifiable).

183

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

184

{ # A quasi-identifier column has a custom_tag, used to know which column in the data corresponds to which column in the statistical model.

185

"customTag": "A String", # A column can be tagged with a custom tag. In this case, the user must indicate an auxiliary table that contains statistical information on the possible values of this column (below).

186

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

187

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

},

},

],

"table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Required. Auxiliary table location.

192

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

193

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

194

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call.

195

},

196

"relativeFrequency": { # General identifier of a data field in a storage service. # Required. The relative frequency column must contain a floating-point number between 0 and 1 (inclusive). Null values are assumed to be zero.

197

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

198

},

199

},

200

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

201

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

202

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

203

"quasiIds": [ # Set of fields to compute k-anonymity over. When multiple fields are specified, they are considered a single composite key. Structs and repeated data types are not supported; however, nested fields are supported so long as they are not structs themselves or nested within a repeated field.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

204

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

205

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

206

},

207

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

208

"entityId": { # An entity in a dataset is a field or set of fields that correspond to a single person. For example, in medical records the `EntityId` might be a patient identifier, or for financial records it might be an account identifier. This message is used when generalizations or analysis must take into account that multiple rows correspond to the same entity. # Message indicating that multiple rows might be associated to a single individual. If the same entity_id is associated to multiple quasi-identifier tuples over distinct rows, we consider the entire collection of tuples as the composite quasi-identifier. This collection is a multiset: the order in which the different tuples appear in the dataset is ignored, but their frequency is taken into account. Important note: a maximum of 1000 rows can be associated to a single entity ID. If more rows are associated with the same entity ID, some might be ignored.

209

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

210

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

},

},

},

"numericalStatsConfig": { # Compute numerical stats over an individual column, including min, max, and quantiles. # Numerical stats

215

"field": { # General identifier of a data field in a storage service. # Field to compute numerical stats on. Supported types are integer, float, date, datetime, timestamp, time.

216

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

217

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

218

},

219

"categoricalStatsConfig": { # Compute numerical stats over an individual column, including number of distinct values and value count distribution. # Categorical stats

220

"field": { # General identifier of a data field in a storage service. # Field to compute categorical stats on. All column types are supported except for arrays and structs. However, it may be more informative to use NumericalStats when the field type is supported, depending on the data.

221

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

222

},

223

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

224

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

225

"quasiIds": [ # Set of quasi-identifiers indicating how equivalence classes are defined for the l-diversity computation. When multiple fields are specified, they are considered a single composite key.

226

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

227

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

228

},

229

],

230

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

231

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

},

},

},

"actions": [ # Actions to execute at the completion of the job. Are executed in the order provided.

236

{ # A task to execute on the completion of a job. See https://cloud.google.com/dlp/docs/concepts-actions to learn more.

237

"publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count.

238

},

239

"saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.

240

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

241

"table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific timezone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.

242

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

243

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

244

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call.

245

},

246

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.

247

},

248

},

249

"publishSummaryToCscc": { # Publish the result summary of a DlpJob to the Cloud Security Command Center (CSCC Alpha). This action is only available for projects which are parts of an organization and whitelisted for the alpha Cloud Security Command Center. The action will publish count of finding instances and their info types. The summary of findings will be persisted in CSCC and are governed by CSCC service-specific policy, see https://cloud.google.com/terms/service-terms Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha).

250

},

251

"publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Cloud Data Catalog. Labels summarizing the results of the DlpJob will be applied to the entry for the resource scanned in Cloud Data Catalog. Any labels previously written by another DlpJob will be deleted. InfoType naming patterns are strictly enforced when using this feature. Note that the findings will be persisted in Cloud Data Catalog storage and are governed by Data Catalog service-specific policy, see https://cloud.google.com/terms/service-terms Only a single instance of this action can be specified and only allowed if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub.

252

},

253

"pubSub": { # Publish a message into given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/dlp/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a pubsub topic.

254

"topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}.

255

},

256

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

},

},

],

"sourceTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Input dataset to compute metrics over.

261

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

262

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

263

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call.

},

},

},

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

268

"kMapEstimationHistogram": [ # The intervals [min_anonymity, max_anonymity] do not overlap. If a value doesn't correspond to any such interval, the associated frequency is zero. For example, the following records: {min_anonymity: 1, max_anonymity: 1, frequency: 17} {min_anonymity: 2, max_anonymity: 3, frequency: 42} {min_anonymity: 5, max_anonymity: 10, frequency: 99} mean that there are no record with an estimated anonymity of 4, 5, or larger than 10.

269

{ # 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 to 3, 4 or 5 people in the overlying population. An important particular case is when min_anonymity = max_anonymity = 1: the frequency field then corresponds to the number of uniquely identifiable records.

270

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

271

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

272

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

273

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

274

"bucketValues": [ # Sample of quasi-identifier tuple values in this bucket. The total number of classes returned per bucket is capped at 20.

275

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

276

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

277

{ # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data.

278

"integerValue": "A String", # integer

279

"dateValue": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # date

280

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

281

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

282

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

283

},

284

"stringValue": "A String", # string

285

"timestampValue": "A String", # timestamp

286

"floatValue": 3.14, # float

287

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

288

"booleanValue": True or False, # boolean

289

"timeValue": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # time of day

290

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.

291

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

292

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.

293

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

},

},

],

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

},

],

},

],

},

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

304

"kMapEstimationConfig": { # Reidentifiability metric. This corresponds to a risk model similar to what is called "journalist risk" in the literature, except the attack dataset is statistically modeled instead of being perfectly known. This can be done using publicly available data (like the US Census), or using a custom statistical model (indicated as one or several BigQuery tables), or by extrapolating from the distribution of values in the input dataset. # k-map

305

"auxiliaryTables": [ # Several auxiliary tables can be used in the analysis. Each custom_tag used to tag a quasi-identifiers column must appear in exactly one column of one auxiliary table.

306

{ # An auxiliary table contains statistical information on the relative frequency of different quasi-identifiers values. It has one or several quasi-identifiers columns, and one column that indicates the relative frequency of each quasi-identifier tuple. If a tuple is present in the data but not in the auxiliary table, the corresponding relative frequency is assumed to be zero (and thus, the tuple is highly reidentifiable).

307

"relativeFrequency": { # General identifier of a data field in a storage service. # Required. The relative frequency column must contain a floating-point number between 0 and 1 (inclusive). Null values are assumed to be zero.

308

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

309

},

310

"table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Required. Auxiliary table location.

311

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

312

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

313

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call.

314

},

315

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

316

{ # A quasi-identifier column has a custom_tag, used to know which column in the data corresponds to which column in the statistical model.

317

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

318

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

319

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

},

},

],

},

],

"regionCode": "A String", # ISO 3166-1 alpha-2 region code to use in the statistical modeling. Set if no column is tagged with a region-specific InfoType (like US_ZIP_5) or a region code.

326

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

327

{ # A column with a semantic tag attached.

328

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

329

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

330

},

331

"inferred": { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. # If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data

332

},

333

"customTag": "A String", # A column can be tagged with a custom tag. In this case, the user must indicate an auxiliary table that contains statistical information on the possible values of this column (below).

334

"infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter.

335

"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

},

},

],

},

"deltaPresenceEstimationConfig": { # δ-presence metric, used to estimate how likely it is for an attacker to figure out that one given individual appears in a de-identified dataset. Similarly to the k-map metric, we cannot compute δ-presence exactly without knowing the attack dataset, so we use a statistical model instead. # delta-presence

341

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

342

{ # A column with a semantic tag attached.

343

"infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter.

344

"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

345

},

346

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

347

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

348

},

349

"inferred": { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. # If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data

350

},

351

"customTag": "A String", # A column can be tagged with a custom tag. In this case, the user must indicate an auxiliary table that contains statistical information on the possible values of this column (below).

352

},

353

],

354

"regionCode": "A String", # ISO 3166-1 alpha-2 region code to use in the statistical modeling. Set if no column is tagged with a region-specific InfoType (like US_ZIP_5) or a region code.

355

"auxiliaryTables": [ # Several auxiliary tables can be used in the analysis. Each custom_tag used to tag a quasi-identifiers field must appear in exactly one field of one auxiliary table.

356

{ # An auxiliary table containing statistical information on the relative frequency of different quasi-identifiers values. It has one or several quasi-identifiers columns, and one column that indicates the relative frequency of each quasi-identifier tuple. If a tuple is present in the data but not in the auxiliary table, the corresponding relative frequency is assumed to be zero (and thus, the tuple is highly reidentifiable).

357

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

358

{ # A quasi-identifier column has a custom_tag, used to know which column in the data corresponds to which column in the statistical model.

359

"customTag": "A String", # A column can be tagged with a custom tag. In this case, the user must indicate an auxiliary table that contains statistical information on the possible values of this column (below).

360

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

361

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

},

},

],

"table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Required. Auxiliary table location.

366

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

367

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

368

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call.

369

},

370

"relativeFrequency": { # General identifier of a data field in a storage service. # Required. The relative frequency column must contain a floating-point number between 0 and 1 (inclusive). Null values are assumed to be zero.

371

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

},

},

],

},

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

377

"quasiIds": [ # Set of fields to compute k-anonymity over. When multiple fields are specified, they are considered a single composite key. Structs and repeated data types are not supported; however, nested fields are supported so long as they are not structs themselves or nested within a repeated field.

378

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

379

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

380

},

381

],

382

"entityId": { # An entity in a dataset is a field or set of fields that correspond to a single person. For example, in medical records the `EntityId` might be a patient identifier, or for financial records it might be an account identifier. This message is used when generalizations or analysis must take into account that multiple rows correspond to the same entity. # Message indicating that multiple rows might be associated to a single individual. If the same entity_id is associated to multiple quasi-identifier tuples over distinct rows, we consider the entire collection of tuples as the composite quasi-identifier. This collection is a multiset: the order in which the different tuples appear in the dataset is ignored, but their frequency is taken into account. Important note: a maximum of 1000 rows can be associated to a single entity ID. If more rows are associated with the same entity ID, some might be ignored.

383

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

384

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

},

},

},

"numericalStatsConfig": { # Compute numerical stats over an individual column, including min, max, and quantiles. # Numerical stats

389

"field": { # General identifier of a data field in a storage service. # Field to compute numerical stats on. Supported types are integer, float, date, datetime, timestamp, time.

390

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

391

},

392

},

393

"categoricalStatsConfig": { # Compute numerical stats over an individual column, including number of distinct values and value count distribution. # Categorical stats

394

"field": { # General identifier of a data field in a storage service. # Field to compute categorical stats on. All column types are supported except for arrays and structs. However, it may be more informative to use NumericalStats when the field type is supported, depending on the data.

395

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

396

},

397

},

398

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

399

"quasiIds": [ # Set of quasi-identifiers indicating how equivalence classes are defined for the l-diversity computation. When multiple fields are specified, they are considered a single composite key.

400

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

401

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

402

},

403

],

404

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

405

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

},

},

},

"requestedSourceTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Input dataset to compute metrics over.

410

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

411

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

412

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call.

413

},

414

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

415

"deltaPresenceEstimationHistogram": [ # The intervals [min_probability, max_probability) do not overlap. If a value doesn't correspond to any such interval, the associated frequency is zero. For example, the following records: {min_probability: 0, max_probability: 0.1, frequency: 17} {min_probability: 0.2, max_probability: 0.3, frequency: 42} {min_probability: 0.3, max_probability: 0.4, frequency: 99} mean that there are no record with an estimated probability in [0.1, 0.2) nor larger or equal to 0.4.

416

{ # A DeltaPresenceEstimationHistogramBucket message with the following values: min_probability: 0.1 max_probability: 0.2 frequency: 42 means that there are 42 records for which δ is in [0.1, 0.2). An important particular case is when min_probability = max_probability = 1: then, every individual who shares this quasi-identifier combination is in the dataset.

417

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

418

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

419

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

420

"bucketValues": [ # Sample of quasi-identifier tuple values in this bucket. The total number of classes returned per bucket is capped at 20.

421

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

422

"estimatedProbability": 3.14, # The estimated probability that a given individual sharing these quasi-identifier values is in the dataset. This value, typically called δ, is the ratio between the number of records in the dataset with these quasi-identifier values, and the total number of individuals (inside *and* outside the dataset) with these quasi-identifier values. For example, if there are 15 individuals in the dataset who share the same quasi-identifier values, and an estimated 100 people in the entire population with these values, then δ is 0.15.

423

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

424

{ # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data.

425

"integerValue": "A String", # integer

426

"dateValue": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # date

427

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

428

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

429

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

430

},

431

"stringValue": "A String", # string

432

"timestampValue": "A String", # timestamp

433

"floatValue": 3.14, # float

434

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

435

"booleanValue": True or False, # boolean

436

"timeValue": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # time of day

437

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.

438

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

439

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.

440

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

},

},

],

},

],

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

},

],

},

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

451

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

452

{ # Histogram of k-anonymity equivalence classes.

453

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

454

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

455

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

456

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

457

"bucketValues": [ # Sample of equivalence classes in this bucket. The total number of classes returned per bucket is capped at 20.

458

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

459

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

460

"quasiIdsValues": [ # Set of values defining the equivalence class. One value per quasi-identifier column in the original KAnonymity metric message. The order is always the same as the original request.

461

{ # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data.

462

"integerValue": "A String", # integer

463

"dateValue": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # date

464

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

465

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

466

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

467

},

468

"stringValue": "A String", # string

469

"timestampValue": "A String", # timestamp

470

"floatValue": 3.14, # float

471

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

472

"booleanValue": True or False, # boolean

473

"timeValue": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # time of day

474

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.

475

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

476

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.

477

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

},

},

],

},

],

},

],

},

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

487

"maxValue": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Maximum value appearing in the column.

488

"integerValue": "A String", # integer

489

"dateValue": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # date

490

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

491

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

492

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

493

},

494

"stringValue": "A String", # string

495

"timestampValue": "A String", # timestamp

496

"floatValue": 3.14, # float

497

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

498

"booleanValue": True or False, # boolean

499

"timeValue": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # time of day

500

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.

501

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

502

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.

503

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

504

},

505

},

506

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

507

{ # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data.

508

"integerValue": "A String", # integer

509

"dateValue": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # date

510

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

511

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

512

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

513

},

514

"stringValue": "A String", # string

515

"timestampValue": "A String", # timestamp

516

"floatValue": 3.14, # float

517

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

518

"booleanValue": True or False, # boolean

519

"timeValue": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # time of day

520

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.

521

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

522

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.

523

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

},

},

],

"minValue": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Minimum value appearing in the column.

528

"integerValue": "A String", # integer

529

"dateValue": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # date

530

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

531

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

532

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

533

},

534

"stringValue": "A String", # string

535

"timestampValue": "A String", # timestamp

536

"floatValue": 3.14, # float

537

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

538

"booleanValue": True or False, # boolean

539

"timeValue": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # time of day

540

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.

541

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

542

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.

543

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

},

},

},

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

548

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

549

{ # Histogram of value frequencies in the column.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

550

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

551

"bucketValues": [ # Sample of value frequencies in this bucket. The total number of values returned per bucket is capped at 20.

552

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

553

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

554

"value": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # A value contained in the field in question.

555

"integerValue": "A String", # integer

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

556

"dateValue": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # date

557

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

558

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

559

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

560

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

561

"stringValue": "A String", # string

562

"timestampValue": "A String", # timestamp

563

"floatValue": 3.14, # float

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

564

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

565

"booleanValue": True or False, # boolean

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

566

"timeValue": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # time of day

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

567

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

568

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

569

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.

570

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

571

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

572

},

573

},

574

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

575

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

576

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

577

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

},

],

},

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

582

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

583

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

584

"bucketValues": [ # Sample of equivalence classes in this bucket. The total number of classes returned per bucket is capped at 20.

585

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

586

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

587

"quasiIdsValues": [ # Quasi-identifier values defining the k-anonymity equivalence class. The order is always the same as the original request.

588

{ # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data.

589

"integerValue": "A String", # integer

590

"dateValue": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # date

591

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

592

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

593

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

594

},

595

"stringValue": "A String", # string

596

"timestampValue": "A String", # timestamp

597

"floatValue": 3.14, # float

598

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

599

"booleanValue": True or False, # boolean

600

"timeValue": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # time of day

601

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.

602

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

603

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.

604

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

},

},

],

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

609

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

610

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

611

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

612

"value": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # A value contained in the field in question.

613

"integerValue": "A String", # integer

614

"dateValue": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # date

615

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

616

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

617

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

618

},

619

"stringValue": "A String", # string

620

"timestampValue": "A String", # timestamp

621

"floatValue": 3.14, # float

622

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

623

"booleanValue": True or False, # boolean

624

"timeValue": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # time of day

625

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.

626

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

627

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.

628

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

},

},

},

],

},

],

"sensitiveValueFrequencyUpperBound": "A String", # Upper bound on the sensitive value frequencies of the equivalence classes in this bucket.

636

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

637

"sensitiveValueFrequencyLowerBound": "A String", # Lower bound on the sensitive value frequencies of the equivalence classes in this bucket.

638

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

},

],

},

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

643

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

644

"name": "A String", # The server-assigned name.

645

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

646

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

647

{ # Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger.

648

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

649

"A String",

650

],

651

"details": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Detailed error codes and messages.

652

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

653

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

654

{

655

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

656

},

657

],

658

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

},

},

],

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

663

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

664

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

665

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

666

"snapshotInspectTemplate": { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/dlp/docs/concepts-templates to learn more. # If run with an InspectTemplate, a snapshot of its state at the time of this run.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

667

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

668

"name": "A String", # Output only. The template name. The template will have one of the following formats: `projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID`;

669

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

670

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

671

"inspectConfig": { # Configuration description of the scanning process. When used with redactContent only info_types and min_likelihood are currently used. # The core content of the template. Configuration of the scanning process.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

672

"includeQuote": True or False, # When true, a contextual quote from the data that triggered a finding is included in the response; see Finding.quote.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

673

"customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more.

674

{ # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

675

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

676

"createTime": "A String", # Timestamp indicating when the version of the `StoredInfoType` used for inspection was created. Output-only field, populated by the system.

677

"name": "A String", # Resource name of the requested `StoredInfoType`, for example `organizations/433245324/storedInfoTypes/432452342` or `projects/project-id/storedInfoTypes/432452342`.

678

},

679

"likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified.

680

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

681

"pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.

682

"groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included.

683

42,

684

],

685

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

686

"dictionary": { # Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://cloud.google.com/dlp/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API. # A list of phrases to detect as a CustomInfoType.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

687

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

688

"path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt

689

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

690

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

691

"words": [ # Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits. [required]

692

"A String",

693

],

694

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

695

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

696

"exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching.

697

"surrogateType": { # Message for detecting output from deidentification transformations such as [`CryptoReplaceFfxFpeConfig`](https://cloud.google.com/dlp/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig). These types of transformations are those that perform pseudonymization, thereby producing a "surrogate" as output. This should be used in conjunction with a field on the transformation such as `surrogate_info_type`. This CustomInfoType does not support the use of `detection_rules`. # Message for detecting output from deidentification transformations that support reversing.

698

},

699

"infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type.

700

"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

701

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

702

"detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type` CustomInfoType.

703

{ # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType.

704

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

705

"proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "$\d{3}$ \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "$xxx$", where "xxx" is the area code in question.

706

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

707

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

708

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

709

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

710

"pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.

711

"groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included.

42,

],

},

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

716

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

717

"relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`.

718

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

719

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

720

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

721

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

722

},

723

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

724

"contentOptions": [ # List of options defining data content to scan. If empty, text, images, and other content will be included.

725

"A String",

726

],

727

"minLikelihood": "A String", # Only returns findings equal or above this threshold. The default is POSSIBLE. See https://cloud.google.com/dlp/docs/likelihood to learn more.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

728

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

729

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

730

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

731

"infoType": { # Type of information detected by the API. # Type of information the findings limit applies to. Only one limit per info_type should be provided. If InfoTypeLimit does not have an info_type, the DLP API applies the limit against all info_types that are found but not specified in another InfoTypeLimit.

732

"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

733

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

734

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

735

},

736

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

737

"maxFindingsPerRequest": 42, # Max number of findings that will be returned per request/job. When set within `InspectContentRequest`, the maximum returned is 2000 regardless if this is set higher.

738

"maxFindingsPerItem": 42, # Max number of findings that will be returned for each item scanned. When set within `InspectJobConfig`, the maximum returned is 2000 regardless if this is set higher. When set within `InspectContentRequest`, this field is ignored.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

739

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

740

"infoTypes": [ # Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or listed at https://cloud.google.com/dlp/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. If you need precise control and predictability as to what detectors are run you should specify specific InfoTypes listed in the reference, otherwise a default list will be used, which may change over time.

741

{ # Type of information detected by the API.

742

"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

743

},

744

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

745

"ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type.

746

{ # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set.

747

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

748

{ # Type of information detected by the API.

749

"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

750

},

751

],

752

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

753

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

754

"exclusionRule": { # The rule that specifies conditions when findings of infoTypes specified in `InspectionRuleSet` are removed from results. # Exclusion rule.

755

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

756

"pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.

757

"groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included.

42,

],

},

"dictionary": { # Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://cloud.google.com/dlp/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API. # Dictionary which defines the rule.

762

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

763

"path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt

764

},

765

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

766

"words": [ # Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits. [required]

"A String",

],

},

},

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

772

"infoTypes": [ # InfoType list in ExclusionRule rule drops a finding when it overlaps or contained within with a finding of an infoType from this list. For example, for `InspectionRuleSet.info_types` containing "PHONE_NUMBER"` and `exclusion_rule` containing `exclude_info_types.info_types` with "EMAIL_ADDRESS" the phone number findings are dropped if they overlap with EMAIL_ADDRESS finding. That leads to "555-222-2222@example.org" to generate only a single finding, namely email address.

773

{ # Type of information detected by the API.

774

"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

},

],

},

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

779

},

780

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

781

"proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "$\d{3}$ \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "$xxx$", where "xxx" is the area code in question.

782

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

783

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

784

},

785

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

786

"pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.

787

"groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included.

42,

],

},

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

792

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

793

"relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`.

},

},

},

],

},

],

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

801

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

802

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

803

},

804

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

805

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

806

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

807

"identifyingFields": [ # Table fields that may uniquely identify a row within the table. When `actions.saveFindings.outputConfig.table` is specified, the values of columns specified here are available in the output table under `location.content_locations.record_location.record_key.id_values`. Nested fields such as `person.birthdate.year` are allowed.

808

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

809

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

810

},

811

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

812

"rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

813

"tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

814

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

815

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

816

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

817

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

818

"sampleMethod": "A String",

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

819

"rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

820

"excludedFields": [ # References to fields excluded from scanning. This allows you to skip inspection of entire columns which you know have no findings.

821

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

822

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

},

],

},

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

827

"bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.

828

"fileTypes": [ # List of file type groups to include in the scan. If empty, all files are scanned and available data format processors are applied. In addition, the binary content of the selected files is always scanned as well. Images are scanned only as binary if the specified region does not support image inspection and no file_types were specified. Image inspection is restricted to 'global', 'us', 'asia', and 'europe'.

829

"A String",

830

],

831

"filesLimitPercent": 42, # Limits the number of files to scan to this percentage of the input FileSet. Number of files scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0.

832

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

833

"regexFileSet": { # Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include. Included files are those that match at least one item in `include_regex` and do not match any items in `exclude_regex`. Note that a file that matches items from both lists will _not_ be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression. For example, given the input `{bucket_name: "mybucket", include_regex: ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * `gs://mybucket/directory1/myfile` will be included * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the full path doesn't match any items in `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path matches an item in `exclude_regex`) If `include_regex` is left empty, it will match all files by default (this is equivalent to setting `include_regex: [".*"]`). Some other common use cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all files in `mybucket` except for .pdf files * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will include all files directly under `gs://mybucket/directory/`, without matching across `/` # The regex-filtered set of files to scan. Exactly one of `url` or `regex_file_set` must be set.

834

"excludeRegex": [ # A list of regular expressions matching file paths to exclude. All files in the bucket that match at least one of these regular expressions will be excluded from the scan. Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub.

835

"A String",

836

],

837

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

838

"includeRegex": [ # A list of regular expressions matching file paths to include. All files in the bucket that match at least one of these regular expressions will be included in the set of files, except for those that also match an item in `exclude_regex`. Leaving this field empty will match all files by default (this is equivalent to including `.*` in the list). Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found 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 `gs:///`. Trailing wildcard in the path is allowed. If the url ends in a trailing slash, the bucket or directory represented by the url will be scanned non-recursively (content in sub-directories will not be scanned). This means that `gs://mybucket/` is equivalent to `gs://mybucket/*`, and `gs://mybucket/directory/` is equivalent to `gs://mybucket/directory/*`. Exactly one of `url` or `regex_file_set` must be set.

843

},

844

"sampleMethod": "A String",

845

"bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.

846

},

847

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

848

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

849

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

850

},

851

"partitionId": { # Datastore partition ID. A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty.

852

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

853

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

854

},

855

},

856

"timespanConfig": { # Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Google Cloud Storage and BigQuery.

857

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger.

858

"startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied.

859

"timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. For BigQuery: If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. For Datastore: If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`.

860

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

861

},

862

"endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

863

},

864

"hybridOptions": { # Configuration to control jobs where the content being inspected is outside of Google Cloud Platform. # Hybrid inspection options. Early access feature is in a pre-release state and might change or have limited support. For more information, see https://cloud.google.com/products#product-launch-stages.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

865

"labels": { # To organize findings, these labels will be added to each finding. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. No more than 10 labels can be associated with a given finding. Examples: * `"environment" : "production"` * `"pipeline" : "etl"`

866

"a_key": "A String",

867

},

868

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

869

"tableOptions": { # Instructions regarding the table content being inspected. # If the container is a table, additional information to make findings meaningful such as the columns that are primary keys.

870

"identifyingFields": [ # The columns that are the primary keys for table objects included in ContentItem. A copy of this cell's value will stored alongside alongside each finding so that the finding can be traced to the specific row it came from. No more than 3 may be provided.

871

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

872

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

873

},

874

],

875

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

876

"requiredFindingLabelKeys": [ # These are labels that each inspection request must include within their 'finding_labels' map. Request may contain others, but any missing one of these will be rejected. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. No more than 10 keys can be required.

877

"A String",

878

],

879

},

Bu Sun Kim

d059ad8

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

[diff] [blame]

880

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

881

"inspectTemplateName": "A String", # If provided, will be used as the default for all values in InspectConfig. `inspect_config` will be merged into the values persisted as part of the template.

882

"inspectConfig": { # Configuration description of the scanning process. When used with redactContent only info_types and min_likelihood are currently used. # How and what to scan for.

883

"includeQuote": True or False, # When true, a contextual quote from the data that triggered a finding is included in the response; see Finding.quote.

884

"customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more.

885

{ # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question.

886

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

887

"createTime": "A String", # Timestamp indicating when the version of the `StoredInfoType` used for inspection was created. Output-only field, populated by the system.

888

"name": "A String", # Resource name of the requested `StoredInfoType`, for example `organizations/433245324/storedInfoTypes/432452342` or `projects/project-id/storedInfoTypes/432452342`.

889

},

890

"likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified.

891

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

892

"pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.

893

"groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included.

42,

],

},

"dictionary": { # Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://cloud.google.com/dlp/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API. # A list of phrases to detect as a CustomInfoType.

898

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

899

"path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt

900

},

901

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

902

"words": [ # Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits. [required]

"A String",

],

},

},

"exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching.

908

"surrogateType": { # Message for detecting output from deidentification transformations such as [`CryptoReplaceFfxFpeConfig`](https://cloud.google.com/dlp/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig). These types of transformations are those that perform pseudonymization, thereby producing a "surrogate" as output. This should be used in conjunction with a field on the transformation such as `surrogate_info_type`. This CustomInfoType does not support the use of `detection_rules`. # Message for detecting output from deidentification transformations that support reversing.

909

},

910

"infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type.

911

"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

912

},

913

"detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type` CustomInfoType.

914

{ # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType.

915

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

916

"proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "$\d{3}$ \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "$xxx$", where "xxx" is the area code in question.

917

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

918

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

919

},

920

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

921

"pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.

922

"groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included.

42,

],

},

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

927

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

928

"relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`.

},

},

},

],

},

],

"contentOptions": [ # List of options defining data content to scan. If empty, text, images, and other content will be included.

936

"A String",

937

],

938

"minLikelihood": "A String", # Only returns findings equal or above this threshold. The default is POSSIBLE. See https://cloud.google.com/dlp/docs/likelihood to learn more.

939

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

940

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

941

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

942

"infoType": { # Type of information detected by the API. # Type of information the findings limit applies to. Only one limit per info_type should be provided. If InfoTypeLimit does not have an info_type, the DLP API applies the limit against all info_types that are found but not specified in another InfoTypeLimit.

943

"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

944

},

945

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

946

},

947

],

948

"maxFindingsPerRequest": 42, # Max number of findings that will be returned per request/job. When set within `InspectContentRequest`, the maximum returned is 2000 regardless if this is set higher.

949

"maxFindingsPerItem": 42, # Max number of findings that will be returned for each item scanned. When set within `InspectJobConfig`, the maximum returned is 2000 regardless if this is set higher. When set within `InspectContentRequest`, this field is ignored.

950

},

951

"infoTypes": [ # Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or listed at https://cloud.google.com/dlp/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. If you need precise control and predictability as to what detectors are run you should specify specific InfoTypes listed in the reference, otherwise a default list will be used, which may change over time.

952

{ # Type of information detected by the API.

953

"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

954

},

955

],

956

"ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type.

957

{ # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set.

958

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

959

{ # Type of information detected by the API.

960

"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

961

},

962

],

963

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

964

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

965

"exclusionRule": { # The rule that specifies conditions when findings of infoTypes specified in `InspectionRuleSet` are removed from results. # Exclusion rule.

966

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

967

"pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.

968

"groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included.

42,

],

},

"dictionary": { # Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://cloud.google.com/dlp/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API. # Dictionary which defines the rule.

973

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

974

"path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt

975

},

976

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

977

"words": [ # Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits. [required]

"A String",

],

},

},

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

983

"infoTypes": [ # InfoType list in ExclusionRule rule drops a finding when it overlaps or contained within with a finding of an infoType from this list. For example, for `InspectionRuleSet.info_types` containing "PHONE_NUMBER"` and `exclusion_rule` containing `exclude_info_types.info_types` with "EMAIL_ADDRESS" the phone number findings are dropped if they overlap with EMAIL_ADDRESS finding. That leads to "555-222-2222@example.org" to generate only a single finding, namely email address.

984

{ # Type of information detected by the API.

985

"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

},

],

},

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

990

},

991

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

992

"proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "$\d{3}$ \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "$xxx$", where "xxx" is the area code in question.

993

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

994

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

995

},

996

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

997

"pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.

998

"groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included.

42,

],

},

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

1003

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

1004

"relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`.

},

},

},

],

},

],

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

1012

},

1013

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

1014

{ # A task to execute on the completion of a job. See https://cloud.google.com/dlp/docs/concepts-actions to learn more.

1015

"publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count.

1016

},

1017

"saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.

1018

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

1019

"table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific timezone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.

1020

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

1021

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

1022

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call.

1023

},

1024

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.

1025

},

1026

},

1027

"publishSummaryToCscc": { # Publish the result summary of a DlpJob to the Cloud Security Command Center (CSCC Alpha). This action is only available for projects which are parts of an organization and whitelisted for the alpha Cloud Security Command Center. The action will publish count of finding instances and their info types. The summary of findings will be persisted in CSCC and are governed by CSCC service-specific policy, see https://cloud.google.com/terms/service-terms Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha).

1028

},

1029

"publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Cloud Data Catalog. Labels summarizing the results of the DlpJob will be applied to the entry for the resource scanned in Cloud Data Catalog. Any labels previously written by another DlpJob will be deleted. InfoType naming patterns are strictly enforced when using this feature. Note that the findings will be persisted in Cloud Data Catalog storage and are governed by Data Catalog service-specific policy, see https://cloud.google.com/terms/service-terms Only a single instance of this action can be specified and only allowed if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub.

1030

},

1031

"pubSub": { # Publish a message into given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/dlp/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a pubsub topic.

1032

"topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}.

1033

},

1034

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

1035

},

1036

},

1037

],

Bu Sun Kim

d059ad8

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

[diff] [blame]

1038

},

1039

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1040

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

1041

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

1042

{ # Statistics regarding a specific InfoType.

1043

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

1044

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

1045

"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

},

},

],

"hybridStats": { # Statistics related to processing hybrid inspect requests. # Statistics related to the processing of hybrid inspect. Early access feature is in a pre-release state and might change or have limited support. For more information, see https://cloud.google.com/products#product-launch-stages.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1050

"pendingCount": "A String", # The number of hybrid requests currently being processed. Only populated when called via method `getDlpJob`. A burst of traffic may cause hybrid inspect requests to be enqueued. Processing will take place as quickly as possible, but resource limitations may impact how long a request is enqueued for.

1051

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1052

"abortedCount": "A String", # The number of hybrid inspection requests aborted because the job ran out of quota or was ended before they could be processed.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1053

},

1054

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

1055

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

1056

},

Bu Sun Kim

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

[diff] [blame]

1057

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1058

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

1059

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1064

<code class="details" id="close">close()</code>

1065

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

1069

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1070

<pre>Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.

Bu Sun Kim

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

[diff] [blame]

1071

1072

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1073

parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)

Bu Sun Kim

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

[diff] [blame]

1074

body: object, The request body.

1075

The object takes the form of:

1076

1077

{ # Request message for CreateJobTrigger.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1078

"jobTrigger": { # Contains a configuration to make dlp api calls on a repeating basis. See https://cloud.google.com/dlp/docs/concepts-job-triggers to learn more. # Required. The JobTrigger to create.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1079

"name": "A String", # Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1080

"errors": [ # Output only. A stream of errors encountered when the trigger was activated. Repeated errors may result in the JobTrigger automatically being paused. Will return the last 100 errors. Whenever the JobTrigger is modified this list will be cleared.

1081

{ # Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger.

1082

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

1083

"A String",

1084

],

1085

"details": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Detailed error codes and messages.

1086

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

1087

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

1088

{

1089

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

1090

},

1091

],

1092

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1093

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1094

},

1095

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1096

"inspectJob": { # Controls what and how to inspect for findings. # For inspect jobs, a snapshot of the configuration.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1097

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1098

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1099

"identifyingFields": [ # Table fields that may uniquely identify a row within the table. When `actions.saveFindings.outputConfig.table` is specified, the values of columns specified here are available in the output table under `location.content_locations.record_location.record_key.id_values`. Nested fields such as `person.birthdate.year` are allowed.

1100

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

1101

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

1102

},

1103

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1104

"rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1105

"tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1106

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1107

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

1108

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1109

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1110

"sampleMethod": "A String",

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1111

"rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1112

"excludedFields": [ # References to fields excluded from scanning. This allows you to skip inspection of entire columns which you know have no findings.

1113

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

1114

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

},

],

},

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

1119

"bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.

1120

"fileTypes": [ # List of file type groups to include in the scan. If empty, all files are scanned and available data format processors are applied. In addition, the binary content of the selected files is always scanned as well. Images are scanned only as binary if the specified region does not support image inspection and no file_types were specified. Image inspection is restricted to 'global', 'us', 'asia', and 'europe'.

1121

"A String",

1122

],

1123

"filesLimitPercent": 42, # Limits the number of files to scan to this percentage of the input FileSet. Number of files scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0.

1124

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

1125

"regexFileSet": { # Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include. Included files are those that match at least one item in `include_regex` and do not match any items in `exclude_regex`. Note that a file that matches items from both lists will _not_ be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression. For example, given the input `{bucket_name: "mybucket", include_regex: ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * `gs://mybucket/directory1/myfile` will be included * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the full path doesn't match any items in `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path matches an item in `exclude_regex`) If `include_regex` is left empty, it will match all files by default (this is equivalent to setting `include_regex: [".*"]`). Some other common use cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all files in `mybucket` except for .pdf files * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will include all files directly under `gs://mybucket/directory/`, without matching across `/` # The regex-filtered set of files to scan. Exactly one of `url` or `regex_file_set` must be set.

1126

"excludeRegex": [ # A list of regular expressions matching file paths to exclude. All files in the bucket that match at least one of these regular expressions will be excluded from the scan. Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub.

1127

"A String",

1128

],

1129

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

1130

"includeRegex": [ # A list of regular expressions matching file paths to include. All files in the bucket that match at least one of these regular expressions will be included in the set of files, except for those that also match an item in `exclude_regex`. Leaving this field empty will match all files by default (this is equivalent to including `.*` in the list). Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found 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 `gs:///`. Trailing wildcard in the path is allowed. If the url ends in a trailing slash, the bucket or directory represented by the url will be scanned non-recursively (content in sub-directories will not be scanned). This means that `gs://mybucket/` is equivalent to `gs://mybucket/*`, and `gs://mybucket/directory/` is equivalent to `gs://mybucket/directory/*`. Exactly one of `url` or `regex_file_set` must be set.

1135

},

1136

"sampleMethod": "A String",

1137

"bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.

1138

},

1139

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

1140

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

1141

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

1142

},

1143

"partitionId": { # Datastore partition ID. A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty.

1144

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

1145

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

1146

},

1147

},

1148

"timespanConfig": { # Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Google Cloud Storage and BigQuery.

1149

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger.

1150

"startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied.

1151

"timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. For BigQuery: If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. For Datastore: If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`.

1152

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

1153

},

1154

"endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1155

},

1156

"hybridOptions": { # Configuration to control jobs where the content being inspected is outside of Google Cloud Platform. # Hybrid inspection options. Early access feature is in a pre-release state and might change or have limited support. For more information, see https://cloud.google.com/products#product-launch-stages.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1157

"labels": { # To organize findings, these labels will be added to each finding. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. No more than 10 labels can be associated with a given finding. Examples: * `"environment" : "production"` * `"pipeline" : "etl"`

1158

"a_key": "A String",

1159

},

1160

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

1161

"tableOptions": { # Instructions regarding the table content being inspected. # If the container is a table, additional information to make findings meaningful such as the columns that are primary keys.

1162

"identifyingFields": [ # The columns that are the primary keys for table objects included in ContentItem. A copy of this cell's value will stored alongside alongside each finding so that the finding can be traced to the specific row it came from. No more than 3 may be provided.

1163

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

1164

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

1165

},

1166

],

1167

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1168

"requiredFindingLabelKeys": [ # These are labels that each inspection request must include within their 'finding_labels' map. Request may contain others, but any missing one of these will be rejected. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. No more than 10 keys can be required.

1169

"A String",

1170

],

1171

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1172

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1173

"inspectTemplateName": "A String", # If provided, will be used as the default for all values in InspectConfig. `inspect_config` will be merged into the values persisted as part of the template.

1174

"inspectConfig": { # Configuration description of the scanning process. When used with redactContent only info_types and min_likelihood are currently used. # How and what to scan for.

1175

"includeQuote": True or False, # When true, a contextual quote from the data that triggered a finding is included in the response; see Finding.quote.

1176

"customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more.

1177

{ # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question.

1178

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

1179

"createTime": "A String", # Timestamp indicating when the version of the `StoredInfoType` used for inspection was created. Output-only field, populated by the system.

1180

"name": "A String", # Resource name of the requested `StoredInfoType`, for example `organizations/433245324/storedInfoTypes/432452342` or `projects/project-id/storedInfoTypes/432452342`.

1181

},

1182

"likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified.

1183

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

1184

"pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.

1185

"groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included.

42,

],

},

"dictionary": { # Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://cloud.google.com/dlp/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API. # A list of phrases to detect as a CustomInfoType.

1190

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

1191

"path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt

1192

},

1193

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

1194

"words": [ # Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits. [required]

"A String",

],

},

},

"exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching.

1200

"surrogateType": { # Message for detecting output from deidentification transformations such as [`CryptoReplaceFfxFpeConfig`](https://cloud.google.com/dlp/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig). These types of transformations are those that perform pseudonymization, thereby producing a "surrogate" as output. This should be used in conjunction with a field on the transformation such as `surrogate_info_type`. This CustomInfoType does not support the use of `detection_rules`. # Message for detecting output from deidentification transformations that support reversing.

1201

},

1202

"infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type.

1203

"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

1204

},

1205

"detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type` CustomInfoType.

1206

{ # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType.

1207

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

1208

"proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "$\d{3}$ \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "$xxx$", where "xxx" is the area code in question.

1209

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

1210

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

1211

},

1212

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

1213

"pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.

1214

"groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included.

42,

],

},

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

1219

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

1220

"relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`.

},

},

},

],

},

],

"contentOptions": [ # List of options defining data content to scan. If empty, text, images, and other content will be included.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1228

"A String",

1229

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1230

"minLikelihood": "A String", # Only returns findings equal or above this threshold. The default is POSSIBLE. See https://cloud.google.com/dlp/docs/likelihood to learn more.

1231

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

1232

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

1233

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

1234

"infoType": { # Type of information detected by the API. # Type of information the findings limit applies to. Only one limit per info_type should be provided. If InfoTypeLimit does not have an info_type, the DLP API applies the limit against all info_types that are found but not specified in another InfoTypeLimit.

1235

"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

1236

},

1237

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1238

},

1239

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1240

"maxFindingsPerRequest": 42, # Max number of findings that will be returned per request/job. When set within `InspectContentRequest`, the maximum returned is 2000 regardless if this is set higher.

1241

"maxFindingsPerItem": 42, # Max number of findings that will be returned for each item scanned. When set within `InspectJobConfig`, the maximum returned is 2000 regardless if this is set higher. When set within `InspectContentRequest`, this field is ignored.

1242

},

1243

"infoTypes": [ # Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or listed at https://cloud.google.com/dlp/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. If you need precise control and predictability as to what detectors are run you should specify specific InfoTypes listed in the reference, otherwise a default list will be used, which may change over time.

1244

{ # Type of information detected by the API.

1245

"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

1246

},

1247

],

1248

"ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type.

1249

{ # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set.

1250

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

1251

{ # Type of information detected by the API.

1252

"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

1253

},

1254

],

1255

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

1256

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

1257

"exclusionRule": { # The rule that specifies conditions when findings of infoTypes specified in `InspectionRuleSet` are removed from results. # Exclusion rule.

1258

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

1259

"pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.

1260

"groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included.

42,

],

},

"dictionary": { # Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://cloud.google.com/dlp/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API. # Dictionary which defines the rule.

1265

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

1266

"path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt

1267

},

1268

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

1269

"words": [ # Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits. [required]

"A String",

],

},

},

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

1275

"infoTypes": [ # InfoType list in ExclusionRule rule drops a finding when it overlaps or contained within with a finding of an infoType from this list. For example, for `InspectionRuleSet.info_types` containing "PHONE_NUMBER"` and `exclusion_rule` containing `exclude_info_types.info_types` with "EMAIL_ADDRESS" the phone number findings are dropped if they overlap with EMAIL_ADDRESS finding. That leads to "555-222-2222@example.org" to generate only a single finding, namely email address.

1276

{ # Type of information detected by the API.

1277

"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

},

],

},

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

1282

},

1283

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

1284

"proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "$\d{3}$ \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "$xxx$", where "xxx" is the area code in question.

1285

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

1286

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

1287

},

1288

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

1289

"pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.

1290

"groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included.

42,

],

},

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

1295

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

1296

"relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`.

},

},

},

],

},

],

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

1304

},

1305

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

1306

{ # A task to execute on the completion of a job. See https://cloud.google.com/dlp/docs/concepts-actions to learn more.

1307

"publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count.

1308

},

1309

"saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.

1310

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

1311

"table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific timezone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.

1312

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

1313

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

1314

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call.

1315

},

1316

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.

1317

},

1318

},

1319

"publishSummaryToCscc": { # Publish the result summary of a DlpJob to the Cloud Security Command Center (CSCC Alpha). This action is only available for projects which are parts of an organization and whitelisted for the alpha Cloud Security Command Center. The action will publish count of finding instances and their info types. The summary of findings will be persisted in CSCC and are governed by CSCC service-specific policy, see https://cloud.google.com/terms/service-terms Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha).

1320

},

1321

"publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Cloud Data Catalog. Labels summarizing the results of the DlpJob will be applied to the entry for the resource scanned in Cloud Data Catalog. Any labels previously written by another DlpJob will be deleted. InfoType naming patterns are strictly enforced when using this feature. Note that the findings will be persisted in Cloud Data Catalog storage and are governed by Data Catalog service-specific policy, see https://cloud.google.com/terms/service-terms Only a single instance of this action can be specified and only allowed if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub.

1322

},

1323

"pubSub": { # Publish a message into given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/dlp/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a pubsub topic.

1324

"topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}.

1325

},

1326

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

},

},

],

},

"triggers": [ # A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object.

1332

{ # What event needs to occur for a new job to be started.

1333

"schedule": { # Schedule for triggeredJobs. # Create a job on a repeating basis based on the elapse of time.

1334

"recurrencePeriodDuration": "A String", # With this option a job is started a regular periodic basis. For example: every day (86400 seconds). A scheduled start time will be skipped if the previous execution has not ended when its scheduled time occurs. This value must be set to a time duration greater than or equal to 1 day and can be no longer than 60 days.

1335

},

1336

"manual": { # Job trigger option for hybrid jobs. Jobs must be manually created and finished. # For use with hybrid jobs. Jobs must be manually created and finished. Early access feature is in a pre-release state and might change or have limited support. For more information, see https://cloud.google.com/products#product-launch-stages.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1337

},

1338

},

1339

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1340

"updateTime": "A String", # Output only. The last update timestamp of a triggeredJob.

1341

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

1342

"createTime": "A String", # Output only. The creation timestamp of a triggeredJob.

1343

"status": "A String", # Required. A status for this trigger.

1344

"description": "A String", # User provided description (max 256 chars)

1345

"lastRunTime": "A String", # Output only. The timestamp of the last time this trigger executed.

Bu Sun Kim

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

[diff] [blame]

1346

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1347

"locationId": "A String", # Deprecated. This field has no effect.

1348

"triggerId": "A String", # The trigger id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty to allow the system to generate one.

Bu Sun Kim

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

[diff] [blame]

1349

}

1350

1351

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1358

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1359

{ # Contains a configuration to make dlp api calls on a repeating basis. See https://cloud.google.com/dlp/docs/concepts-job-triggers to learn more.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1360

"name": "A String", # Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1361

"errors": [ # Output only. A stream of errors encountered when the trigger was activated. Repeated errors may result in the JobTrigger automatically being paused. Will return the last 100 errors. Whenever the JobTrigger is modified this list will be cleared.

1362

{ # Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger.

1363

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

1364

"A String",

1365

],

1366

"details": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Detailed error codes and messages.

1367

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

1368

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

1369

{

1370

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

1371

},

1372

],

1373

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1374

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1375

},

1376

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1377

"inspectJob": { # Controls what and how to inspect for findings. # For inspect jobs, a snapshot of the configuration.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1378

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1379

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1380

"identifyingFields": [ # Table fields that may uniquely identify a row within the table. When `actions.saveFindings.outputConfig.table` is specified, the values of columns specified here are available in the output table under `location.content_locations.record_location.record_key.id_values`. Nested fields such as `person.birthdate.year` are allowed.

1381

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

1382

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

1383

},

1384

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1385

"rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1386

"tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1387

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1388

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

1389

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1390

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1391

"sampleMethod": "A String",

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1392

"rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1393

"excludedFields": [ # References to fields excluded from scanning. This allows you to skip inspection of entire columns which you know have no findings.

1394

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

1395

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

},

],

},

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

1400

"bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.

1401

"fileTypes": [ # List of file type groups to include in the scan. If empty, all files are scanned and available data format processors are applied. In addition, the binary content of the selected files is always scanned as well. Images are scanned only as binary if the specified region does not support image inspection and no file_types were specified. Image inspection is restricted to 'global', 'us', 'asia', and 'europe'.

1402

"A String",

1403

],

1404

"filesLimitPercent": 42, # Limits the number of files to scan to this percentage of the input FileSet. Number of files scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0.

1405

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

1406

"regexFileSet": { # Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include. Included files are those that match at least one item in `include_regex` and do not match any items in `exclude_regex`. Note that a file that matches items from both lists will _not_ be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression. For example, given the input `{bucket_name: "mybucket", include_regex: ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * `gs://mybucket/directory1/myfile` will be included * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the full path doesn't match any items in `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path matches an item in `exclude_regex`) If `include_regex` is left empty, it will match all files by default (this is equivalent to setting `include_regex: [".*"]`). Some other common use cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all files in `mybucket` except for .pdf files * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will include all files directly under `gs://mybucket/directory/`, without matching across `/` # The regex-filtered set of files to scan. Exactly one of `url` or `regex_file_set` must be set.

1407

"excludeRegex": [ # A list of regular expressions matching file paths to exclude. All files in the bucket that match at least one of these regular expressions will be excluded from the scan. Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub.

1408

"A String",

1409

],

1410

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

1411

"includeRegex": [ # A list of regular expressions matching file paths to include. All files in the bucket that match at least one of these regular expressions will be included in the set of files, except for those that also match an item in `exclude_regex`. Leaving this field empty will match all files by default (this is equivalent to including `.*` in the list). Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found 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 `gs:///`. Trailing wildcard in the path is allowed. If the url ends in a trailing slash, the bucket or directory represented by the url will be scanned non-recursively (content in sub-directories will not be scanned). This means that `gs://mybucket/` is equivalent to `gs://mybucket/*`, and `gs://mybucket/directory/` is equivalent to `gs://mybucket/directory/*`. Exactly one of `url` or `regex_file_set` must be set.

1416

},

1417

"sampleMethod": "A String",

1418

"bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.

1419

},

1420

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

1421

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

1422

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

1423

},

1424

"partitionId": { # Datastore partition ID. A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty.

1425

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

1426

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

1427

},

1428

},

1429

"timespanConfig": { # Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Google Cloud Storage and BigQuery.

1430

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger.

1431

"startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied.

1432

"timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. For BigQuery: If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. For Datastore: If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`.

1433

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

1434

},

1435

"endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1436

},

1437

"hybridOptions": { # Configuration to control jobs where the content being inspected is outside of Google Cloud Platform. # Hybrid inspection options. Early access feature is in a pre-release state and might change or have limited support. For more information, see https://cloud.google.com/products#product-launch-stages.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1438

"labels": { # To organize findings, these labels will be added to each finding. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. No more than 10 labels can be associated with a given finding. Examples: * `"environment" : "production"` * `"pipeline" : "etl"`

1439

"a_key": "A String",

1440

},

1441

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

1442

"tableOptions": { # Instructions regarding the table content being inspected. # If the container is a table, additional information to make findings meaningful such as the columns that are primary keys.

1443

"identifyingFields": [ # The columns that are the primary keys for table objects included in ContentItem. A copy of this cell's value will stored alongside alongside each finding so that the finding can be traced to the specific row it came from. No more than 3 may be provided.

1444

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

1445

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

1446

},

1447

],

1448

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1449

"requiredFindingLabelKeys": [ # These are labels that each inspection request must include within their 'finding_labels' map. Request may contain others, but any missing one of these will be rejected. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. No more than 10 keys can be required.

1450

"A String",

1451

],

1452

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1453

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1454

"inspectTemplateName": "A String", # If provided, will be used as the default for all values in InspectConfig. `inspect_config` will be merged into the values persisted as part of the template.

1455

"inspectConfig": { # Configuration description of the scanning process. When used with redactContent only info_types and min_likelihood are currently used. # How and what to scan for.

1456

"includeQuote": True or False, # When true, a contextual quote from the data that triggered a finding is included in the response; see Finding.quote.

1457

"customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more.

1458

{ # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question.

1459

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

1460

"createTime": "A String", # Timestamp indicating when the version of the `StoredInfoType` used for inspection was created. Output-only field, populated by the system.

1461

"name": "A String", # Resource name of the requested `StoredInfoType`, for example `organizations/433245324/storedInfoTypes/432452342` or `projects/project-id/storedInfoTypes/432452342`.

1462

},

1463

"likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified.

1464

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

1465

"pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.

1466

"groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included.

42,

],

},

"dictionary": { # Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://cloud.google.com/dlp/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API. # A list of phrases to detect as a CustomInfoType.

1471

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

1472

"path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt

1473

},

1474

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

1475

"words": [ # Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits. [required]

"A String",

],

},

},

"exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching.

1481

"surrogateType": { # Message for detecting output from deidentification transformations such as [`CryptoReplaceFfxFpeConfig`](https://cloud.google.com/dlp/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig). These types of transformations are those that perform pseudonymization, thereby producing a "surrogate" as output. This should be used in conjunction with a field on the transformation such as `surrogate_info_type`. This CustomInfoType does not support the use of `detection_rules`. # Message for detecting output from deidentification transformations that support reversing.

1482

},

1483

"infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type.

1484

"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

1485

},

1486

"detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type` CustomInfoType.

1487

{ # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType.

1488

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

1489

"proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "$\d{3}$ \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "$xxx$", where "xxx" is the area code in question.

1490

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

1491

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

1492

},

1493

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

1494

"pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.

1495

"groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included.

42,

],

},

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

1500

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

1501

"relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`.

},

},

},

],

},

],

"contentOptions": [ # List of options defining data content to scan. If empty, text, images, and other content will be included.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1509

"A String",

1510

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1511

"minLikelihood": "A String", # Only returns findings equal or above this threshold. The default is POSSIBLE. See https://cloud.google.com/dlp/docs/likelihood to learn more.

1512

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

1513

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

1514

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

1515

"infoType": { # Type of information detected by the API. # Type of information the findings limit applies to. Only one limit per info_type should be provided. If InfoTypeLimit does not have an info_type, the DLP API applies the limit against all info_types that are found but not specified in another InfoTypeLimit.

1516

"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

1517

},

1518

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1519

},

1520

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1521

"maxFindingsPerRequest": 42, # Max number of findings that will be returned per request/job. When set within `InspectContentRequest`, the maximum returned is 2000 regardless if this is set higher.

1522

"maxFindingsPerItem": 42, # Max number of findings that will be returned for each item scanned. When set within `InspectJobConfig`, the maximum returned is 2000 regardless if this is set higher. When set within `InspectContentRequest`, this field is ignored.

1523

},

1524

"infoTypes": [ # Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or listed at https://cloud.google.com/dlp/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. If you need precise control and predictability as to what detectors are run you should specify specific InfoTypes listed in the reference, otherwise a default list will be used, which may change over time.

1525

{ # Type of information detected by the API.

1526

"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

1527

},

1528

],

1529

"ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type.

1530

{ # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set.

1531

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

1532

{ # Type of information detected by the API.

1533

"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

1534

},

1535

],

1536

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

1537

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

1538

"exclusionRule": { # The rule that specifies conditions when findings of infoTypes specified in `InspectionRuleSet` are removed from results. # Exclusion rule.

1539

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

1540

"pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.

1541

"groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included.

42,

],

},

"dictionary": { # Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://cloud.google.com/dlp/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API. # Dictionary which defines the rule.

1546

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

1547

"path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt

1548

},

1549

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

1550

"words": [ # Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits. [required]

"A String",

],

},

},

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

1556

"infoTypes": [ # InfoType list in ExclusionRule rule drops a finding when it overlaps or contained within with a finding of an infoType from this list. For example, for `InspectionRuleSet.info_types` containing "PHONE_NUMBER"` and `exclusion_rule` containing `exclude_info_types.info_types` with "EMAIL_ADDRESS" the phone number findings are dropped if they overlap with EMAIL_ADDRESS finding. That leads to "555-222-2222@example.org" to generate only a single finding, namely email address.

1557

{ # Type of information detected by the API.

1558

"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

},

],

},

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

1563

},

1564

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

1565

"proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "$\d{3}$ \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "$xxx$", where "xxx" is the area code in question.

1566

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

1567

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

1568

},

1569

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

1570

"pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.

1571

"groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included.

42,

],

},

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

1576

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

1577

"relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`.

},

},

},

],

},

],

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

1585

},

1586

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

1587

{ # A task to execute on the completion of a job. See https://cloud.google.com/dlp/docs/concepts-actions to learn more.

1588

"publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count.

1589

},

1590

"saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.

1591

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

1592

"table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific timezone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.

1593

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

1594

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

1595

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call.

1596

},

1597

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.

1598

},

1599

},

1600

"publishSummaryToCscc": { # Publish the result summary of a DlpJob to the Cloud Security Command Center (CSCC Alpha). This action is only available for projects which are parts of an organization and whitelisted for the alpha Cloud Security Command Center. The action will publish count of finding instances and their info types. The summary of findings will be persisted in CSCC and are governed by CSCC service-specific policy, see https://cloud.google.com/terms/service-terms Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha).

1601

},

1602

"publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Cloud Data Catalog. Labels summarizing the results of the DlpJob will be applied to the entry for the resource scanned in Cloud Data Catalog. Any labels previously written by another DlpJob will be deleted. InfoType naming patterns are strictly enforced when using this feature. Note that the findings will be persisted in Cloud Data Catalog storage and are governed by Data Catalog service-specific policy, see https://cloud.google.com/terms/service-terms Only a single instance of this action can be specified and only allowed if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub.

1603

},

1604

"pubSub": { # Publish a message into given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/dlp/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a pubsub topic.

1605

"topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}.

1606

},

1607

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

},

},

],

},

"triggers": [ # A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object.

1613

{ # What event needs to occur for a new job to be started.

1614

"schedule": { # Schedule for triggeredJobs. # Create a job on a repeating basis based on the elapse of time.

1615

"recurrencePeriodDuration": "A String", # With this option a job is started a regular periodic basis. For example: every day (86400 seconds). A scheduled start time will be skipped if the previous execution has not ended when its scheduled time occurs. This value must be set to a time duration greater than or equal to 1 day and can be no longer than 60 days.

1616

},

1617

"manual": { # Job trigger option for hybrid jobs. Jobs must be manually created and finished. # For use with hybrid jobs. Jobs must be manually created and finished. Early access feature is in a pre-release state and might change or have limited support. For more information, see https://cloud.google.com/products#product-launch-stages.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1618

},

1619

},

1620

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1621

"updateTime": "A String", # Output only. The last update timestamp of a triggeredJob.

1622

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

1623

"createTime": "A String", # Output only. The creation timestamp of a triggeredJob.

1624

"status": "A String", # Required. A status for this trigger.

1625

"description": "A String", # User provided description (max 256 chars)

1626

"lastRunTime": "A String", # Output only. The timestamp of the last time this trigger executed.

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>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1632

<pre>Deletes a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.

Bu Sun Kim

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

[diff] [blame]

1633

1634

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1635

name: string, Required. Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`. (required)

Bu Sun Kim

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

[diff] [blame]

1636

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1643

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1644

{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1650

<pre>Gets a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.

Bu Sun Kim

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

[diff] [blame]

1651

1652

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1653

name: string, Required. Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`. (required)

Bu Sun Kim

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

[diff] [blame]

1654

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1661

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1662

{ # Contains a configuration to make dlp api calls on a repeating basis. See https://cloud.google.com/dlp/docs/concepts-job-triggers to learn more.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1663

"name": "A String", # Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1664

"errors": [ # Output only. A stream of errors encountered when the trigger was activated. Repeated errors may result in the JobTrigger automatically being paused. Will return the last 100 errors. Whenever the JobTrigger is modified this list will be cleared.

1665

{ # Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger.

1666

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

1667

"A String",

1668

],

1669

"details": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Detailed error codes and messages.

1670

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

1671

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

1672

{

1673

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

1674

},

1675

],

1676

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1677

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1678

},

1679

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1680

"inspectJob": { # Controls what and how to inspect for findings. # For inspect jobs, a snapshot of the configuration.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1681

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1682

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1683

"identifyingFields": [ # Table fields that may uniquely identify a row within the table. When `actions.saveFindings.outputConfig.table` is specified, the values of columns specified here are available in the output table under `location.content_locations.record_location.record_key.id_values`. Nested fields such as `person.birthdate.year` are allowed.

1684

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

1685

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

1686

},

1687

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1688

"rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1689

"tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1690

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1691

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

1692

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1693

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1694

"sampleMethod": "A String",

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1695

"rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1696

"excludedFields": [ # References to fields excluded from scanning. This allows you to skip inspection of entire columns which you know have no findings.

1697

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

1698

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

},

],

},

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

1703

"bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.

1704

"fileTypes": [ # List of file type groups to include in the scan. If empty, all files are scanned and available data format processors are applied. In addition, the binary content of the selected files is always scanned as well. Images are scanned only as binary if the specified region does not support image inspection and no file_types were specified. Image inspection is restricted to 'global', 'us', 'asia', and 'europe'.

1705

"A String",

1706

],

1707

"filesLimitPercent": 42, # Limits the number of files to scan to this percentage of the input FileSet. Number of files scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0.

1708

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

1709

"regexFileSet": { # Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include. Included files are those that match at least one item in `include_regex` and do not match any items in `exclude_regex`. Note that a file that matches items from both lists will _not_ be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression. For example, given the input `{bucket_name: "mybucket", include_regex: ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * `gs://mybucket/directory1/myfile` will be included * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the full path doesn't match any items in `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path matches an item in `exclude_regex`) If `include_regex` is left empty, it will match all files by default (this is equivalent to setting `include_regex: [".*"]`). Some other common use cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all files in `mybucket` except for .pdf files * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will include all files directly under `gs://mybucket/directory/`, without matching across `/` # The regex-filtered set of files to scan. Exactly one of `url` or `regex_file_set` must be set.

1710

"excludeRegex": [ # A list of regular expressions matching file paths to exclude. All files in the bucket that match at least one of these regular expressions will be excluded from the scan. Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub.

1711

"A String",

1712

],

1713

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

1714

"includeRegex": [ # A list of regular expressions matching file paths to include. All files in the bucket that match at least one of these regular expressions will be included in the set of files, except for those that also match an item in `exclude_regex`. Leaving this field empty will match all files by default (this is equivalent to including `.*` in the list). Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found 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 `gs:///`. Trailing wildcard in the path is allowed. If the url ends in a trailing slash, the bucket or directory represented by the url will be scanned non-recursively (content in sub-directories will not be scanned). This means that `gs://mybucket/` is equivalent to `gs://mybucket/*`, and `gs://mybucket/directory/` is equivalent to `gs://mybucket/directory/*`. Exactly one of `url` or `regex_file_set` must be set.

1719

},

1720

"sampleMethod": "A String",

1721

"bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.

1722

},

1723

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

1724

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

1725

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

1726

},

1727

"partitionId": { # Datastore partition ID. A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty.

1728

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

1729

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

1730

},

1731

},

1732

"timespanConfig": { # Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Google Cloud Storage and BigQuery.

1733

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger.

1734

"startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied.

1735

"timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. For BigQuery: If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. For Datastore: If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`.

1736

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

1737

},

1738

"endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1739

},

1740

"hybridOptions": { # Configuration to control jobs where the content being inspected is outside of Google Cloud Platform. # Hybrid inspection options. Early access feature is in a pre-release state and might change or have limited support. For more information, see https://cloud.google.com/products#product-launch-stages.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1741

"labels": { # To organize findings, these labels will be added to each finding. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. No more than 10 labels can be associated with a given finding. Examples: * `"environment" : "production"` * `"pipeline" : "etl"`

1742

"a_key": "A String",

1743

},

1744

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

1745

"tableOptions": { # Instructions regarding the table content being inspected. # If the container is a table, additional information to make findings meaningful such as the columns that are primary keys.

1746

"identifyingFields": [ # The columns that are the primary keys for table objects included in ContentItem. A copy of this cell's value will stored alongside alongside each finding so that the finding can be traced to the specific row it came from. No more than 3 may be provided.

1747

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

1748

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

1749

},

1750

],

1751

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1752

"requiredFindingLabelKeys": [ # These are labels that each inspection request must include within their 'finding_labels' map. Request may contain others, but any missing one of these will be rejected. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. No more than 10 keys can be required.

1753

"A String",

1754

],

1755

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1756

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1757

"inspectTemplateName": "A String", # If provided, will be used as the default for all values in InspectConfig. `inspect_config` will be merged into the values persisted as part of the template.

1758

"inspectConfig": { # Configuration description of the scanning process. When used with redactContent only info_types and min_likelihood are currently used. # How and what to scan for.

1759

"includeQuote": True or False, # When true, a contextual quote from the data that triggered a finding is included in the response; see Finding.quote.

1760

"customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more.

1761

{ # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question.

1762

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

1763

"createTime": "A String", # Timestamp indicating when the version of the `StoredInfoType` used for inspection was created. Output-only field, populated by the system.

1764

"name": "A String", # Resource name of the requested `StoredInfoType`, for example `organizations/433245324/storedInfoTypes/432452342` or `projects/project-id/storedInfoTypes/432452342`.

1765

},

1766

"likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified.

1767

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

1768

"pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.

1769

"groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included.

42,

],

},

"dictionary": { # Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://cloud.google.com/dlp/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API. # A list of phrases to detect as a CustomInfoType.

1774

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

1775

"path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt

1776

},

1777

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

1778

"words": [ # Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits. [required]

"A String",

],

},

},

"exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching.

1784

"surrogateType": { # Message for detecting output from deidentification transformations such as [`CryptoReplaceFfxFpeConfig`](https://cloud.google.com/dlp/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig). These types of transformations are those that perform pseudonymization, thereby producing a "surrogate" as output. This should be used in conjunction with a field on the transformation such as `surrogate_info_type`. This CustomInfoType does not support the use of `detection_rules`. # Message for detecting output from deidentification transformations that support reversing.

1785

},

1786

"infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type.

1787

"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

1788

},

1789

"detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type` CustomInfoType.

1790

{ # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType.

1791

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

1792

"proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "$\d{3}$ \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "$xxx$", where "xxx" is the area code in question.

1793

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

1794

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

1795

},

1796

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

1797

"pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.

1798

"groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included.

42,

],

},

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

1803

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

1804

"relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`.

},

},

},

],

},

],

"contentOptions": [ # List of options defining data content to scan. If empty, text, images, and other content will be included.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1812

"A String",

1813

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1814

"minLikelihood": "A String", # Only returns findings equal or above this threshold. The default is POSSIBLE. See https://cloud.google.com/dlp/docs/likelihood to learn more.

1815

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

1816

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

1817

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

1818

"infoType": { # Type of information detected by the API. # Type of information the findings limit applies to. Only one limit per info_type should be provided. If InfoTypeLimit does not have an info_type, the DLP API applies the limit against all info_types that are found but not specified in another InfoTypeLimit.

1819

"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

1820

},

1821

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1822

},

1823

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1824

"maxFindingsPerRequest": 42, # Max number of findings that will be returned per request/job. When set within `InspectContentRequest`, the maximum returned is 2000 regardless if this is set higher.

1825

"maxFindingsPerItem": 42, # Max number of findings that will be returned for each item scanned. When set within `InspectJobConfig`, the maximum returned is 2000 regardless if this is set higher. When set within `InspectContentRequest`, this field is ignored.

1826

},

1827

"infoTypes": [ # Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or listed at https://cloud.google.com/dlp/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. If you need precise control and predictability as to what detectors are run you should specify specific InfoTypes listed in the reference, otherwise a default list will be used, which may change over time.

1828

{ # Type of information detected by the API.

1829

"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

1830

},

1831

],

1832

"ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type.

1833

{ # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set.

1834

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

1835

{ # Type of information detected by the API.

1836

"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

1837

},

1838

],

1839

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

1840

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

1841

"exclusionRule": { # The rule that specifies conditions when findings of infoTypes specified in `InspectionRuleSet` are removed from results. # Exclusion rule.

1842

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

1843

"pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.

1844

"groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included.

42,

],

},

"dictionary": { # Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://cloud.google.com/dlp/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API. # Dictionary which defines the rule.

1849

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

1850

"path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt

1851

},

1852

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

1853

"words": [ # Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits. [required]

"A String",

],

},

},

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

1859

"infoTypes": [ # InfoType list in ExclusionRule rule drops a finding when it overlaps or contained within with a finding of an infoType from this list. For example, for `InspectionRuleSet.info_types` containing "PHONE_NUMBER"` and `exclusion_rule` containing `exclude_info_types.info_types` with "EMAIL_ADDRESS" the phone number findings are dropped if they overlap with EMAIL_ADDRESS finding. That leads to "555-222-2222@example.org" to generate only a single finding, namely email address.

1860

{ # Type of information detected by the API.

1861

"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

},

],

},

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

1866

},

1867

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

1868

"proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "$\d{3}$ \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "$xxx$", where "xxx" is the area code in question.

1869

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

1870

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

1871

},

1872

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

1873

"pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.

1874

"groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included.

42,

],

},

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

1879

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

1880

"relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`.

},

},

},

],

},

],

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

1888

},

1889

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

1890

{ # A task to execute on the completion of a job. See https://cloud.google.com/dlp/docs/concepts-actions to learn more.

1891

"publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count.

1892

},

1893

"saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.

1894

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

1895

"table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific timezone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.

1896

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

1897

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

1898

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call.

1899

},

1900

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.

1901

},

1902

},

1903

"publishSummaryToCscc": { # Publish the result summary of a DlpJob to the Cloud Security Command Center (CSCC Alpha). This action is only available for projects which are parts of an organization and whitelisted for the alpha Cloud Security Command Center. The action will publish count of finding instances and their info types. The summary of findings will be persisted in CSCC and are governed by CSCC service-specific policy, see https://cloud.google.com/terms/service-terms Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha).

1904

},

1905

"publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Cloud Data Catalog. Labels summarizing the results of the DlpJob will be applied to the entry for the resource scanned in Cloud Data Catalog. Any labels previously written by another DlpJob will be deleted. InfoType naming patterns are strictly enforced when using this feature. Note that the findings will be persisted in Cloud Data Catalog storage and are governed by Data Catalog service-specific policy, see https://cloud.google.com/terms/service-terms Only a single instance of this action can be specified and only allowed if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub.

1906

},

1907

"pubSub": { # Publish a message into given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/dlp/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a pubsub topic.

1908

"topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}.

1909

},

1910

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

},

},

],

},

"triggers": [ # A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object.

1916

{ # What event needs to occur for a new job to be started.

1917

"schedule": { # Schedule for triggeredJobs. # Create a job on a repeating basis based on the elapse of time.

1918

"recurrencePeriodDuration": "A String", # With this option a job is started a regular periodic basis. For example: every day (86400 seconds). A scheduled start time will be skipped if the previous execution has not ended when its scheduled time occurs. This value must be set to a time duration greater than or equal to 1 day and can be no longer than 60 days.

1919

},

1920

"manual": { # Job trigger option for hybrid jobs. Jobs must be manually created and finished. # For use with hybrid jobs. Jobs must be manually created and finished. Early access feature is in a pre-release state and might change or have limited support. For more information, see https://cloud.google.com/products#product-launch-stages.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1921

},

1922

},

1923

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1924

"updateTime": "A String", # Output only. The last update timestamp of a triggeredJob.

1925

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

1926

"createTime": "A String", # Output only. The creation timestamp of a triggeredJob.

1927

"status": "A String", # Required. A status for this trigger.

1928

"description": "A String", # User provided description (max 256 chars)

1929

"lastRunTime": "A String", # Output only. The timestamp of the last time this trigger executed.

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>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1935

<pre>Inspect hybrid content and store findings to a trigger. The inspection will be processed asynchronously. To review the findings monitor the jobs within the trigger. Early access feature is in a pre-release state and might change or have limited support. For more information, see https://cloud.google.com/products#product-launch-stages.

Bu Sun Kim

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

[diff] [blame]

1936

1937

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1938

name: string, Required. Resource name of the trigger to execute a hybrid inspect on, for example `projects/dlp-test-project/jobTriggers/53234423`. (required)

Bu Sun Kim

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

[diff] [blame]

1939

body: object, The request body.

1940

The object takes the form of:

1941

1942

{ # Request to search for potentially sensitive info in a custom location.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1943

"hybridItem": { # An individual hybrid item to inspect. Will be stored temporarily during processing. # The item to inspect.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1944

"findingDetails": { # Populate to associate additional data with each finding. # Supplementary information that will be added to each finding.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1945

"containerDetails": { # Represents a container that may contain DLP findings. Examples of a container include a file, table, or database record. # Details about the container where the content being inspected is from.

1946

"version": "A String", # Findings container version, if available ("generation" for Google Cloud Storage).

1947

"relativePath": "A String", # The rest of the path after the root. Examples: - For BigQuery table `project_id:dataset_id.table_id`, the relative path is `table_id` - Google Cloud Storage file `gs://bucket/folder/filename.txt`, the relative path is `folder/filename.txt`

1948

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

1949

"fullPath": "A String", # A string representation of the full container name. Examples: - BigQuery: 'Project:DataSetId.TableId' - Google Cloud Storage: 'gs://Bucket/folders/filename.txt'

1950

"rootPath": "A String", # The root of the container. Examples: - For BigQuery table `project_id:dataset_id.table_id`, the root is `dataset_id` - For Google Cloud Storage file `gs://bucket/folder/filename.txt`, the root is `gs://bucket`

1951

"projectId": "A String", # Project where the finding was found. Can be different from the project that owns the finding.

1952

"updateTime": "A String", # Findings container modification timestamp, if applicable. For Google Cloud Storage contains last file modification timestamp. For BigQuery table contains last_modified_time property. For Datastore - not populated.

1953

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1954

"tableOptions": { # Instructions regarding the table content being inspected. # If the container is a table, additional information to make findings meaningful such as the columns that are primary keys. If not known ahead of time, can also be set within each inspect hybrid call and the two will be merged. Note that identifying_fields will only be stored to BigQuery, and only if the BigQuery action has been included.

1955

"identifyingFields": [ # The columns that are the primary keys for table objects included in ContentItem. A copy of this cell's value will stored alongside alongside each finding so that the finding can be traced to the specific row it came from. No more than 3 may be provided.

1956

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

1957

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

1958

},

1959

],

1960

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1961

"fileOffset": "A String", # Offset in bytes of the line, from the beginning of the file, where the finding is located. Populate if the item being scanned is only part of a bigger item, such as a shard of a file and you want to track the absolute position of the finding.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1962

"labels": { # Labels to represent user provided metadata about the data being inspected. If configured by the job, some key values may be required. The labels associated with `Finding`'s produced by hybrid inspection. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. No more than 10 labels can be associated with a given finding. Examples: * `"environment" : "production"` * `"pipeline" : "etl"`

1963

"a_key": "A String",

1964

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1965

"rowOffset": "A String", # Offset of the row for tables. Populate if the row(s) being scanned are part of a bigger dataset and you want to keep track of their absolute position.

1966

},

1967

"item": { # Container structure for the content to inspect. # The item to inspect.

1968

"table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more.

1969

"headers": [ # Headers of the table.

1970

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

1971

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

1972

},

1973

],

1974

"rows": [ # Rows of the table.

1975

{ # Values of the row.

1976

"values": [ # Individual cells.

1977

{ # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data.

1978

"integerValue": "A String", # integer

1979

"dateValue": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # date

1980

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

1981

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

1982

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

1983

},

1984

"stringValue": "A String", # string

1985

"timestampValue": "A String", # timestamp

1986

"floatValue": 3.14, # float

1987

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

1988

"booleanValue": True or False, # boolean

1989

"timeValue": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # time of day

1990

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.

1991

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

1992

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.

1993

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

},

},

],

},

],

},

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

2001

"byteItem": { # Container for bytes to inspect or redact. # Content data to inspect or redact. Replaces `type` and `data`.

2002

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

2003

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

2004

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2005

},

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:

2016

2017

{ # Quota exceeded errors will be thrown once quota has been met.

}</pre>

</div>

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2022

<code class="details" id="list">list(parent, orderBy=None, locationId=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2023

<pre>Lists job triggers. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.

Bu Sun Kim

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

[diff] [blame]

2024

2025

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2026

parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2027

orderBy: string, Comma separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the JobTrigger was created. - `update_time`: corresponds to time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to JobTrigger's name. - `display_name`: corresponds to JobTrigger's display name. - `status`: corresponds to JobTrigger's status.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2028

locationId: string, Deprecated. This field has no effect.

2029

filter: string, Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters.

2030

pageSize: integer, Size of the page, can be limited by a server.

2031

pageToken: string, Page token to continue retrieval. Comes from previous call to ListJobTriggers. `order_by` field must not change for subsequent calls.

Bu Sun Kim

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

[diff] [blame]

2032

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2039

2040

{ # Response message for ListJobTriggers.

2041

"jobTriggers": [ # List of triggeredJobs, up to page_size in ListJobTriggersRequest.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2042

{ # Contains a configuration to make dlp api calls on a repeating basis. See https://cloud.google.com/dlp/docs/concepts-job-triggers to learn more.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2043

"name": "A String", # Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2044

"errors": [ # Output only. A stream of errors encountered when the trigger was activated. Repeated errors may result in the JobTrigger automatically being paused. Will return the last 100 errors. Whenever the JobTrigger is modified this list will be cleared.

2045

{ # Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger.

2046

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

2047

"A String",

2048

],

2049

"details": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Detailed error codes and messages.

2050

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

2051

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

2052

{

2053

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

2054

},

2055

],

2056

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2057

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2058

},

2059

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2060

"inspectJob": { # Controls what and how to inspect for findings. # For inspect jobs, a snapshot of the configuration.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

2061

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

2062

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2063

"identifyingFields": [ # Table fields that may uniquely identify a row within the table. When `actions.saveFindings.outputConfig.table` is specified, the values of columns specified here are available in the output table under `location.content_locations.record_location.record_key.id_values`. Nested fields such as `person.birthdate.year` are allowed.

2064

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

2065

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

2066

},

2067

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2068

"rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2069

"tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2070

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2071

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

2072

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2073

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

2074

"sampleMethod": "A String",

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2075

"rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2076

"excludedFields": [ # References to fields excluded from scanning. This allows you to skip inspection of entire columns which you know have no findings.

2077

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

2078

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

},

],

},

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

2083

"bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.

2084

"fileTypes": [ # List of file type groups to include in the scan. If empty, all files are scanned and available data format processors are applied. In addition, the binary content of the selected files is always scanned as well. Images are scanned only as binary if the specified region does not support image inspection and no file_types were specified. Image inspection is restricted to 'global', 'us', 'asia', and 'europe'.

2085

"A String",

2086

],

2087

"filesLimitPercent": 42, # Limits the number of files to scan to this percentage of the input FileSet. Number of files scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0.

2088

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

2089

"regexFileSet": { # Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include. Included files are those that match at least one item in `include_regex` and do not match any items in `exclude_regex`. Note that a file that matches items from both lists will _not_ be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression. For example, given the input `{bucket_name: "mybucket", include_regex: ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * `gs://mybucket/directory1/myfile` will be included * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the full path doesn't match any items in `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path matches an item in `exclude_regex`) If `include_regex` is left empty, it will match all files by default (this is equivalent to setting `include_regex: [".*"]`). Some other common use cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all files in `mybucket` except for .pdf files * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will include all files directly under `gs://mybucket/directory/`, without matching across `/` # The regex-filtered set of files to scan. Exactly one of `url` or `regex_file_set` must be set.

2090

"excludeRegex": [ # A list of regular expressions matching file paths to exclude. All files in the bucket that match at least one of these regular expressions will be excluded from the scan. Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub.

2091

"A String",

2092

],

2093

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

2094

"includeRegex": [ # A list of regular expressions matching file paths to include. All files in the bucket that match at least one of these regular expressions will be included in the set of files, except for those that also match an item in `exclude_regex`. Leaving this field empty will match all files by default (this is equivalent to including `.*` in the list). Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found 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 `gs:///`. Trailing wildcard in the path is allowed. If the url ends in a trailing slash, the bucket or directory represented by the url will be scanned non-recursively (content in sub-directories will not be scanned). This means that `gs://mybucket/` is equivalent to `gs://mybucket/*`, and `gs://mybucket/directory/` is equivalent to `gs://mybucket/directory/*`. Exactly one of `url` or `regex_file_set` must be set.

2099

},

2100

"sampleMethod": "A String",

2101

"bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.

2102

},

2103

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

2104

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

2105

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

2106

},

2107

"partitionId": { # Datastore partition ID. A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty.

2108

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

2109

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

2110

},

2111

},

2112

"timespanConfig": { # Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Google Cloud Storage and BigQuery.

2113

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger.

2114

"startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied.

2115

"timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. For BigQuery: If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. For Datastore: If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`.

2116

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

2117

},

2118

"endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

2119

},

2120

"hybridOptions": { # Configuration to control jobs where the content being inspected is outside of Google Cloud Platform. # Hybrid inspection options. Early access feature is in a pre-release state and might change or have limited support. For more information, see https://cloud.google.com/products#product-launch-stages.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

2121

"labels": { # To organize findings, these labels will be added to each finding. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. No more than 10 labels can be associated with a given finding. Examples: * `"environment" : "production"` * `"pipeline" : "etl"`

2122

"a_key": "A String",

2123

},

2124

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

2125

"tableOptions": { # Instructions regarding the table content being inspected. # If the container is a table, additional information to make findings meaningful such as the columns that are primary keys.

2126

"identifyingFields": [ # The columns that are the primary keys for table objects included in ContentItem. A copy of this cell's value will stored alongside alongside each finding so that the finding can be traced to the specific row it came from. No more than 3 may be provided.

2127

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

2128

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

2129

},

2130

],

2131

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2132

"requiredFindingLabelKeys": [ # These are labels that each inspection request must include within their 'finding_labels' map. Request may contain others, but any missing one of these will be rejected. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. No more than 10 keys can be required.

2133

"A String",

2134

],

2135

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

2136

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2137

"inspectTemplateName": "A String", # If provided, will be used as the default for all values in InspectConfig. `inspect_config` will be merged into the values persisted as part of the template.

2138

"inspectConfig": { # Configuration description of the scanning process. When used with redactContent only info_types and min_likelihood are currently used. # How and what to scan for.

2139

"includeQuote": True or False, # When true, a contextual quote from the data that triggered a finding is included in the response; see Finding.quote.

2140

"customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more.

2141

{ # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question.

2142

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

2143

"createTime": "A String", # Timestamp indicating when the version of the `StoredInfoType` used for inspection was created. Output-only field, populated by the system.

2144

"name": "A String", # Resource name of the requested `StoredInfoType`, for example `organizations/433245324/storedInfoTypes/432452342` or `projects/project-id/storedInfoTypes/432452342`.

2145

},

2146

"likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified.

2147

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

2148

"pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.

2149

"groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included.

42,

],

},

"dictionary": { # Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://cloud.google.com/dlp/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API. # A list of phrases to detect as a CustomInfoType.

2154

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

2155

"path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt

2156

},

2157

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

2158

"words": [ # Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits. [required]

"A String",

],

},

},

"exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching.

2164

"surrogateType": { # Message for detecting output from deidentification transformations such as [`CryptoReplaceFfxFpeConfig`](https://cloud.google.com/dlp/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig). These types of transformations are those that perform pseudonymization, thereby producing a "surrogate" as output. This should be used in conjunction with a field on the transformation such as `surrogate_info_type`. This CustomInfoType does not support the use of `detection_rules`. # Message for detecting output from deidentification transformations that support reversing.

2165

},

2166

"infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type.

2167

"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

2168

},

2169

"detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type` CustomInfoType.

2170

{ # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType.

2171

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

2172

"proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "$\d{3}$ \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "$xxx$", where "xxx" is the area code in question.

2173

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

2174

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

2175

},

2176

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

2177

"pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.

2178

"groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included.

42,

],

},

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

2183

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

2184

"relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`.

},

},

},

],

},

],

"contentOptions": [ # List of options defining data content to scan. If empty, text, images, and other content will be included.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2192

"A String",

2193

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2194

"minLikelihood": "A String", # Only returns findings equal or above this threshold. The default is POSSIBLE. See https://cloud.google.com/dlp/docs/likelihood to learn more.

2195

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

2196

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

2197

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

2198

"infoType": { # Type of information detected by the API. # Type of information the findings limit applies to. Only one limit per info_type should be provided. If InfoTypeLimit does not have an info_type, the DLP API applies the limit against all info_types that are found but not specified in another InfoTypeLimit.

2199

"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

2200

},

2201

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2202

},

2203

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2204

"maxFindingsPerRequest": 42, # Max number of findings that will be returned per request/job. When set within `InspectContentRequest`, the maximum returned is 2000 regardless if this is set higher.

2205

"maxFindingsPerItem": 42, # Max number of findings that will be returned for each item scanned. When set within `InspectJobConfig`, the maximum returned is 2000 regardless if this is set higher. When set within `InspectContentRequest`, this field is ignored.

2206

},

2207

"infoTypes": [ # Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or listed at https://cloud.google.com/dlp/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. If you need precise control and predictability as to what detectors are run you should specify specific InfoTypes listed in the reference, otherwise a default list will be used, which may change over time.

2208

{ # Type of information detected by the API.

2209

"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

2210

},

2211

],

2212

"ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type.

2213

{ # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set.

2214

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

2215

{ # Type of information detected by the API.

2216

"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

2217

},

2218

],

2219

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

2220

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

2221

"exclusionRule": { # The rule that specifies conditions when findings of infoTypes specified in `InspectionRuleSet` are removed from results. # Exclusion rule.

2222

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

2223

"pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.

2224

"groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included.

42,

],

},

"dictionary": { # Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://cloud.google.com/dlp/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API. # Dictionary which defines the rule.

2229

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

2230

"path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt

2231

},

2232

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

2233

"words": [ # Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits. [required]

"A String",

],

},

},

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

2239

"infoTypes": [ # InfoType list in ExclusionRule rule drops a finding when it overlaps or contained within with a finding of an infoType from this list. For example, for `InspectionRuleSet.info_types` containing "PHONE_NUMBER"` and `exclusion_rule` containing `exclude_info_types.info_types` with "EMAIL_ADDRESS" the phone number findings are dropped if they overlap with EMAIL_ADDRESS finding. That leads to "555-222-2222@example.org" to generate only a single finding, namely email address.

2240

{ # Type of information detected by the API.

2241

"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

},

],

},

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

2246

},

2247

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

2248

"proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "$\d{3}$ \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "$xxx$", where "xxx" is the area code in question.

2249

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

2250

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

2251

},

2252

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

2253

"pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.

2254

"groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included.

42,

],

},

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

2259

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

2260

"relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`.

},

},

},

],

},

],

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

2268

},

2269

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

2270

{ # A task to execute on the completion of a job. See https://cloud.google.com/dlp/docs/concepts-actions to learn more.

2271

"publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count.

2272

},

2273

"saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.

2274

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

2275

"table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific timezone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.

2276

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

2277

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

2278

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call.

2279

},

2280

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.

2281

},

2282

},

2283

"publishSummaryToCscc": { # Publish the result summary of a DlpJob to the Cloud Security Command Center (CSCC Alpha). This action is only available for projects which are parts of an organization and whitelisted for the alpha Cloud Security Command Center. The action will publish count of finding instances and their info types. The summary of findings will be persisted in CSCC and are governed by CSCC service-specific policy, see https://cloud.google.com/terms/service-terms Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha).

2284

},

2285

"publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Cloud Data Catalog. Labels summarizing the results of the DlpJob will be applied to the entry for the resource scanned in Cloud Data Catalog. Any labels previously written by another DlpJob will be deleted. InfoType naming patterns are strictly enforced when using this feature. Note that the findings will be persisted in Cloud Data Catalog storage and are governed by Data Catalog service-specific policy, see https://cloud.google.com/terms/service-terms Only a single instance of this action can be specified and only allowed if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub.

2286

},

2287

"pubSub": { # Publish a message into given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/dlp/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a pubsub topic.

2288

"topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}.

2289

},

2290

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

},

},

],

},

"triggers": [ # A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object.

2296

{ # What event needs to occur for a new job to be started.

2297

"schedule": { # Schedule for triggeredJobs. # Create a job on a repeating basis based on the elapse of time.

2298

"recurrencePeriodDuration": "A String", # With this option a job is started a regular periodic basis. For example: every day (86400 seconds). A scheduled start time will be skipped if the previous execution has not ended when its scheduled time occurs. This value must be set to a time duration greater than or equal to 1 day and can be no longer than 60 days.

2299

},

2300

"manual": { # Job trigger option for hybrid jobs. Jobs must be manually created and finished. # For use with hybrid jobs. Jobs must be manually created and finished. Early access feature is in a pre-release state and might change or have limited support. For more information, see https://cloud.google.com/products#product-launch-stages.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

2301

},

2302

},

2303

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2304

"updateTime": "A String", # Output only. The last update timestamp of a triggeredJob.

2305

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

2306

"createTime": "A String", # Output only. The creation timestamp of a triggeredJob.

2307

"status": "A String", # Required. A status for this trigger.

2308

"description": "A String", # User provided description (max 256 chars)

2309

"lastRunTime": "A String", # Output only. The timestamp of the last time this trigger executed.

Bu Sun Kim

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

[diff] [blame]

2310

},

2311

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2312

"nextPageToken": "A String", # If the next page is available then the next page token to be used in following ListJobTriggers request.

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

2318

<pre>Retrieves the next page of results.

2319

2320

Args:

2321

previous_request: The request for the previous page. (required)

2322

previous_response: The response from the request for the previous page. (required)

2323

2324

Returns:

2325

A request object that you can call 'execute()' on to request the next

2326

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>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2332

<pre>Updates a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.

Bu Sun Kim

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

[diff] [blame]

2333

2334

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2335

name: string, Required. Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`. (required)

Bu Sun Kim

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

[diff] [blame]

2336

body: object, The request body.

2337

The object takes the form of:

2338

2339

{ # Request message for UpdateJobTrigger.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2340

"updateMask": "A String", # Mask to control which fields get updated.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2341

"jobTrigger": { # Contains a configuration to make dlp api calls on a repeating basis. See https://cloud.google.com/dlp/docs/concepts-job-triggers to learn more. # New JobTrigger value.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2342

"name": "A String", # Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2343

"errors": [ # Output only. A stream of errors encountered when the trigger was activated. Repeated errors may result in the JobTrigger automatically being paused. Will return the last 100 errors. Whenever the JobTrigger is modified this list will be cleared.

2344

{ # Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger.

2345

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

2346

"A String",

2347

],

2348

"details": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Detailed error codes and messages.

2349

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

2350

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

2351

{

2352

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

2353

},

2354

],

2355

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2356

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2357

},

2358

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2359

"inspectJob": { # Controls what and how to inspect for findings. # For inspect jobs, a snapshot of the configuration.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

2360

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

2361

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2362

"identifyingFields": [ # Table fields that may uniquely identify a row within the table. When `actions.saveFindings.outputConfig.table` is specified, the values of columns specified here are available in the output table under `location.content_locations.record_location.record_key.id_values`. Nested fields such as `person.birthdate.year` are allowed.

2363

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

2364

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

2365

},

2366

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2367

"rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2368

"tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2369

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2370

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

2371

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2372

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

2373

"sampleMethod": "A String",

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2374

"rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2375

"excludedFields": [ # References to fields excluded from scanning. This allows you to skip inspection of entire columns which you know have no findings.

2376

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

2377

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

},

],

},

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

2382

"bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.

2383

"fileTypes": [ # List of file type groups to include in the scan. If empty, all files are scanned and available data format processors are applied. In addition, the binary content of the selected files is always scanned as well. Images are scanned only as binary if the specified region does not support image inspection and no file_types were specified. Image inspection is restricted to 'global', 'us', 'asia', and 'europe'.

2384

"A String",

2385

],

2386

"filesLimitPercent": 42, # Limits the number of files to scan to this percentage of the input FileSet. Number of files scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0.

2387

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

2388

"regexFileSet": { # Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include. Included files are those that match at least one item in `include_regex` and do not match any items in `exclude_regex`. Note that a file that matches items from both lists will _not_ be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression. For example, given the input `{bucket_name: "mybucket", include_regex: ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * `gs://mybucket/directory1/myfile` will be included * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the full path doesn't match any items in `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path matches an item in `exclude_regex`) If `include_regex` is left empty, it will match all files by default (this is equivalent to setting `include_regex: [".*"]`). Some other common use cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all files in `mybucket` except for .pdf files * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will include all files directly under `gs://mybucket/directory/`, without matching across `/` # The regex-filtered set of files to scan. Exactly one of `url` or `regex_file_set` must be set.

2389

"excludeRegex": [ # A list of regular expressions matching file paths to exclude. All files in the bucket that match at least one of these regular expressions will be excluded from the scan. Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub.

2390

"A String",

2391

],

2392

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

2393

"includeRegex": [ # A list of regular expressions matching file paths to include. All files in the bucket that match at least one of these regular expressions will be included in the set of files, except for those that also match an item in `exclude_regex`. Leaving this field empty will match all files by default (this is equivalent to including `.*` in the list). Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found 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 `gs:///`. Trailing wildcard in the path is allowed. If the url ends in a trailing slash, the bucket or directory represented by the url will be scanned non-recursively (content in sub-directories will not be scanned). This means that `gs://mybucket/` is equivalent to `gs://mybucket/*`, and `gs://mybucket/directory/` is equivalent to `gs://mybucket/directory/*`. Exactly one of `url` or `regex_file_set` must be set.

2398

},

2399

"sampleMethod": "A String",

2400

"bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.

2401

},

2402

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

2403

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

2404

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

2405

},

2406

"partitionId": { # Datastore partition ID. A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty.

2407

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

2408

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

2409

},

2410

},

2411

"timespanConfig": { # Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Google Cloud Storage and BigQuery.

2412

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger.

2413

"startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied.

2414

"timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. For BigQuery: If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. For Datastore: If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`.

2415

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

2416

},

2417

"endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

2418

},

2419

"hybridOptions": { # Configuration to control jobs where the content being inspected is outside of Google Cloud Platform. # Hybrid inspection options. Early access feature is in a pre-release state and might change or have limited support. For more information, see https://cloud.google.com/products#product-launch-stages.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

2420

"labels": { # To organize findings, these labels will be added to each finding. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. No more than 10 labels can be associated with a given finding. Examples: * `"environment" : "production"` * `"pipeline" : "etl"`

2421

"a_key": "A String",

2422

},

2423

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

2424

"tableOptions": { # Instructions regarding the table content being inspected. # If the container is a table, additional information to make findings meaningful such as the columns that are primary keys.

2425

"identifyingFields": [ # The columns that are the primary keys for table objects included in ContentItem. A copy of this cell's value will stored alongside alongside each finding so that the finding can be traced to the specific row it came from. No more than 3 may be provided.

2426

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

2427

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

2428

},

2429

],

2430

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2431

"requiredFindingLabelKeys": [ # These are labels that each inspection request must include within their 'finding_labels' map. Request may contain others, but any missing one of these will be rejected. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. No more than 10 keys can be required.

2432

"A String",

2433

],

2434

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

2435

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2436

"inspectTemplateName": "A String", # If provided, will be used as the default for all values in InspectConfig. `inspect_config` will be merged into the values persisted as part of the template.

2437

"inspectConfig": { # Configuration description of the scanning process. When used with redactContent only info_types and min_likelihood are currently used. # How and what to scan for.

2438

"includeQuote": True or False, # When true, a contextual quote from the data that triggered a finding is included in the response; see Finding.quote.

2439

"customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more.

2440

{ # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question.

2441

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

2442

"createTime": "A String", # Timestamp indicating when the version of the `StoredInfoType` used for inspection was created. Output-only field, populated by the system.

2443

"name": "A String", # Resource name of the requested `StoredInfoType`, for example `organizations/433245324/storedInfoTypes/432452342` or `projects/project-id/storedInfoTypes/432452342`.

2444

},

2445

"likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified.

2446

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

2447

"pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.

2448

"groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included.

42,

],

},

"dictionary": { # Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://cloud.google.com/dlp/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API. # A list of phrases to detect as a CustomInfoType.

2453

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

2454

"path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt

2455

},

2456

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

2457

"words": [ # Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits. [required]

"A String",

],

},

},

"exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching.

2463

"surrogateType": { # Message for detecting output from deidentification transformations such as [`CryptoReplaceFfxFpeConfig`](https://cloud.google.com/dlp/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig). These types of transformations are those that perform pseudonymization, thereby producing a "surrogate" as output. This should be used in conjunction with a field on the transformation such as `surrogate_info_type`. This CustomInfoType does not support the use of `detection_rules`. # Message for detecting output from deidentification transformations that support reversing.

2464

},

2465

"infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type.

2466

"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

2467

},

2468

"detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type` CustomInfoType.

2469

{ # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType.

2470

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

2471

"proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "$\d{3}$ \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "$xxx$", where "xxx" is the area code in question.

2472

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

2473

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

2474

},

2475

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

2476

"pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.

2477

"groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included.

42,

],

},

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

2482

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

2483

"relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`.

},

},

},

],

},

],

"contentOptions": [ # List of options defining data content to scan. If empty, text, images, and other content will be included.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2491

"A String",

2492

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2493

"minLikelihood": "A String", # Only returns findings equal or above this threshold. The default is POSSIBLE. See https://cloud.google.com/dlp/docs/likelihood to learn more.

2494

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

2495

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

2496

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

2497

"infoType": { # Type of information detected by the API. # Type of information the findings limit applies to. Only one limit per info_type should be provided. If InfoTypeLimit does not have an info_type, the DLP API applies the limit against all info_types that are found but not specified in another InfoTypeLimit.

2498

"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

2499

},

2500

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2501

},

2502

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2503

"maxFindingsPerRequest": 42, # Max number of findings that will be returned per request/job. When set within `InspectContentRequest`, the maximum returned is 2000 regardless if this is set higher.

2504

"maxFindingsPerItem": 42, # Max number of findings that will be returned for each item scanned. When set within `InspectJobConfig`, the maximum returned is 2000 regardless if this is set higher. When set within `InspectContentRequest`, this field is ignored.

2505

},

2506

"infoTypes": [ # Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or listed at https://cloud.google.com/dlp/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. If you need precise control and predictability as to what detectors are run you should specify specific InfoTypes listed in the reference, otherwise a default list will be used, which may change over time.

2507

{ # Type of information detected by the API.

2508

"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

2509

},

2510

],

2511

"ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type.

2512

{ # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set.

2513

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

2514

{ # Type of information detected by the API.

2515

"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

2516

},

2517

],

2518

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

2519

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

2520

"exclusionRule": { # The rule that specifies conditions when findings of infoTypes specified in `InspectionRuleSet` are removed from results. # Exclusion rule.

2521

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

2522

"pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.

2523

"groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included.

42,

],

},

"dictionary": { # Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://cloud.google.com/dlp/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API. # Dictionary which defines the rule.

2528

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

2529

"path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt

2530

},

2531

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

2532

"words": [ # Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits. [required]

"A String",

],

},

},

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

2538

"infoTypes": [ # InfoType list in ExclusionRule rule drops a finding when it overlaps or contained within with a finding of an infoType from this list. For example, for `InspectionRuleSet.info_types` containing "PHONE_NUMBER"` and `exclusion_rule` containing `exclude_info_types.info_types` with "EMAIL_ADDRESS" the phone number findings are dropped if they overlap with EMAIL_ADDRESS finding. That leads to "555-222-2222@example.org" to generate only a single finding, namely email address.

2539

{ # Type of information detected by the API.

2540

"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

},

],

},

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

2545

},

2546

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

2547

"proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "$\d{3}$ \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "$xxx$", where "xxx" is the area code in question.

2548

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

2549

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

2550

},

2551

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

2552

"pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.

2553

"groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included.

42,

],

},

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

2558

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

2559

"relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`.

},

},

},

],

},

],

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

2567

},

2568

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

2569

{ # A task to execute on the completion of a job. See https://cloud.google.com/dlp/docs/concepts-actions to learn more.

2570

"publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count.

2571

},

2572

"saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.

2573

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

2574

"table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific timezone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.

2575

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

2576

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

2577

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call.

2578

},

2579

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.

2580

},

2581

},

2582

"publishSummaryToCscc": { # Publish the result summary of a DlpJob to the Cloud Security Command Center (CSCC Alpha). This action is only available for projects which are parts of an organization and whitelisted for the alpha Cloud Security Command Center. The action will publish count of finding instances and their info types. The summary of findings will be persisted in CSCC and are governed by CSCC service-specific policy, see https://cloud.google.com/terms/service-terms Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha).

2583

},

2584

"publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Cloud Data Catalog. Labels summarizing the results of the DlpJob will be applied to the entry for the resource scanned in Cloud Data Catalog. Any labels previously written by another DlpJob will be deleted. InfoType naming patterns are strictly enforced when using this feature. Note that the findings will be persisted in Cloud Data Catalog storage and are governed by Data Catalog service-specific policy, see https://cloud.google.com/terms/service-terms Only a single instance of this action can be specified and only allowed if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub.

2585

},

2586

"pubSub": { # Publish a message into given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/dlp/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a pubsub topic.

2587

"topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}.

2588

},

2589

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

},

},

],

},

"triggers": [ # A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object.

2595

{ # What event needs to occur for a new job to be started.

2596

"schedule": { # Schedule for triggeredJobs. # Create a job on a repeating basis based on the elapse of time.

2597

"recurrencePeriodDuration": "A String", # With this option a job is started a regular periodic basis. For example: every day (86400 seconds). A scheduled start time will be skipped if the previous execution has not ended when its scheduled time occurs. This value must be set to a time duration greater than or equal to 1 day and can be no longer than 60 days.

2598

},

2599

"manual": { # Job trigger option for hybrid jobs. Jobs must be manually created and finished. # For use with hybrid jobs. Jobs must be manually created and finished. Early access feature is in a pre-release state and might change or have limited support. For more information, see https://cloud.google.com/products#product-launch-stages.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

2600

},

2601

},

2602

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2603

"updateTime": "A String", # Output only. The last update timestamp of a triggeredJob.

2604

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

2605

"createTime": "A String", # Output only. The creation timestamp of a triggeredJob.

2606

"status": "A String", # Required. A status for this trigger.

2607

"description": "A String", # User provided description (max 256 chars)

2608

"lastRunTime": "A String", # Output only. The timestamp of the last time this trigger executed.

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:

2619

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2620

{ # Contains a configuration to make dlp api calls on a repeating basis. See https://cloud.google.com/dlp/docs/concepts-job-triggers to learn more.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2621

"name": "A String", # Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2622

"errors": [ # Output only. A stream of errors encountered when the trigger was activated. Repeated errors may result in the JobTrigger automatically being paused. Will return the last 100 errors. Whenever the JobTrigger is modified this list will be cleared.

2623

{ # Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger.

2624

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

2625

"A String",

2626

],

2627

"details": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Detailed error codes and messages.

2628

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

2629

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

2630

{

2631

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

2632

},

2633

],

2634

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2635

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2636

},

2637

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2638

"inspectJob": { # Controls what and how to inspect for findings. # For inspect jobs, a snapshot of the configuration.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

2639

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

2640

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2641

"identifyingFields": [ # Table fields that may uniquely identify a row within the table. When `actions.saveFindings.outputConfig.table` is specified, the values of columns specified here are available in the output table under `location.content_locations.record_location.record_key.id_values`. Nested fields such as `person.birthdate.year` are allowed.

2642

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

2643

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

2644

},

2645

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2646

"rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2647

"tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2648

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2649

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

2650

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2651

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

2652

"sampleMethod": "A String",

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2653

"rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2654

"excludedFields": [ # References to fields excluded from scanning. This allows you to skip inspection of entire columns which you know have no findings.

2655

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

2656

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

},

],

},

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

2661

"bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.

2662

"fileTypes": [ # List of file type groups to include in the scan. If empty, all files are scanned and available data format processors are applied. In addition, the binary content of the selected files is always scanned as well. Images are scanned only as binary if the specified region does not support image inspection and no file_types were specified. Image inspection is restricted to 'global', 'us', 'asia', and 'europe'.

2663

"A String",

2664

],

2665

"filesLimitPercent": 42, # Limits the number of files to scan to this percentage of the input FileSet. Number of files scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0.

2666

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

2667

"regexFileSet": { # Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include. Included files are those that match at least one item in `include_regex` and do not match any items in `exclude_regex`. Note that a file that matches items from both lists will _not_ be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression. For example, given the input `{bucket_name: "mybucket", include_regex: ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * `gs://mybucket/directory1/myfile` will be included * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the full path doesn't match any items in `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path matches an item in `exclude_regex`) If `include_regex` is left empty, it will match all files by default (this is equivalent to setting `include_regex: [".*"]`). Some other common use cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all files in `mybucket` except for .pdf files * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will include all files directly under `gs://mybucket/directory/`, without matching across `/` # The regex-filtered set of files to scan. Exactly one of `url` or `regex_file_set` must be set.

2668

"excludeRegex": [ # A list of regular expressions matching file paths to exclude. All files in the bucket that match at least one of these regular expressions will be excluded from the scan. Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub.

2669

"A String",

2670

],

2671

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

2672

"includeRegex": [ # A list of regular expressions matching file paths to include. All files in the bucket that match at least one of these regular expressions will be included in the set of files, except for those that also match an item in `exclude_regex`. Leaving this field empty will match all files by default (this is equivalent to including `.*` in the list). Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found 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 `gs:///`. Trailing wildcard in the path is allowed. If the url ends in a trailing slash, the bucket or directory represented by the url will be scanned non-recursively (content in sub-directories will not be scanned). This means that `gs://mybucket/` is equivalent to `gs://mybucket/*`, and `gs://mybucket/directory/` is equivalent to `gs://mybucket/directory/*`. Exactly one of `url` or `regex_file_set` must be set.

2677

},

2678

"sampleMethod": "A String",

2679

"bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.

2680

},

2681

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

2682

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

2683

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

2684

},

2685

"partitionId": { # Datastore partition ID. A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty.

2686

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

2687

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

2688

},

2689

},

2690

"timespanConfig": { # Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Google Cloud Storage and BigQuery.

2691

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger.

2692

"startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied.

2693

"timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. For BigQuery: If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. For Datastore: If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`.

2694

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

2695

},

2696

"endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

2697

},

2698

"hybridOptions": { # Configuration to control jobs where the content being inspected is outside of Google Cloud Platform. # Hybrid inspection options. Early access feature is in a pre-release state and might change or have limited support. For more information, see https://cloud.google.com/products#product-launch-stages.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

2699

"labels": { # To organize findings, these labels will be added to each finding. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. No more than 10 labels can be associated with a given finding. Examples: * `"environment" : "production"` * `"pipeline" : "etl"`

2700

"a_key": "A String",

2701

},

2702

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

2703

"tableOptions": { # Instructions regarding the table content being inspected. # If the container is a table, additional information to make findings meaningful such as the columns that are primary keys.

2704

"identifyingFields": [ # The columns that are the primary keys for table objects included in ContentItem. A copy of this cell's value will stored alongside alongside each finding so that the finding can be traced to the specific row it came from. No more than 3 may be provided.

2705

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

2706

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

2707

},

2708

],

2709

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2710

"requiredFindingLabelKeys": [ # These are labels that each inspection request must include within their 'finding_labels' map. Request may contain others, but any missing one of these will be rejected. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. No more than 10 keys can be required.

2711

"A String",

2712

],

2713

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

2714

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2715

"inspectTemplateName": "A String", # If provided, will be used as the default for all values in InspectConfig. `inspect_config` will be merged into the values persisted as part of the template.

2716

"inspectConfig": { # Configuration description of the scanning process. When used with redactContent only info_types and min_likelihood are currently used. # How and what to scan for.

2717

"includeQuote": True or False, # When true, a contextual quote from the data that triggered a finding is included in the response; see Finding.quote.

2718

"customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more.

2719

{ # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question.

2720

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

2721

"createTime": "A String", # Timestamp indicating when the version of the `StoredInfoType` used for inspection was created. Output-only field, populated by the system.

2722

"name": "A String", # Resource name of the requested `StoredInfoType`, for example `organizations/433245324/storedInfoTypes/432452342` or `projects/project-id/storedInfoTypes/432452342`.

2723

},

2724

"likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified.

2725

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

2726

"pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.

2727

"groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included.

42,

],

},

"dictionary": { # Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://cloud.google.com/dlp/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API. # A list of phrases to detect as a CustomInfoType.

2732

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

2733

"path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt

2734

},

2735

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

2736

"words": [ # Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits. [required]

"A String",

],

},

},

"exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching.

2742

"surrogateType": { # Message for detecting output from deidentification transformations such as [`CryptoReplaceFfxFpeConfig`](https://cloud.google.com/dlp/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig). These types of transformations are those that perform pseudonymization, thereby producing a "surrogate" as output. This should be used in conjunction with a field on the transformation such as `surrogate_info_type`. This CustomInfoType does not support the use of `detection_rules`. # Message for detecting output from deidentification transformations that support reversing.

2743

},

2744

"infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type.

2745

"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

2746

},

2747

"detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type` CustomInfoType.

2748

{ # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType.

2749

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

2750

"proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "$\d{3}$ \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "$xxx$", where "xxx" is the area code in question.

2751

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

2752

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

2753

},

2754

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

2755

"pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.

2756

"groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included.

42,

],

},

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

2761

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

2762

"relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`.

},

},

},

],

},

],

"contentOptions": [ # List of options defining data content to scan. If empty, text, images, and other content will be included.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2770

"A String",

2771

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2772

"minLikelihood": "A String", # Only returns findings equal or above this threshold. The default is POSSIBLE. See https://cloud.google.com/dlp/docs/likelihood to learn more.

2773

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

2774

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

2775

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

2776

"infoType": { # Type of information detected by the API. # Type of information the findings limit applies to. Only one limit per info_type should be provided. If InfoTypeLimit does not have an info_type, the DLP API applies the limit against all info_types that are found but not specified in another InfoTypeLimit.

2777

"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

2778

},

2779

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2780

},

2781

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2782

"maxFindingsPerRequest": 42, # Max number of findings that will be returned per request/job. When set within `InspectContentRequest`, the maximum returned is 2000 regardless if this is set higher.

2783

"maxFindingsPerItem": 42, # Max number of findings that will be returned for each item scanned. When set within `InspectJobConfig`, the maximum returned is 2000 regardless if this is set higher. When set within `InspectContentRequest`, this field is ignored.

2784

},

2785

"infoTypes": [ # Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or listed at https://cloud.google.com/dlp/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. If you need precise control and predictability as to what detectors are run you should specify specific InfoTypes listed in the reference, otherwise a default list will be used, which may change over time.

2786

{ # Type of information detected by the API.

2787

"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

2788

},

2789

],

2790

"ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type.

2791

{ # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set.

2792

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

2793

{ # Type of information detected by the API.

2794

"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

2795

},

2796

],

2797

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

2798

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

2799

"exclusionRule": { # The rule that specifies conditions when findings of infoTypes specified in `InspectionRuleSet` are removed from results. # Exclusion rule.

2800

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

2801

"pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.

2802

"groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included.

42,

],

},

"dictionary": { # Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://cloud.google.com/dlp/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API. # Dictionary which defines the rule.

2807

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

2808

"path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt

2809

},

2810

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

2811

"words": [ # Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits. [required]

"A String",

],

},

},

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

2817

"infoTypes": [ # InfoType list in ExclusionRule rule drops a finding when it overlaps or contained within with a finding of an infoType from this list. For example, for `InspectionRuleSet.info_types` containing "PHONE_NUMBER"` and `exclusion_rule` containing `exclude_info_types.info_types` with "EMAIL_ADDRESS" the phone number findings are dropped if they overlap with EMAIL_ADDRESS finding. That leads to "555-222-2222@example.org" to generate only a single finding, namely email address.

2818

{ # Type of information detected by the API.

2819

"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.

},

],

},

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

2824

},

2825

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

2826

"proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "$\d{3}$ \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "$xxx$", where "xxx" is the area code in question.

2827

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

2828

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

2829

},

2830

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

2831

"pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.

2832

"groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included.

42,

],

},

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

2837

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

2838

"relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`.

},

},

},

],

},

],

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

2846

},

2847

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

2848

{ # A task to execute on the completion of a job. See https://cloud.google.com/dlp/docs/concepts-actions to learn more.

2849

"publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count.

2850

},

2851

"saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.

2852

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

2853

"table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific timezone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.

2854

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

2855

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

2856

"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call.

2857

},

2858

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.

2859

},

2860

},

2861

"publishSummaryToCscc": { # Publish the result summary of a DlpJob to the Cloud Security Command Center (CSCC Alpha). This action is only available for projects which are parts of an organization and whitelisted for the alpha Cloud Security Command Center. The action will publish count of finding instances and their info types. The summary of findings will be persisted in CSCC and are governed by CSCC service-specific policy, see https://cloud.google.com/terms/service-terms Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha).

2862

},

2863

"publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Cloud Data Catalog. Labels summarizing the results of the DlpJob will be applied to the entry for the resource scanned in Cloud Data Catalog. Any labels previously written by another DlpJob will be deleted. InfoType naming patterns are strictly enforced when using this feature. Note that the findings will be persisted in Cloud Data Catalog storage and are governed by Data Catalog service-specific policy, see https://cloud.google.com/terms/service-terms Only a single instance of this action can be specified and only allowed if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub.

2864

},

2865

"pubSub": { # Publish a message into given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/dlp/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a pubsub topic.

2866

"topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}.

2867

},

2868

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

},

},

],

},

"triggers": [ # A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object.

2874

{ # What event needs to occur for a new job to be started.

2875

"schedule": { # Schedule for triggeredJobs. # Create a job on a repeating basis based on the elapse of time.

2876

"recurrencePeriodDuration": "A String", # With this option a job is started a regular periodic basis. For example: every day (86400 seconds). A scheduled start time will be skipped if the previous execution has not ended when its scheduled time occurs. This value must be set to a time duration greater than or equal to 1 day and can be no longer than 60 days.

2877

},

2878

"manual": { # Job trigger option for hybrid jobs. Jobs must be manually created and finished. # For use with hybrid jobs. Jobs must be manually created and finished. Early access feature is in a pre-release state and might change or have limited support. For more information, see https://cloud.google.com/products#product-launch-stages.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

2879

},

2880

},

2881

],

Yoshi Automation Bot