Skip to content
This repository has been archived by the owner on Sep 27, 2023. It is now read-only.

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). #266

Merged
merged 1 commit into from Sep 9, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view

Large diffs are not rendered by default.

Expand Up @@ -172,7 +172,7 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
* <pre>
* 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.
* </pre>
*
* Protobuf enum {@code google.privacy.dlp.v2.BigQueryOptions.SampleMethod}
Expand All @@ -184,7 +184,9 @@ public enum SampleMethod implements com.google.protobuf.ProtocolMessageEnum {
*
*
* <pre>
* 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.
* </pre>
*
* <code>TOP = 1;</code>
Expand All @@ -194,7 +196,7 @@ public enum SampleMethod implements com.google.protobuf.ProtocolMessageEnum {
*
*
* <pre>
* Randomly pick the row to start scanning. The scanned rows are contiguous.
* Randomly pick groups of rows to scan.
* </pre>
*
* <code>RANDOM_START = 2;</code>
Expand All @@ -209,7 +211,9 @@ public enum SampleMethod implements com.google.protobuf.ProtocolMessageEnum {
*
*
* <pre>
* 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.
* </pre>
*
* <code>TOP = 1;</code>
Expand All @@ -219,7 +223,7 @@ public enum SampleMethod implements com.google.protobuf.ProtocolMessageEnum {
*
*
* <pre>
* Randomly pick the row to start scanning. The scanned rows are contiguous.
* Randomly pick groups of rows to scan.
* </pre>
*
* <code>RANDOM_START = 2;</code>
Expand Down
Expand Up @@ -151,10 +151,21 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
*
* <pre>
* 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:&lt;br/&gt;
* `projects/`&lt;var&gt;PROJECT_ID&lt;/var&gt;`/locations/`&lt;var&gt;LOCATION_ID&lt;/var&gt;
* + Projects scope, no location specified (defaults to global):&lt;br/&gt;
* `projects/`&lt;var&gt;PROJECT_ID&lt;/var&gt;
* + Organizations scope, location specified:&lt;br/&gt;
* `organizations/`&lt;var&gt;ORG_ID&lt;/var&gt;`/locations/`&lt;var&gt;LOCATION_ID&lt;/var&gt;
* + Organizations scope, no location specified (defaults to global):&lt;br/&gt;
* `organizations/`&lt;var&gt;ORG_ID&lt;/var&gt;
* 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
* </pre>
*
* <code>
Expand All @@ -180,10 +191,21 @@ public java.lang.String getParent() {
*
* <pre>
* 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:&lt;br/&gt;
* `projects/`&lt;var&gt;PROJECT_ID&lt;/var&gt;`/locations/`&lt;var&gt;LOCATION_ID&lt;/var&gt;
* + Projects scope, no location specified (defaults to global):&lt;br/&gt;
* `projects/`&lt;var&gt;PROJECT_ID&lt;/var&gt;
* + Organizations scope, location specified:&lt;br/&gt;
* `organizations/`&lt;var&gt;ORG_ID&lt;/var&gt;`/locations/`&lt;var&gt;LOCATION_ID&lt;/var&gt;
* + Organizations scope, no location specified (defaults to global):&lt;br/&gt;
* `organizations/`&lt;var&gt;ORG_ID&lt;/var&gt;
* 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
* </pre>
*
* <code>
Expand Down Expand Up @@ -748,10 +770,21 @@ public Builder mergeFrom(
*
* <pre>
* 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:&lt;br/&gt;
* `projects/`&lt;var&gt;PROJECT_ID&lt;/var&gt;`/locations/`&lt;var&gt;LOCATION_ID&lt;/var&gt;
* + Projects scope, no location specified (defaults to global):&lt;br/&gt;
* `projects/`&lt;var&gt;PROJECT_ID&lt;/var&gt;
* + Organizations scope, location specified:&lt;br/&gt;
* `organizations/`&lt;var&gt;ORG_ID&lt;/var&gt;`/locations/`&lt;var&gt;LOCATION_ID&lt;/var&gt;
* + Organizations scope, no location specified (defaults to global):&lt;br/&gt;
* `organizations/`&lt;var&gt;ORG_ID&lt;/var&gt;
* 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
* </pre>
*
* <code>
Expand All @@ -776,10 +809,21 @@ public java.lang.String getParent() {
*
* <pre>
* 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:&lt;br/&gt;
* `projects/`&lt;var&gt;PROJECT_ID&lt;/var&gt;`/locations/`&lt;var&gt;LOCATION_ID&lt;/var&gt;
* + Projects scope, no location specified (defaults to global):&lt;br/&gt;
* `projects/`&lt;var&gt;PROJECT_ID&lt;/var&gt;
* + Organizations scope, location specified:&lt;br/&gt;
* `organizations/`&lt;var&gt;ORG_ID&lt;/var&gt;`/locations/`&lt;var&gt;LOCATION_ID&lt;/var&gt;
* + Organizations scope, no location specified (defaults to global):&lt;br/&gt;
* `organizations/`&lt;var&gt;ORG_ID&lt;/var&gt;
* 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
* </pre>
*
* <code>
Expand All @@ -804,10 +848,21 @@ public com.google.protobuf.ByteString getParentBytes() {
*
* <pre>
* 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:&lt;br/&gt;
* `projects/`&lt;var&gt;PROJECT_ID&lt;/var&gt;`/locations/`&lt;var&gt;LOCATION_ID&lt;/var&gt;
* + Projects scope, no location specified (defaults to global):&lt;br/&gt;
* `projects/`&lt;var&gt;PROJECT_ID&lt;/var&gt;
* + Organizations scope, location specified:&lt;br/&gt;
* `organizations/`&lt;var&gt;ORG_ID&lt;/var&gt;`/locations/`&lt;var&gt;LOCATION_ID&lt;/var&gt;
* + Organizations scope, no location specified (defaults to global):&lt;br/&gt;
* `organizations/`&lt;var&gt;ORG_ID&lt;/var&gt;
* 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
* </pre>
*
* <code>
Expand All @@ -831,10 +886,21 @@ public Builder setParent(java.lang.String value) {
*
* <pre>
* 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:&lt;br/&gt;
* `projects/`&lt;var&gt;PROJECT_ID&lt;/var&gt;`/locations/`&lt;var&gt;LOCATION_ID&lt;/var&gt;
* + Projects scope, no location specified (defaults to global):&lt;br/&gt;
* `projects/`&lt;var&gt;PROJECT_ID&lt;/var&gt;
* + Organizations scope, location specified:&lt;br/&gt;
* `organizations/`&lt;var&gt;ORG_ID&lt;/var&gt;`/locations/`&lt;var&gt;LOCATION_ID&lt;/var&gt;
* + Organizations scope, no location specified (defaults to global):&lt;br/&gt;
* `organizations/`&lt;var&gt;ORG_ID&lt;/var&gt;
* 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
* </pre>
*
* <code>
Expand All @@ -854,10 +920,21 @@ public Builder clearParent() {
*
* <pre>
* 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:&lt;br/&gt;
* `projects/`&lt;var&gt;PROJECT_ID&lt;/var&gt;`/locations/`&lt;var&gt;LOCATION_ID&lt;/var&gt;
* + Projects scope, no location specified (defaults to global):&lt;br/&gt;
* `projects/`&lt;var&gt;PROJECT_ID&lt;/var&gt;
* + Organizations scope, location specified:&lt;br/&gt;
* `organizations/`&lt;var&gt;ORG_ID&lt;/var&gt;`/locations/`&lt;var&gt;LOCATION_ID&lt;/var&gt;
* + Organizations scope, no location specified (defaults to global):&lt;br/&gt;
* `organizations/`&lt;var&gt;ORG_ID&lt;/var&gt;
* 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
* </pre>
*
* <code>
Expand Down
Expand Up @@ -28,10 +28,21 @@ public interface CreateDeidentifyTemplateRequestOrBuilder
*
* <pre>
* 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:&lt;br/&gt;
* `projects/`&lt;var&gt;PROJECT_ID&lt;/var&gt;`/locations/`&lt;var&gt;LOCATION_ID&lt;/var&gt;
* + Projects scope, no location specified (defaults to global):&lt;br/&gt;
* `projects/`&lt;var&gt;PROJECT_ID&lt;/var&gt;
* + Organizations scope, location specified:&lt;br/&gt;
* `organizations/`&lt;var&gt;ORG_ID&lt;/var&gt;`/locations/`&lt;var&gt;LOCATION_ID&lt;/var&gt;
* + Organizations scope, no location specified (defaults to global):&lt;br/&gt;
* `organizations/`&lt;var&gt;ORG_ID&lt;/var&gt;
* 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
* </pre>
*
* <code>
Expand All @@ -46,10 +57,21 @@ public interface CreateDeidentifyTemplateRequestOrBuilder
*
* <pre>
* 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:&lt;br/&gt;
* `projects/`&lt;var&gt;PROJECT_ID&lt;/var&gt;`/locations/`&lt;var&gt;LOCATION_ID&lt;/var&gt;
* + Projects scope, no location specified (defaults to global):&lt;br/&gt;
* `projects/`&lt;var&gt;PROJECT_ID&lt;/var&gt;
* + Organizations scope, location specified:&lt;br/&gt;
* `organizations/`&lt;var&gt;ORG_ID&lt;/var&gt;`/locations/`&lt;var&gt;LOCATION_ID&lt;/var&gt;
* + Organizations scope, no location specified (defaults to global):&lt;br/&gt;
* `organizations/`&lt;var&gt;ORG_ID&lt;/var&gt;
* 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
* </pre>
*
* <code>
Expand Down