docs: expand parent field format, and BigQuery sampling options. Also describing which transformations are allowed for ReidentifyContent API calls, and the custom alphabet allowed for format-preserving encryption (FPE).

PiperOrigin-RevId: 329758805
This commit is contained in:
Google APIs 2020-09-02 11:59:29 -07:00 committed by Copybara-Service
parent 2db5725bf8
commit 1ee015d872
2 changed files with 247 additions and 52 deletions

View File

@ -1154,9 +1154,21 @@ message RedactImageRequest {
Color redaction_color = 3;
}
// The parent resource name.
// - Format:projects/[PROJECT-ID]
// - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]
// Parent resource name.
//
// The format of this value varies depending on whether you have [specified a
// processing location](/dlp/docs/specifying-location):
//
// + Projects scope, location specified:<br/>
// `projects/`<var>PROJECT_ID</var>`/locations/`<var>LOCATION_ID</var>
// + Projects scope, no location specified (defaults to global):<br/>
// `projects/`<var>PROJECT_ID</var>
//
// 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
string parent = 1 [(google.api.resource_reference) = {
child_type: "dlp.googleapis.com/DlpContent"
}];
@ -1207,8 +1219,20 @@ message RedactImageResponse {
// Request to de-identify a list of items.
message DeidentifyContentRequest {
// Parent resource name.
// - Format:projects/[PROJECT-ID]
// - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]
//
// The format of this value varies depending on whether you have [specified a
// processing location](/dlp/docs/specifying-location):
//
// + Projects scope, location specified:<br/>
// `projects/`<var>PROJECT_ID</var>`/locations/`<var>LOCATION_ID</var>
// + Projects scope, no location specified (defaults to global):<br/>
// `projects/`<var>PROJECT_ID</var>
//
// 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
string parent = 1 [(google.api.resource_reference) = {
child_type: "dlp.googleapis.com/DlpContent"
}];
@ -1255,9 +1279,21 @@ message DeidentifyContentResponse {
// Request to re-identify an item.
message ReidentifyContentRequest {
// Required. The parent resource name.
// - Format:projects/[PROJECT-ID]
// - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]
// Required. Parent resource name.
//
// The format of this value varies depending on whether you have [specified a
// processing location](/dlp/docs/specifying-location):
//
// + Projects scope, location specified:<br/>
// `projects/`<var>PROJECT_ID</var>`/locations/`<var>LOCATION_ID</var>
// + Projects scope, no location specified (defaults to global):<br/>
// `projects/`<var>PROJECT_ID</var>
//
// 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
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@ -1292,10 +1328,11 @@ message ReidentifyContentRequest {
// Template to use. References an instance of `DeidentifyTemplate`.
// Any configuration directly specified in `reidentify_config` or
// `inspect_config` will override those set in the template. Singular fields
// that are set in this request will replace their corresponding fields in the
// template. Repeated fields are appended. Singular sub-messages and groups
// are recursively merged.
// `inspect_config` will override those set in the template. The
// `DeidentifyTemplate` used must include only reversible transformations.
// Singular fields that are set in this request will replace their
// corresponding fields in the template. Repeated fields are appended.
// Singular sub-messages and groups are recursively merged.
string reidentify_template_name = 6;
// Deprecated. This field has no effect.
@ -1314,8 +1351,20 @@ message ReidentifyContentResponse {
// Request to search for potentially sensitive info in a ContentItem.
message InspectContentRequest {
// Parent resource name.
// - Format:projects/[PROJECT-ID]
// - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]
//
// The format of this value varies depending on whether you have [specified a
// processing location](/dlp/docs/specifying-location):
//
// + Projects scope, location specified:<br/>
// `projects/`<var>PROJECT_ID</var>`/locations/`<var>LOCATION_ID</var>
// + Projects scope, no location specified (defaults to global):<br/>
// `projects/`<var>PROJECT_ID</var>
//
// 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
string parent = 1 [(google.api.resource_reference) = {
child_type: "dlp.googleapis.com/DlpContent"
}];
@ -1484,7 +1533,10 @@ message InfoTypeDescription {
// Request for the list of infoTypes.
message ListInfoTypesRequest {
// The parent resource name.
// - Format:locations/[LOCATION-ID]
//
// The format of this value is as follows:
//
// locations/<var>LOCATION_ID</var>
string parent = 4;
// BCP-47 language code for localized infoType friendly
@ -2490,6 +2542,9 @@ message CryptoReplaceFfxFpeConfig {
// Number of characters must be in the range [2, 95].
// This must be encoded as ASCII.
// The order of characters does not matter.
// The full list of allowed characters is:
// <code>0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz
// ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/</code>
string custom_alphabet = 5;
// The native way to select the alphabet. Must be in the range [2, 95].
@ -3075,10 +3130,25 @@ message Action {
// Request message for CreateInspectTemplate.
message CreateInspectTemplateRequest {
// Required. Parent resource name.
// - Format:projects/[PROJECT-ID]
// - Format:organizations/[ORGANIZATION-ID]
// - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]
// - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]
//
// The format of this value varies depending on the scope of the request
// (project or organization) and whether you have [specified a processing
// location](/dlp/docs/specifying-location):
//
// + Projects scope, location specified:<br/>
// `projects/`<var>PROJECT_ID</var>`/locations/`<var>LOCATION_ID</var>
// + Projects scope, no location specified (defaults to global):<br/>
// `projects/`<var>PROJECT_ID</var>
// + Organizations scope, location specified:<br/>
// `organizations/`<var>ORG_ID</var>`/locations/`<var>LOCATION_ID</var>
// + Organizations scope, no location specified (defaults to global):<br/>
// `organizations/`<var>ORG_ID</var>
//
// 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
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@ -3134,10 +3204,25 @@ message GetInspectTemplateRequest {
// Request message for ListInspectTemplates.
message ListInspectTemplatesRequest {
// Required. Parent resource name.
// - Format:projects/[PROJECT-ID]
// - Format:organizations/[ORGANIZATION-ID]
// - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]
// - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]
//
// The format of this value varies depending on the scope of the request
// (project or organization) and whether you have [specified a processing
// location](/dlp/docs/specifying-location):
//
// + Projects scope, location specified:<br/>
// `projects/`<var>PROJECT_ID</var>`/locations/`<var>LOCATION_ID</var>
// + Projects scope, no location specified (defaults to global):<br/>
// `projects/`<var>PROJECT_ID</var>
// + Organizations scope, location specified:<br/>
// `organizations/`<var>ORG_ID</var>`/locations/`<var>LOCATION_ID</var>
// + Organizations scope, no location specified (defaults to global):<br/>
// `organizations/`<var>ORG_ID</var>
//
// 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
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@ -3198,8 +3283,20 @@ message DeleteInspectTemplateRequest {
// Request message for CreateJobTrigger.
message CreateJobTriggerRequest {
// Required. Parent resource name.
// - Format:projects/[PROJECT-ID]
// - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]
//
// The format of this value varies depending on whether you have [specified a
// processing location](/dlp/docs/specifying-location):
//
// + Projects scope, location specified:<br/>
// `projects/`<var>PROJECT_ID</var>`/locations/`<var>LOCATION_ID</var>
// + Projects scope, no location specified (defaults to global):<br/>
// `projects/`<var>PROJECT_ID</var>
//
// 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
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@ -3267,8 +3364,20 @@ message GetJobTriggerRequest {
// Storage.
message CreateDlpJobRequest {
// Required. Parent resource name.
// - Format:projects/[PROJECT-ID]
// - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]
//
// The format of this value varies depending on whether you have [specified a
// processing location](/dlp/docs/specifying-location):
//
// + Projects scope, location specified:<br/>
// `projects/`<var>PROJECT_ID</var>`/locations/`<var>LOCATION_ID</var>
// + Projects scope, no location specified (defaults to global):<br/>
// `projects/`<var>PROJECT_ID</var>
//
// 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
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@ -3298,8 +3407,20 @@ message CreateDlpJobRequest {
// Request message for ListJobTriggers.
message ListJobTriggersRequest {
// Required. Parent resource name.
// - Format:projects/[PROJECT-ID]
// - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]
//
// The format of this value varies depending on whether you have [specified a
// processing location](/dlp/docs/specifying-location):
//
// + Projects scope, location specified:<br/>
// `projects/`<var>PROJECT_ID</var>`/locations/`<var>LOCATION_ID</var>
// + Projects scope, no location specified (defaults to global):<br/>
// `projects/`<var>PROJECT_ID</var>
//
// 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
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@ -3485,8 +3606,20 @@ message GetDlpJobRequest {
// The request message for listing DLP jobs.
message ListDlpJobsRequest {
// Required. Parent resource name.
// - Format:projects/[PROJECT-ID]
// - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]
//
// The format of this value varies depending on whether you have [specified a
// processing location](/dlp/docs/specifying-location):
//
// + Projects scope, location specified:<br/>
// `projects/`<var>PROJECT_ID</var>`/locations/`<var>LOCATION_ID</var>
// + Projects scope, no location specified (defaults to global):<br/>
// `projects/`<var>PROJECT_ID</var>
//
// 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
string parent = 4 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@ -3597,10 +3730,25 @@ message DeleteDlpJobRequest {
// Request message for CreateDeidentifyTemplate.
message CreateDeidentifyTemplateRequest {
// Required. Parent resource name.
// - Format:projects/[PROJECT-ID]
// - Format:organizations/[ORGANIZATION-ID]
// - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]
// - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]
//
// The format of this value varies depending on the scope of the request
// (project or organization) and whether you have [specified a processing
// location](/dlp/docs/specifying-location):
//
// + Projects scope, location specified:<br/>
// `projects/`<var>PROJECT_ID</var>`/locations/`<var>LOCATION_ID</var>
// + Projects scope, no location specified (defaults to global):<br/>
// `projects/`<var>PROJECT_ID</var>
// + Organizations scope, location specified:<br/>
// `organizations/`<var>ORG_ID</var>`/locations/`<var>LOCATION_ID</var>
// + Organizations scope, no location specified (defaults to global):<br/>
// `organizations/`<var>ORG_ID</var>
//
// 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
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@ -3656,10 +3804,25 @@ message GetDeidentifyTemplateRequest {
// Request message for ListDeidentifyTemplates.
message ListDeidentifyTemplatesRequest {
// Required. Parent resource name.
// - Format:projects/[PROJECT-ID]
// - Format:organizations/[ORGANIZATION-ID]
// - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]
// - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]
//
// The format of this value varies depending on the scope of the request
// (project or organization) and whether you have [specified a processing
// location](/dlp/docs/specifying-location):
//
// + Projects scope, location specified:<br/>
// `projects/`<var>PROJECT_ID</var>`/locations/`<var>LOCATION_ID</var>
// + Projects scope, no location specified (defaults to global):<br/>
// `projects/`<var>PROJECT_ID</var>
// + Organizations scope, location specified:<br/>
// `organizations/`<var>ORG_ID</var>`/locations/`<var>LOCATION_ID</var>
// + Organizations scope, no location specified (defaults to global):<br/>
// `organizations/`<var>ORG_ID</var>
//
// 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
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@ -3836,10 +3999,25 @@ message StoredInfoType {
// Request message for CreateStoredInfoType.
message CreateStoredInfoTypeRequest {
// Required. Parent resource name.
// - Format:projects/[PROJECT-ID]
// - Format:organizations/[ORGANIZATION-ID]
// - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]
// - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]
//
// The format of this value varies depending on the scope of the request
// (project or organization) and whether you have [specified a processing
// location](/dlp/docs/specifying-location):
//
// + Projects scope, location specified:<br/>
// `projects/`<var>PROJECT_ID</var>`/locations/`<var>LOCATION_ID</var>
// + Projects scope, no location specified (defaults to global):<br/>
// `projects/`<var>PROJECT_ID</var>
// + Organizations scope, location specified:<br/>
// `organizations/`<var>ORG_ID</var>`/locations/`<var>LOCATION_ID</var>
// + Organizations scope, no location specified (defaults to global):<br/>
// `organizations/`<var>ORG_ID</var>
//
// 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
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@ -3897,10 +4075,25 @@ message GetStoredInfoTypeRequest {
// Request message for ListStoredInfoTypes.
message ListStoredInfoTypesRequest {
// Required. Parent resource name.
// - Format:projects/[PROJECT-ID]
// - Format:organizations/[ORGANIZATION-ID]
// - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]
// - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]
//
// The format of this value varies depending on the scope of the request
// (project or organization) and whether you have [specified a processing
// location](/dlp/docs/specifying-location):
//
// + Projects scope, location specified:<br/>
// `projects/`<var>PROJECT_ID</var>`/locations/`<var>LOCATION_ID</var>
// + Projects scope, no location specified (defaults to global):<br/>
// `projects/`<var>PROJECT_ID</var>
// + Organizations scope, location specified:<br/>
// `organizations/`<var>ORG_ID</var>`/locations/`<var>LOCATION_ID</var>
// + Organizations scope, no location specified (defaults to global):<br/>
// `organizations/`<var>ORG_ID</var>
//
// 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
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {

View File

@ -33,8 +33,8 @@ message InfoType {
// 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. InfoType names should conform to the pattern
// `[a-zA-Z0-9_]{1,64}`.
// 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}`.
string name = 1;
}
@ -425,14 +425,16 @@ message CloudStoragePath {
message BigQueryOptions {
// How to sample rows if not all rows are scanned. Meaningful only when used
// in conjunction with either rows_limit or rows_limit_percent. If not
// specified, scanning would start from the top.
// specified, rows are scanned in the order BigQuery reads them.
enum SampleMethod {
SAMPLE_METHOD_UNSPECIFIED = 0;
// Scan from the top (default).
// Scan groups of rows in the order BigQuery provides (default). Multiple
// groups of rows may be scanned in parallel, so results may not appear in
// the same order the rows are read.
TOP = 1;
// Randomly pick the row to start scanning. The scanned rows are contiguous.
// Randomly pick groups of rows to scan.
RANDOM_START = 2;
}