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

docs: reformat comments in PolicyTagManager definition #493

Merged
merged 1 commit into from Apr 23, 2021
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
Expand Up @@ -770,9 +770,13 @@ public final UnaryCallable<CreatePolicyTagRequest, PolicyTag> createPolicyTagCal

// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a policy tag. This method also deletes - all of its descendant policy tags, if any, -
* the policies associated with the policy tag and its descendants, and - references from BigQuery
* table schema of the policy tag and its descendants.
* Deletes a policy tag. This method also deletes:
*
* <ul>
* <li>all of its descendant policy tags, if any
* <li>the policies associated with the policy tag and its descendants
* <li>references from BigQuery table schema of the policy tag and its descendants.
* </ul>
*
* <p>Sample code:
*
Expand All @@ -796,9 +800,13 @@ public final void deletePolicyTag(PolicyTagName name) {

// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a policy tag. This method also deletes - all of its descendant policy tags, if any, -
* the policies associated with the policy tag and its descendants, and - references from BigQuery
* table schema of the policy tag and its descendants.
* Deletes a policy tag. This method also deletes:
*
* <ul>
* <li>all of its descendant policy tags, if any
* <li>the policies associated with the policy tag and its descendants
* <li>references from BigQuery table schema of the policy tag and its descendants.
* </ul>
*
* <p>Sample code:
*
Expand All @@ -821,9 +829,13 @@ public final void deletePolicyTag(String name) {

// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a policy tag. This method also deletes - all of its descendant policy tags, if any, -
* the policies associated with the policy tag and its descendants, and - references from BigQuery
* table schema of the policy tag and its descendants.
* Deletes a policy tag. This method also deletes:
*
* <ul>
* <li>all of its descendant policy tags, if any
* <li>the policies associated with the policy tag and its descendants
* <li>references from BigQuery table schema of the policy tag and its descendants.
* </ul>
*
* <p>Sample code:
*
Expand All @@ -848,9 +860,13 @@ public final void deletePolicyTag(DeletePolicyTagRequest request) {

// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a policy tag. This method also deletes - all of its descendant policy tags, if any, -
* the policies associated with the policy tag and its descendants, and - references from BigQuery
* table schema of the policy tag and its descendants.
* Deletes a policy tag. This method also deletes:
*
* <ul>
* <li>all of its descendant policy tags, if any
* <li>the policies associated with the policy tag and its descendants
* <li>references from BigQuery table schema of the policy tag and its descendants.
* </ul>
*
* <p>Sample code:
*
Expand Down
Expand Up @@ -764,11 +764,11 @@ public void createPolicyTag(
*
*
* <pre>
* Deletes a policy tag. This method also deletes
* - all of its descendant policy tags, if any,
* - the policies associated with the policy tag and its descendants, and
* - references from BigQuery table schema of the policy tag and its
* descendants.
* Deletes a policy tag. This method also deletes:
* * all of its descendant policy tags, if any
* * the policies associated with the policy tag and its descendants
* * references from BigQuery table schema of the policy tag and its
* descendants.
* </pre>
*/
public void deletePolicyTag(
Expand Down Expand Up @@ -1082,11 +1082,11 @@ public void createPolicyTag(
*
*
* <pre>
* Deletes a policy tag. This method also deletes
* - all of its descendant policy tags, if any,
* - the policies associated with the policy tag and its descendants, and
* - references from BigQuery table schema of the policy tag and its
* descendants.
* Deletes a policy tag. This method also deletes:
* * all of its descendant policy tags, if any
* * the policies associated with the policy tag and its descendants
* * references from BigQuery table schema of the policy tag and its
* descendants.
* </pre>
*/
public void deletePolicyTag(
Expand Down Expand Up @@ -1309,11 +1309,11 @@ public com.google.cloud.datacatalog.v1.PolicyTag createPolicyTag(
*
*
* <pre>
* Deletes a policy tag. This method also deletes
* - all of its descendant policy tags, if any,
* - the policies associated with the policy tag and its descendants, and
* - references from BigQuery table schema of the policy tag and its
* descendants.
* Deletes a policy tag. This method also deletes:
* * all of its descendant policy tags, if any
* * the policies associated with the policy tag and its descendants
* * references from BigQuery table schema of the policy tag and its
* descendants.
* </pre>
*/
public com.google.protobuf.Empty deletePolicyTag(
Expand Down Expand Up @@ -1516,11 +1516,11 @@ protected PolicyTagManagerFutureStub build(
*
*
* <pre>
* Deletes a policy tag. This method also deletes
* - all of its descendant policy tags, if any,
* - the policies associated with the policy tag and its descendants, and
* - references from BigQuery table schema of the policy tag and its
* descendants.
* Deletes a policy tag. This method also deletes:
* * all of its descendant policy tags, if any
* * the policies associated with the policy tag and its descendants
* * references from BigQuery table schema of the policy tag and its
* descendants.
* </pre>
*/
public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>
Expand Down
Expand Up @@ -24,10 +24,12 @@
* <pre>
* Denotes one policy tag in a taxonomy (e.g. ssn). Policy tags can be defined
* in a hierarchy. For example, consider the following hierarchy:
* ```
* + Geolocation
* + LatLong
* + City
* + ZipCode
* ```
* Policy tag "Geolocation" contains 3 child policy tags: "LatLong", "City", and
* "ZipCode".
* </pre>
Expand Down Expand Up @@ -654,10 +656,12 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build
* <pre>
* Denotes one policy tag in a taxonomy (e.g. ssn). Policy tags can be defined
* in a hierarchy. For example, consider the following hierarchy:
* ```
* + Geolocation
* + LatLong
* + City
* + ZipCode
* ```
* Policy tag "Geolocation" contains 3 child policy tags: "LatLong", "City", and
* "ZipCode".
* </pre>
Expand Down
Expand Up @@ -25,18 +25,22 @@
* A taxonomy is a collection of hierarchical policy tags that classify data
* along a common axis. For instance a "data sensitivity" taxonomy could contain
* the following policy tags:
* ```
* + PII
* + Account number
* + Age
* + SSN
* + Zipcode
* + Financials
* + Revenue
* ```
* A "data origin" taxonomy could contain the following policy tags:
* ```
* + User data
* + Employee data
* + Partner data
* + Public data
* ```
* </pre>
*
* Protobuf type {@code google.cloud.datacatalog.v1.Taxonomy}
Expand Down Expand Up @@ -909,18 +913,22 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build
* A taxonomy is a collection of hierarchical policy tags that classify data
* along a common axis. For instance a "data sensitivity" taxonomy could contain
* the following policy tags:
* ```
* + PII
* + Account number
* + Age
* + SSN
* + Zipcode
* + Financials
* + Revenue
* ```
* A "data origin" taxonomy could contain the following policy tags:
* ```
* + User data
* + Employee data
* + Partner data
* + Public data
* ```
* </pre>
*
* Protobuf type {@code google.cloud.datacatalog.v1.Taxonomy}
Expand Down
Expand Up @@ -101,11 +101,12 @@ service PolicyTagManager {
option (google.api.method_signature) = "parent,policy_tag";
}

// Deletes a policy tag. This method also deletes
// - all of its descendant policy tags, if any,
// - the policies associated with the policy tag and its descendants, and
// - references from BigQuery table schema of the policy tag and its
// descendants.
// Deletes a policy tag. This method also deletes:
//
// * all of its descendant policy tags, if any
// * the policies associated with the policy tag and its descendants
// * references from BigQuery table schema of the policy tag and its
// descendants.
rpc DeletePolicyTag(DeletePolicyTagRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/taxonomies/*/policyTags/*}"
Expand Down Expand Up @@ -180,18 +181,25 @@ service PolicyTagManager {
// A taxonomy is a collection of hierarchical policy tags that classify data
// along a common axis. For instance a "data sensitivity" taxonomy could contain
// the following policy tags:
//
// ```
// + PII
// + Account number
// + Age
// + SSN
// + Zipcode
// + Financials
// + Revenue
// ```
//
// A "data origin" taxonomy could contain the following policy tags:
//
// ```
// + User data
// + Employee data
// + Partner data
// + Public data
// ```
message Taxonomy {
option (google.api.resource) = {
type: "datacatalog.googleapis.com/Taxonomy"
Expand Down Expand Up @@ -236,10 +244,14 @@ message Taxonomy {

// Denotes one policy tag in a taxonomy (e.g. ssn). Policy tags can be defined
// in a hierarchy. For example, consider the following hierarchy:
//
// ```
// + Geolocation
// + LatLong
// + City
// + ZipCode
// ```
//
// Policy tag "Geolocation" contains 3 child policy tags: "LatLong", "City", and
// "ZipCode".
message PolicyTag {
Expand Down
10 changes: 5 additions & 5 deletions synth.metadata
Expand Up @@ -4,23 +4,23 @@
"git": {
"name": ".",
"remote": "https://github.com/googleapis/java-datacatalog.git",
"sha": "638ce6ad2a31609117ed10b75ff9b899fb4ae5ce"
"sha": "5243cd799592056159fb7d6b37188bf7c5814f60"
}
},
{
"git": {
"name": "googleapis",
"remote": "https://github.com/googleapis/googleapis.git",
"sha": "a1ab4d44db02d59ff58810c6d4182d84e4b9abaa",
"internalRef": "365620142"
"sha": "91eee3d039fbdbadee008393504900287bbc6f43",
"internalRef": "368687296"
}
},
{
"git": {
"name": "googleapis",
"remote": "https://github.com/googleapis/googleapis.git",
"sha": "a1ab4d44db02d59ff58810c6d4182d84e4b9abaa",
"internalRef": "365620142"
"sha": "91eee3d039fbdbadee008393504900287bbc6f43",
"internalRef": "368687296"
}
},
{
Expand Down