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

Commit 54f9277

Browse files
yoshi-automationyoshi-automation
authored
docs: reformat comments in PolicyTagManager definition (#493)
This PR was generated using Autosynth. 🌈 Synth log will be available here: https://source.cloud.google.com/results/invocations/99ce2e49-b0f0-4fec-9462-6104f6e2f376/targets - [ ] To automatically regenerate this PR, check this box. (May take up to 24 hours.) PiperOrigin-RevId: 368687296 Source-Link: googleapis/googleapis@91eee3d
1 parent 864682d commit 54f9277

6 files changed

Lines changed: 82 additions & 42 deletions

File tree

‎google-cloud-datacatalog/src/main/java/com/google/cloud/datacatalog/v1/PolicyTagManagerClient.java‎

Lines changed: 28 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -770,9 +770,13 @@ public final UnaryCallable<CreatePolicyTagRequest, PolicyTag> createPolicyTagCal
770770

771771
// AUTO-GENERATED DOCUMENTATION AND METHOD.
772772
/**
773-
* Deletes a policy tag. This method also deletes - all of its descendant policy tags, if any, -
774-
* the policies associated with the policy tag and its descendants, and - references from BigQuery
775-
* table schema of the policy tag and its descendants.
773+
* Deletes a policy tag. This method also deletes:
774+
*
775+
* <ul>
776+
* <li>all of its descendant policy tags, if any
777+
* <li>the policies associated with the policy tag and its descendants
778+
* <li>references from BigQuery table schema of the policy tag and its descendants.
779+
* </ul>
776780
*
777781
* <p>Sample code:
778782
*
@@ -796,9 +800,13 @@ public final void deletePolicyTag(PolicyTagName name) {
796800

797801
// AUTO-GENERATED DOCUMENTATION AND METHOD.
798802
/**
799-
* Deletes a policy tag. This method also deletes - all of its descendant policy tags, if any, -
800-
* the policies associated with the policy tag and its descendants, and - references from BigQuery
801-
* table schema of the policy tag and its descendants.
803+
* Deletes a policy tag. This method also deletes:
804+
*
805+
* <ul>
806+
* <li>all of its descendant policy tags, if any
807+
* <li>the policies associated with the policy tag and its descendants
808+
* <li>references from BigQuery table schema of the policy tag and its descendants.
809+
* </ul>
802810
*
803811
* <p>Sample code:
804812
*
@@ -821,9 +829,13 @@ public final void deletePolicyTag(String name) {
821829

822830
// AUTO-GENERATED DOCUMENTATION AND METHOD.
823831
/**
824-
* Deletes a policy tag. This method also deletes - all of its descendant policy tags, if any, -
825-
* the policies associated with the policy tag and its descendants, and - references from BigQuery
826-
* table schema of the policy tag and its descendants.
832+
* Deletes a policy tag. This method also deletes:
833+
*
834+
* <ul>
835+
* <li>all of its descendant policy tags, if any
836+
* <li>the policies associated with the policy tag and its descendants
837+
* <li>references from BigQuery table schema of the policy tag and its descendants.
838+
* </ul>
827839
*
828840
* <p>Sample code:
829841
*
@@ -848,9 +860,13 @@ public final void deletePolicyTag(DeletePolicyTagRequest request) {
848860

849861
// AUTO-GENERATED DOCUMENTATION AND METHOD.
850862
/**
851-
* Deletes a policy tag. This method also deletes - all of its descendant policy tags, if any, -
852-
* the policies associated with the policy tag and its descendants, and - references from BigQuery
853-
* table schema of the policy tag and its descendants.
863+
* Deletes a policy tag. This method also deletes:
864+
*
865+
* <ul>
866+
* <li>all of its descendant policy tags, if any
867+
* <li>the policies associated with the policy tag and its descendants
868+
* <li>references from BigQuery table schema of the policy tag and its descendants.
869+
* </ul>
854870
*
855871
* <p>Sample code:
856872
*

‎grpc-google-cloud-datacatalog-v1/src/main/java/com/google/cloud/datacatalog/v1/PolicyTagManagerGrpc.java‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -764,11 +764,11 @@ public void createPolicyTag(
764764
*
765765
*
766766
* <pre>
767-
* Deletes a policy tag. This method also deletes
768-
* - all of its descendant policy tags, if any,
769-
* - the policies associated with the policy tag and its descendants, and
770-
* - references from BigQuery table schema of the policy tag and its
771-
* descendants.
767+
* Deletes a policy tag. This method also deletes:
768+
* * all of its descendant policy tags, if any
769+
* * the policies associated with the policy tag and its descendants
770+
* * references from BigQuery table schema of the policy tag and its
771+
* descendants.
772772
* </pre>
773773
*/
774774
public void deletePolicyTag(
@@ -1082,11 +1082,11 @@ public void createPolicyTag(
10821082
*
10831083
*
10841084
* <pre>
1085-
* Deletes a policy tag. This method also deletes
1086-
* - all of its descendant policy tags, if any,
1087-
* - the policies associated with the policy tag and its descendants, and
1088-
* - references from BigQuery table schema of the policy tag and its
1089-
* descendants.
1085+
* Deletes a policy tag. This method also deletes:
1086+
* * all of its descendant policy tags, if any
1087+
* * the policies associated with the policy tag and its descendants
1088+
* * references from BigQuery table schema of the policy tag and its
1089+
* descendants.
10901090
* </pre>
10911091
*/
10921092
public void deletePolicyTag(
@@ -1309,11 +1309,11 @@ public com.google.cloud.datacatalog.v1.PolicyTag createPolicyTag(
13091309
*
13101310
*
13111311
* <pre>
1312-
* Deletes a policy tag. This method also deletes
1313-
* - all of its descendant policy tags, if any,
1314-
* - the policies associated with the policy tag and its descendants, and
1315-
* - references from BigQuery table schema of the policy tag and its
1316-
* descendants.
1312+
* Deletes a policy tag. This method also deletes:
1313+
* * all of its descendant policy tags, if any
1314+
* * the policies associated with the policy tag and its descendants
1315+
* * references from BigQuery table schema of the policy tag and its
1316+
* descendants.
13171317
* </pre>
13181318
*/
13191319
public com.google.protobuf.Empty deletePolicyTag(
@@ -1516,11 +1516,11 @@ protected PolicyTagManagerFutureStub build(
15161516
*
15171517
*
15181518
* <pre>
1519-
* Deletes a policy tag. This method also deletes
1520-
* - all of its descendant policy tags, if any,
1521-
* - the policies associated with the policy tag and its descendants, and
1522-
* - references from BigQuery table schema of the policy tag and its
1523-
* descendants.
1519+
* Deletes a policy tag. This method also deletes:
1520+
* * all of its descendant policy tags, if any
1521+
* * the policies associated with the policy tag and its descendants
1522+
* * references from BigQuery table schema of the policy tag and its
1523+
* descendants.
15241524
* </pre>
15251525
*/
15261526
public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>

‎proto-google-cloud-datacatalog-v1/src/main/java/com/google/cloud/datacatalog/v1/PolicyTag.java‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,12 @@
2424
* <pre>
2525
* Denotes one policy tag in a taxonomy (e.g. ssn). Policy tags can be defined
2626
* in a hierarchy. For example, consider the following hierarchy:
27+
* ```
2728
* + Geolocation
2829
* + LatLong
2930
* + City
3031
* + ZipCode
32+
* ```
3133
* Policy tag "Geolocation" contains 3 child policy tags: "LatLong", "City", and
3234
* "ZipCode".
3335
* </pre>
@@ -654,10 +656,12 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build
654656
* <pre>
655657
* Denotes one policy tag in a taxonomy (e.g. ssn). Policy tags can be defined
656658
* in a hierarchy. For example, consider the following hierarchy:
659+
* ```
657660
* + Geolocation
658661
* + LatLong
659662
* + City
660663
* + ZipCode
664+
* ```
661665
* Policy tag "Geolocation" contains 3 child policy tags: "LatLong", "City", and
662666
* "ZipCode".
663667
* </pre>

‎proto-google-cloud-datacatalog-v1/src/main/java/com/google/cloud/datacatalog/v1/Taxonomy.java‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,18 +25,22 @@
2525
* A taxonomy is a collection of hierarchical policy tags that classify data
2626
* along a common axis. For instance a "data sensitivity" taxonomy could contain
2727
* the following policy tags:
28+
* ```
2829
* + PII
2930
* + Account number
3031
* + Age
3132
* + SSN
3233
* + Zipcode
3334
* + Financials
3435
* + Revenue
36+
* ```
3537
* A "data origin" taxonomy could contain the following policy tags:
38+
* ```
3639
* + User data
3740
* + Employee data
3841
* + Partner data
3942
* + Public data
43+
* ```
4044
* </pre>
4145
*
4246
* Protobuf type {@code google.cloud.datacatalog.v1.Taxonomy}
@@ -909,18 +913,22 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build
909913
* A taxonomy is a collection of hierarchical policy tags that classify data
910914
* along a common axis. For instance a "data sensitivity" taxonomy could contain
911915
* the following policy tags:
916+
* ```
912917
* + PII
913918
* + Account number
914919
* + Age
915920
* + SSN
916921
* + Zipcode
917922
* + Financials
918923
* + Revenue
924+
* ```
919925
* A "data origin" taxonomy could contain the following policy tags:
926+
* ```
920927
* + User data
921928
* + Employee data
922929
* + Partner data
923930
* + Public data
931+
* ```
924932
* </pre>
925933
*
926934
* Protobuf type {@code google.cloud.datacatalog.v1.Taxonomy}

‎proto-google-cloud-datacatalog-v1/src/main/proto/google/cloud/datacatalog/v1/policytagmanager.proto‎

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -101,11 +101,12 @@ service PolicyTagManager {
101101
option (google.api.method_signature) = "parent,policy_tag";
102102
}
103103

104-
// Deletes a policy tag. This method also deletes
105-
// - all of its descendant policy tags, if any,
106-
// - the policies associated with the policy tag and its descendants, and
107-
// - references from BigQuery table schema of the policy tag and its
108-
// descendants.
104+
// Deletes a policy tag. This method also deletes:
105+
//
106+
// * all of its descendant policy tags, if any
107+
// * the policies associated with the policy tag and its descendants
108+
// * references from BigQuery table schema of the policy tag and its
109+
// descendants.
109110
rpc DeletePolicyTag(DeletePolicyTagRequest) returns (google.protobuf.Empty) {
110111
option (google.api.http) = {
111112
delete: "/v1/{name=projects/*/locations/*/taxonomies/*/policyTags/*}"
@@ -180,18 +181,25 @@ service PolicyTagManager {
180181
// A taxonomy is a collection of hierarchical policy tags that classify data
181182
// along a common axis. For instance a "data sensitivity" taxonomy could contain
182183
// the following policy tags:
184+
//
185+
// ```
183186
// + PII
184187
// + Account number
185188
// + Age
186189
// + SSN
187190
// + Zipcode
188191
// + Financials
189192
// + Revenue
193+
// ```
194+
//
190195
// A "data origin" taxonomy could contain the following policy tags:
196+
//
197+
// ```
191198
// + User data
192199
// + Employee data
193200
// + Partner data
194201
// + Public data
202+
// ```
195203
message Taxonomy {
196204
option (google.api.resource) = {
197205
type: "datacatalog.googleapis.com/Taxonomy"
@@ -236,10 +244,14 @@ message Taxonomy {
236244

237245
// Denotes one policy tag in a taxonomy (e.g. ssn). Policy tags can be defined
238246
// in a hierarchy. For example, consider the following hierarchy:
247+
//
248+
// ```
239249
// + Geolocation
240250
// + LatLong
241251
// + City
242252
// + ZipCode
253+
// ```
254+
//
243255
// Policy tag "Geolocation" contains 3 child policy tags: "LatLong", "City", and
244256
// "ZipCode".
245257
message PolicyTag {

‎synth.metadata‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,23 @@
44
"git": {
55
"name": ".",
66
"remote": "https://github.com/googleapis/java-datacatalog.git",
7-
"sha": "638ce6ad2a31609117ed10b75ff9b899fb4ae5ce"
7+
"sha": "5243cd799592056159fb7d6b37188bf7c5814f60"
88
}
99
},
1010
{
1111
"git": {
1212
"name": "googleapis",
1313
"remote": "https://github.com/googleapis/googleapis.git",
14-
"sha": "a1ab4d44db02d59ff58810c6d4182d84e4b9abaa",
15-
"internalRef": "365620142"
14+
"sha": "91eee3d039fbdbadee008393504900287bbc6f43",
15+
"internalRef": "368687296"
1616
}
1717
},
1818
{
1919
"git": {
2020
"name": "googleapis",
2121
"remote": "https://github.com/googleapis/googleapis.git",
22-
"sha": "a1ab4d44db02d59ff58810c6d4182d84e4b9abaa",
23-
"internalRef": "365620142"
22+
"sha": "91eee3d039fbdbadee008393504900287bbc6f43",
23+
"internalRef": "368687296"
2424
}
2525
},
2626
{

0 commit comments

Comments
 (0)