From 2463bf715c1bb106f819673c4c6af997c6188ca4 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Bot Date: Mon, 14 Sep 2020 22:59:46 -0700 Subject: [PATCH] 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) (#533) * 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 Source-Author: Google APIs Source-Date: Wed Sep 2 11:59:29 2020 -0700 Source-Repo: googleapis/googleapis Source-Sha: 1ee015d872d003637eb47b890930bf3d0d410c61 Source-Link: https://github.com/googleapis/googleapis/commit/1ee015d872d003637eb47b890930bf3d0d410c61 * build: fix failing docs test Co-authored-by: sofisl <55454395+sofisl@users.noreply.github.com> Co-authored-by: Sofia Leon --- .../protos/google/privacy/dlp/v2/dlp.proto | 287 +++++++++-- .../google/privacy/dlp/v2/storage.proto | 12 +- .../src/v2/dlp_service_client.ts | 486 +++++++++++++++--- packages/google-privacy-dlp/synth.metadata | 6 +- 4 files changed, 657 insertions(+), 134 deletions(-) diff --git a/packages/google-privacy-dlp/protos/google/privacy/dlp/v2/dlp.proto b/packages/google-privacy-dlp/protos/google/privacy/dlp/v2/dlp.proto index 781ac1c4534..10202246a0a 100644 --- a/packages/google-privacy-dlp/protos/google/privacy/dlp/v2/dlp.proto +++ b/packages/google-privacy-dlp/protos/google/privacy/dlp/v2/dlp.proto @@ -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](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 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](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 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](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 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](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 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/LOCATION_ID 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: + // 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz + // ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ 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](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 + // + Organizations scope, location specified:
+ // `organizations/`ORG_ID`/locations/`LOCATION_ID + // + Organizations scope, no location specified (defaults to global):
+ // `organizations/`ORG_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 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](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 + // + Organizations scope, location specified:
+ // `organizations/`ORG_ID`/locations/`LOCATION_ID + // + Organizations scope, no location specified (defaults to global):
+ // `organizations/`ORG_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 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](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 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](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 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](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 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](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 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](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 + // + Organizations scope, location specified:
+ // `organizations/`ORG_ID`/locations/`LOCATION_ID + // + Organizations scope, no location specified (defaults to global):
+ // `organizations/`ORG_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 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](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 + // + Organizations scope, location specified:
+ // `organizations/`ORG_ID`/locations/`LOCATION_ID + // + Organizations scope, no location specified (defaults to global):
+ // `organizations/`ORG_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 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](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 + // + Organizations scope, location specified:
+ // `organizations/`ORG_ID`/locations/`LOCATION_ID + // + Organizations scope, no location specified (defaults to global):
+ // `organizations/`ORG_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 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](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 + // + Organizations scope, location specified:
+ // `organizations/`ORG_ID`/locations/`LOCATION_ID + // + Organizations scope, no location specified (defaults to global):
+ // `organizations/`ORG_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 string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { diff --git a/packages/google-privacy-dlp/protos/google/privacy/dlp/v2/storage.proto b/packages/google-privacy-dlp/protos/google/privacy/dlp/v2/storage.proto index b25cf4fe77d..9098ab32d10 100644 --- a/packages/google-privacy-dlp/protos/google/privacy/dlp/v2/storage.proto +++ b/packages/google-privacy-dlp/protos/google/privacy/dlp/v2/storage.proto @@ -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; } diff --git a/packages/google-privacy-dlp/src/v2/dlp_service_client.ts b/packages/google-privacy-dlp/src/v2/dlp_service_client.ts index 503a187447a..281d1384adf 100644 --- a/packages/google-privacy-dlp/src/v2/dlp_service_client.ts +++ b/packages/google-privacy-dlp/src/v2/dlp_service_client.ts @@ -461,8 +461,20 @@ export class DlpServiceClient { * The request object that will be sent. * @param {string} request.parent * 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](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 * @param {google.privacy.dlp.v2.InspectConfig} request.inspectConfig * Configuration for the inspector. What specified here will override * the template referenced by the inspect_template_name argument. @@ -564,9 +576,21 @@ export class DlpServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * 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](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 * @param {string} request.locationId * Deprecated. This field has no effect. * @param {google.privacy.dlp.v2.InspectConfig} request.inspectConfig @@ -665,8 +689,20 @@ export class DlpServiceClient { * The request object that will be sent. * @param {string} request.parent * 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](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 * @param {google.privacy.dlp.v2.DeidentifyConfig} request.deidentifyConfig * Configuration for the de-identification of the content item. * Items specified here will override the template referenced by the @@ -775,9 +811,21 @@ export class DlpServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * 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](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 * @param {google.privacy.dlp.v2.DeidentifyConfig} request.reidentifyConfig * Configuration for the re-identification of the content item. * This field shares the same proto message type that is used for @@ -802,10 +850,11 @@ export class DlpServiceClient { * @param {string} request.reidentifyTemplateName * 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. * @param {string} request.locationId * Deprecated. This field has no effect. * @param {object} [options] @@ -892,7 +941,10 @@ export class DlpServiceClient { * The request object that will be sent. * @param {string} request.parent * The parent resource name. - * - Format:locations/[LOCATION-ID] + * + * The format of this value is as follows: + * + * locations/LOCATION_ID * @param {string} request.languageCode * BCP-47 language code for localized infoType friendly * names. If omitted, or if localized strings are not available, @@ -988,10 +1040,25 @@ export class DlpServiceClient { * The request object that will be sent. * @param {string} request.parent * 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](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 + * + Organizations scope, location specified:
+ * `organizations/`ORG_ID`/locations/`LOCATION_ID + * + Organizations scope, no location specified (defaults to global):
+ * `organizations/`ORG_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 * @param {google.privacy.dlp.v2.InspectTemplate} request.inspectTemplate * Required. The InspectTemplate to create. * @param {string} request.templateId @@ -1369,10 +1436,25 @@ export class DlpServiceClient { * The request object that will be sent. * @param {string} request.parent * 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](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 + * + Organizations scope, location specified:
+ * `organizations/`ORG_ID`/locations/`LOCATION_ID + * + Organizations scope, no location specified (defaults to global):
+ * `organizations/`ORG_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 * @param {google.privacy.dlp.v2.DeidentifyTemplate} request.deidentifyTemplate * Required. The DeidentifyTemplate to create. * @param {string} request.templateId @@ -1760,8 +1842,20 @@ export class DlpServiceClient { * The request object that will be sent. * @param {string} request.parent * 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](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 * @param {google.privacy.dlp.v2.JobTrigger} request.jobTrigger * Required. The JobTrigger to create. * @param {string} request.triggerId @@ -2303,8 +2397,20 @@ export class DlpServiceClient { * The request object that will be sent. * @param {string} request.parent * 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](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 * @param {google.privacy.dlp.v2.InspectJobConfig} request.inspectJob * Set to control what and how to inspect. * @param {google.privacy.dlp.v2.RiskAnalysisJobConfig} request.riskJob @@ -2652,10 +2758,25 @@ export class DlpServiceClient { * The request object that will be sent. * @param {string} request.parent * 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](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 + * + Organizations scope, location specified:
+ * `organizations/`ORG_ID`/locations/`LOCATION_ID + * + Organizations scope, no location specified (defaults to global):
+ * `organizations/`ORG_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 * @param {google.privacy.dlp.v2.StoredInfoTypeConfig} request.config * Required. Configuration of the storedInfoType to create. * @param {string} request.storedInfoTypeId @@ -3212,10 +3333,25 @@ export class DlpServiceClient { * The request object that will be sent. * @param {string} request.parent * 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](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 + * + Organizations scope, location specified:
+ * `organizations/`ORG_ID`/locations/`LOCATION_ID + * + Organizations scope, no location specified (defaults to global):
+ * `organizations/`ORG_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 * @param {string} request.pageToken * Page token to continue retrieval. Comes from previous call * to `ListInspectTemplates`. @@ -3318,10 +3454,25 @@ export class DlpServiceClient { * The request object that will be sent. * @param {string} request.parent * 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](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 + * + Organizations scope, location specified:
+ * `organizations/`ORG_ID`/locations/`LOCATION_ID + * + Organizations scope, no location specified (defaults to global):
+ * `organizations/`ORG_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 * @param {string} request.pageToken * Page token to continue retrieval. Comes from previous call * to `ListInspectTemplates`. @@ -3380,10 +3531,25 @@ export class DlpServiceClient { * The request object that will be sent. * @param {string} request.parent * 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](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 + * + Organizations scope, location specified:
+ * `organizations/`ORG_ID`/locations/`LOCATION_ID + * + Organizations scope, no location specified (defaults to global):
+ * `organizations/`ORG_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 * @param {string} request.pageToken * Page token to continue retrieval. Comes from previous call * to `ListInspectTemplates`. @@ -3473,10 +3639,25 @@ export class DlpServiceClient { * The request object that will be sent. * @param {string} request.parent * 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](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 + * + Organizations scope, location specified:
+ * `organizations/`ORG_ID`/locations/`LOCATION_ID + * + Organizations scope, no location specified (defaults to global):
+ * `organizations/`ORG_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 * @param {string} request.pageToken * Page token to continue retrieval. Comes from previous call * to `ListDeidentifyTemplates`. @@ -3583,10 +3764,25 @@ export class DlpServiceClient { * The request object that will be sent. * @param {string} request.parent * 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](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 + * + Organizations scope, location specified:
+ * `organizations/`ORG_ID`/locations/`LOCATION_ID + * + Organizations scope, no location specified (defaults to global):
+ * `organizations/`ORG_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 * @param {string} request.pageToken * Page token to continue retrieval. Comes from previous call * to `ListDeidentifyTemplates`. @@ -3645,10 +3841,25 @@ export class DlpServiceClient { * The request object that will be sent. * @param {string} request.parent * 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](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 + * + Organizations scope, location specified:
+ * `organizations/`ORG_ID`/locations/`LOCATION_ID + * + Organizations scope, no location specified (defaults to global):
+ * `organizations/`ORG_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 * @param {string} request.pageToken * Page token to continue retrieval. Comes from previous call * to `ListDeidentifyTemplates`. @@ -3733,8 +3944,20 @@ export class DlpServiceClient { * The request object that will be sent. * @param {string} request.parent * 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](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 * @param {string} request.pageToken * Page token to continue retrieval. Comes from previous call * to ListJobTriggers. `order_by` field must not @@ -3862,8 +4085,20 @@ export class DlpServiceClient { * The request object that will be sent. * @param {string} request.parent * 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](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 * @param {string} request.pageToken * Page token to continue retrieval. Comes from previous call * to ListJobTriggers. `order_by` field must not @@ -3949,8 +4184,20 @@ export class DlpServiceClient { * The request object that will be sent. * @param {string} request.parent * 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](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 * @param {string} request.pageToken * Page token to continue retrieval. Comes from previous call * to ListJobTriggers. `order_by` field must not @@ -4063,8 +4310,20 @@ export class DlpServiceClient { * The request object that will be sent. * @param {string} request.parent * 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](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 * @param {string} request.filter * Allows filtering. * @@ -4192,8 +4451,20 @@ export class DlpServiceClient { * The request object that will be sent. * @param {string} request.parent * 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](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 * @param {string} request.filter * Allows filtering. * @@ -4281,8 +4552,20 @@ export class DlpServiceClient { * The request object that will be sent. * @param {string} request.parent * 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](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 * @param {string} request.filter * Allows filtering. * @@ -4401,10 +4684,25 @@ export class DlpServiceClient { * The request object that will be sent. * @param {string} request.parent * 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](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 + * + Organizations scope, location specified:
+ * `organizations/`ORG_ID`/locations/`LOCATION_ID + * + Organizations scope, no location specified (defaults to global):
+ * `organizations/`ORG_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 * @param {string} request.pageToken * Page token to continue retrieval. Comes from previous call * to `ListStoredInfoTypes`. @@ -4508,10 +4806,25 @@ export class DlpServiceClient { * The request object that will be sent. * @param {string} request.parent * 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](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 + * + Organizations scope, location specified:
+ * `organizations/`ORG_ID`/locations/`LOCATION_ID + * + Organizations scope, no location specified (defaults to global):
+ * `organizations/`ORG_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 * @param {string} request.pageToken * Page token to continue retrieval. Comes from previous call * to `ListStoredInfoTypes`. @@ -4571,10 +4884,25 @@ export class DlpServiceClient { * The request object that will be sent. * @param {string} request.parent * 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](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 + * + Organizations scope, location specified:
+ * `organizations/`ORG_ID`/locations/`LOCATION_ID + * + Organizations scope, no location specified (defaults to global):
+ * `organizations/`ORG_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 * @param {string} request.pageToken * Page token to continue retrieval. Comes from previous call * to `ListStoredInfoTypes`. diff --git a/packages/google-privacy-dlp/synth.metadata b/packages/google-privacy-dlp/synth.metadata index 248486ccf4e..a0bdf4753fd 100644 --- a/packages/google-privacy-dlp/synth.metadata +++ b/packages/google-privacy-dlp/synth.metadata @@ -4,15 +4,15 @@ "git": { "name": ".", "remote": "https://github.com/googleapis/nodejs-dlp.git", - "sha": "39db29adcef20b7baed4b8a4351d12bcf2bc605f" + "sha": "5f58478d337beb4aabfa874087dafe477a644984" } }, { "git": { "name": "googleapis", "remote": "https://github.com/googleapis/googleapis.git", - "sha": "4c5071b615d96ef9dfd6a63d8429090f1f2872bb", - "internalRef": "327369997" + "sha": "1ee015d872d003637eb47b890930bf3d0d410c61", + "internalRef": "329758805" } }, {