Skip to content

Commit

Permalink
docs: update proto comments (#451)
Browse files Browse the repository at this point in the history
Co-authored-by: Justin Beckwith <justin.beckwith@gmail.com>
  • Loading branch information
yoshi-automation and JustinBeckwith authored Apr 12, 2020
1 parent 0821728 commit f98053c
Show file tree
Hide file tree
Showing 4 changed files with 37 additions and 17 deletions.
19 changes: 11 additions & 8 deletions packages/google-privacy-dlp/protos/google/privacy/dlp/v2/dlp.proto
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ option java_multiple_files = true;
option java_outer_classname = "DlpProto";
option java_package = "com.google.privacy.dlp.v2";
option php_namespace = "Google\\Cloud\\Dlp\\V2";
option ruby_package = "Google::Cloud::Dlp::V2";
option (google.api.resource_definition) = {
type: "dlp.googleapis.com/OrganizationLocation"
pattern: "organizations/{organization}/locations/{location}"
Expand Down Expand Up @@ -920,15 +921,16 @@ message Finding {
// The labels associated with this `InspectFinding`.
//
// 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\])?.
// 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\])?)?.
// to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
//
// No more than 10 labels can be associated with a given finding.
//
// Example: <code>"environment" : "production"</code>
// Example: <code>"pipeline" : "etl"</code>
// Examples:
// * `"environment" : "production"`
// * `"pipeline" : "etl"`
map<string, string> labels = 10;

// Time the job started that produced this finding.
Expand Down Expand Up @@ -3957,15 +3959,16 @@ message HybridFindingDetails {
// 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\])?.
// 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\])?)?.
// to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
//
// No more than 10 labels can be associated with a given finding.
//
// Example: <code>"environment" : "production"</code>
// Example: <code>"pipeline" : "etl"</code>
// Examples:
// * `"environment" : "production"`
// * `"pipeline" : "etl"`
map<string, string> labels = 5;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,15 @@ option java_multiple_files = true;
option java_outer_classname = "DlpStorage";
option java_package = "com.google.privacy.dlp.v2";
option php_namespace = "Google\\Cloud\\Dlp\\V2";
option ruby_package = "Google::Cloud::Dlp::V2";

// Type of information detected by the API.
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-zA-Z0-9_]{1,64}`.
string name = 1;
}

Expand Down Expand Up @@ -552,23 +553,24 @@ message HybridOptions {
// 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\])?.
// to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.
//
// No more than 10 keys can be required.
repeated string required_finding_label_keys = 2;

// 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\])?.
// 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\])?)?.
// to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
//
// No more than 10 labels can be associated with a given finding.
//
// Example: <code>"environment" : "production"</code>
// Example: <code>"pipeline" : "etl"</code>
// Examples:
// * `"environment" : "production"`
// * `"pipeline" : "etl"`
map<string, string> labels = 3;

// If the container is a table, additional information to make findings
Expand Down
1 change: 1 addition & 0 deletions packages/google-privacy-dlp/protos/protos.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
"java_outer_classname": "DlpStorage",
"java_package": "com.google.privacy.dlp.v2",
"php_namespace": "Google\\Cloud\\Dlp\\V2",
"ruby_package": "Google::Cloud::Dlp::V2",
"(google.api.resource_definition).type": "dlp.googleapis.com/OrganizationLocation",
"(google.api.resource_definition).pattern": "organizations/{organization}/locations/{location}"
},
Expand Down
20 changes: 17 additions & 3 deletions packages/google-privacy-dlp/synth.metadata
Original file line number Diff line number Diff line change
@@ -1,12 +1,26 @@
{
"updateTime": "2020-04-11T00:22:56.712535Z",
"sources": [
{
"git": {
"name": ".",
"remote": "https://github.com/googleapis/nodejs-dlp.git",
"sha": "e00c5dac055785dd361bf51d587e2a174f3d40a6"
}
},
{
"git": {
"name": "googleapis",
"remote": "https://github.com/googleapis/googleapis.git",
"sha": "1bd77e8ce6f953ac641af7966d0c52646afc16a8",
"internalRef": "305974465"
}
},
{
"git": {
"name": "synthtool",
"remote": "https://github.com/googleapis/synthtool.git",
"sha": "6f32150677c9784f3c3a7e1949472bd29c9d72c5",
"log": "6f32150677c9784f3c3a7e1949472bd29c9d72c5\nfix: installs test_utils from its common repo (#480)\n\n\n74ce986d3b5431eb66985e9a00c4eb45295a4020\nfix: stop recording update_time in synth.metadata (#478)\n\n\n7f8e62aa3edd225f76347a16f92e400661fdfb52\nchore(java): release-please only updates non maven versions in README (#476)\n\nPrevent release-please and synthtool from fighting over the released library version. Synthtool updates the install snippets from the samples pom.xml files so the bots fight if they are temporarily out of sync after a release.\nc7e0e517d7f46f77bebd27da2e5afcaa6eee7e25\nbuild(java): fix nightly integration test config to run integrations (#465)\n\nThis was only running the units.\nbd69a2aa7b70875f3c988e269706b22fefbef40e\nbuild(java): fix retry_with_backoff when -e option set (#475)\n\n\nd9b173c427bfa0c6cca818233562e7e8841a357c\nfix: record version of working repo in synth.metadata (#473)\n\nPartial revert of b37cf74d12e9a42b9de9e61a4f26133d7cd9c168.\nf73a541770d95a609e5be6bf6b3b220d17cefcbe\nfeat(discogapic): allow local discovery-artifact-manager (#474)\n\n\n8cf0f5d93a70c3dcb0b4999d3152c46d4d9264bf\ndoc: describe the Autosynth & Synthtool protocol (#472)\n\n* doc: describe the Autosynth & Synthtool protocol\n\n* Accommodate review comments.\n980baaa738a1ad8fa02b4fdbd56be075ee77ece5\nfix: pin sphinx to <3.0.0 as new version causes new error (#471)\n\nThe error `toctree contains reference to document changlelog that doesn't have a title: no link will be generated` occurs as of 3.0.0. Pinning to 2.x until we address the docs build issue.\n\nTowards #470\n\nI did this manually for python-datastore https://github.com/googleapis/python-datastore/pull/22\n928b2998ac5023e7c7e254ab935f9ef022455aad\nchore(deps): update dependency com.google.cloud.samples:shared-configuration to v1.0.15 (#466)\n\nCo-authored-by: Jeffrey Rennie <rennie@google.com>\n188f1b1d53181f739b98f8aa5d40cfe99eb90c47\nfix: allow local and external deps to be specified (#469)\n\nModify noxfile.py to allow local and external dependencies for\nsystem tests to be specified.\n1df68ed6735ddce6797d0f83641a731c3c3f75b4\nfix: apache license URL (#468)\n\n\nf4a59efa54808c4b958263de87bc666ce41e415f\nfeat: Add discogapic support for GAPICBazel generation (#459)\n\n* feat: Add discogapic support for GAPICBazel generation\n\n* reformat with black\n\n* Rename source repository variable\n\nCo-authored-by: Jeffrey Rennie <rennie@google.com>\n"
"sha": "21c3b57ae54ae9db6a3a6b48b31c970c6ab56f19",
"log": "21c3b57ae54ae9db6a3a6b48b31c970c6ab56f19\nbuild(nodejs): remove unused codecov config (#486)\n\n\n"
}
}
],
Expand Down

0 comments on commit f98053c

Please sign in to comment.