Thanks to visit codestin.com
Credit goes to github.com

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

Commit 59b1b5a

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
chore(docs): fix google.api.resource documentation (#279)
- [ ] Regenerate this pull request now. PiperOrigin-RevId: 416585458 Source-Link: googleapis/googleapis@f59df18 Source-Link: https://github.com/googleapis/googleapis-gen/commit/3a557234f4399aff41042d1f2bb24b778a44d45e Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiM2E1NTcyMzRmNDM5OWFmZjQxMDQyZDFmMmJiMjRiNzc4YTQ0ZDQ1ZSJ9
1 parent ad159ff commit 59b1b5a

File tree

2 files changed

+30
-203
lines changed

2 files changed

+30
-203
lines changed

‎proto-google-common-protos/src/main/java/com/google/api/ResourceDescriptor.java‎

Lines changed: 20 additions & 132 deletions
Original file line numberDiff line numberDiff line change
@@ -33,88 +33,32 @@
3333
* // For Kubernetes resources, the format is {api group}/{kind}.
3434
* option (google.api.resource) = {
3535
* type: "pubsub.googleapis.com/Topic"
36-
* name_descriptor: {
37-
* pattern: "projects/{project}/topics/{topic}"
38-
* parent_type: "cloudresourcemanager.googleapis.com/Project"
39-
* parent_name_extractor: "projects/{project}"
40-
* }
36+
* pattern: "projects/{project}/topics/{topic}"
4137
* };
4238
* }
4339
* The ResourceDescriptor Yaml config will look like:
4440
* resources:
4541
* - type: "pubsub.googleapis.com/Topic"
46-
* name_descriptor:
47-
* - pattern: "projects/{project}/topics/{topic}"
48-
* parent_type: "cloudresourcemanager.googleapis.com/Project"
49-
* parent_name_extractor: "projects/{project}"
42+
* pattern: "projects/{project}/topics/{topic}"
5043
* Sometimes, resources have multiple patterns, typically because they can
5144
* live under multiple parents.
5245
* Example:
5346
* message LogEntry {
5447
* option (google.api.resource) = {
5548
* type: "logging.googleapis.com/LogEntry"
56-
* name_descriptor: {
57-
* pattern: "projects/{project}/logs/{log}"
58-
* parent_type: "cloudresourcemanager.googleapis.com/Project"
59-
* parent_name_extractor: "projects/{project}"
60-
* }
61-
* name_descriptor: {
62-
* pattern: "folders/{folder}/logs/{log}"
63-
* parent_type: "cloudresourcemanager.googleapis.com/Folder"
64-
* parent_name_extractor: "folders/{folder}"
65-
* }
66-
* name_descriptor: {
67-
* pattern: "organizations/{organization}/logs/{log}"
68-
* parent_type: "cloudresourcemanager.googleapis.com/Organization"
69-
* parent_name_extractor: "organizations/{organization}"
70-
* }
71-
* name_descriptor: {
72-
* pattern: "billingAccounts/{billing_account}/logs/{log}"
73-
* parent_type: "billing.googleapis.com/BillingAccount"
74-
* parent_name_extractor: "billingAccounts/{billing_account}"
75-
* }
49+
* pattern: "projects/{project}/logs/{log}"
50+
* pattern: "folders/{folder}/logs/{log}"
51+
* pattern: "organizations/{organization}/logs/{log}"
52+
* pattern: "billingAccounts/{billing_account}/logs/{log}"
7653
* };
7754
* }
7855
* The ResourceDescriptor Yaml config will look like:
7956
* resources:
8057
* - type: 'logging.googleapis.com/LogEntry'
81-
* name_descriptor:
82-
* - pattern: "projects/{project}/logs/{log}"
83-
* parent_type: "cloudresourcemanager.googleapis.com/Project"
84-
* parent_name_extractor: "projects/{project}"
85-
* - pattern: "folders/{folder}/logs/{log}"
86-
* parent_type: "cloudresourcemanager.googleapis.com/Folder"
87-
* parent_name_extractor: "folders/{folder}"
88-
* - pattern: "organizations/{organization}/logs/{log}"
89-
* parent_type: "cloudresourcemanager.googleapis.com/Organization"
90-
* parent_name_extractor: "organizations/{organization}"
91-
* - pattern: "billingAccounts/{billing_account}/logs/{log}"
92-
* parent_type: "billing.googleapis.com/BillingAccount"
93-
* parent_name_extractor: "billingAccounts/{billing_account}"
94-
* For flexible resources, the resource name doesn't contain parent names, but
95-
* the resource itself has parents for policy evaluation.
96-
* Example:
97-
* message Shelf {
98-
* option (google.api.resource) = {
99-
* type: "library.googleapis.com/Shelf"
100-
* name_descriptor: {
101-
* pattern: "shelves/{shelf}"
102-
* parent_type: "cloudresourcemanager.googleapis.com/Project"
103-
* }
104-
* name_descriptor: {
105-
* pattern: "shelves/{shelf}"
106-
* parent_type: "cloudresourcemanager.googleapis.com/Folder"
107-
* }
108-
* };
109-
* }
110-
* The ResourceDescriptor Yaml config will look like:
111-
* resources:
112-
* - type: 'library.googleapis.com/Shelf'
113-
* name_descriptor:
114-
* - pattern: "shelves/{shelf}"
115-
* parent_type: "cloudresourcemanager.googleapis.com/Project"
116-
* - pattern: "shelves/{shelf}"
117-
* parent_type: "cloudresourcemanager.googleapis.com/Folder"
58+
* pattern: "projects/{project}/logs/{log}"
59+
* pattern: "folders/{folder}/logs/{log}"
60+
* pattern: "organizations/{organization}/logs/{log}"
61+
* pattern: "billingAccounts/{billing_account}/logs/{log}"
11862
* </pre>
11963
*
12064
* Protobuf type {@code google.api.ResourceDescriptor}
@@ -1342,88 +1286,32 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build
13421286
* // For Kubernetes resources, the format is {api group}/{kind}.
13431287
* option (google.api.resource) = {
13441288
* type: "pubsub.googleapis.com/Topic"
1345-
* name_descriptor: {
1346-
* pattern: "projects/{project}/topics/{topic}"
1347-
* parent_type: "cloudresourcemanager.googleapis.com/Project"
1348-
* parent_name_extractor: "projects/{project}"
1349-
* }
1289+
* pattern: "projects/{project}/topics/{topic}"
13501290
* };
13511291
* }
13521292
* The ResourceDescriptor Yaml config will look like:
13531293
* resources:
13541294
* - type: "pubsub.googleapis.com/Topic"
1355-
* name_descriptor:
1356-
* - pattern: "projects/{project}/topics/{topic}"
1357-
* parent_type: "cloudresourcemanager.googleapis.com/Project"
1358-
* parent_name_extractor: "projects/{project}"
1295+
* pattern: "projects/{project}/topics/{topic}"
13591296
* Sometimes, resources have multiple patterns, typically because they can
13601297
* live under multiple parents.
13611298
* Example:
13621299
* message LogEntry {
13631300
* option (google.api.resource) = {
13641301
* type: "logging.googleapis.com/LogEntry"
1365-
* name_descriptor: {
1366-
* pattern: "projects/{project}/logs/{log}"
1367-
* parent_type: "cloudresourcemanager.googleapis.com/Project"
1368-
* parent_name_extractor: "projects/{project}"
1369-
* }
1370-
* name_descriptor: {
1371-
* pattern: "folders/{folder}/logs/{log}"
1372-
* parent_type: "cloudresourcemanager.googleapis.com/Folder"
1373-
* parent_name_extractor: "folders/{folder}"
1374-
* }
1375-
* name_descriptor: {
1376-
* pattern: "organizations/{organization}/logs/{log}"
1377-
* parent_type: "cloudresourcemanager.googleapis.com/Organization"
1378-
* parent_name_extractor: "organizations/{organization}"
1379-
* }
1380-
* name_descriptor: {
1381-
* pattern: "billingAccounts/{billing_account}/logs/{log}"
1382-
* parent_type: "billing.googleapis.com/BillingAccount"
1383-
* parent_name_extractor: "billingAccounts/{billing_account}"
1384-
* }
1302+
* pattern: "projects/{project}/logs/{log}"
1303+
* pattern: "folders/{folder}/logs/{log}"
1304+
* pattern: "organizations/{organization}/logs/{log}"
1305+
* pattern: "billingAccounts/{billing_account}/logs/{log}"
13851306
* };
13861307
* }
13871308
* The ResourceDescriptor Yaml config will look like:
13881309
* resources:
13891310
* - type: 'logging.googleapis.com/LogEntry'
1390-
* name_descriptor:
1391-
* - pattern: "projects/{project}/logs/{log}"
1392-
* parent_type: "cloudresourcemanager.googleapis.com/Project"
1393-
* parent_name_extractor: "projects/{project}"
1394-
* - pattern: "folders/{folder}/logs/{log}"
1395-
* parent_type: "cloudresourcemanager.googleapis.com/Folder"
1396-
* parent_name_extractor: "folders/{folder}"
1397-
* - pattern: "organizations/{organization}/logs/{log}"
1398-
* parent_type: "cloudresourcemanager.googleapis.com/Organization"
1399-
* parent_name_extractor: "organizations/{organization}"
1400-
* - pattern: "billingAccounts/{billing_account}/logs/{log}"
1401-
* parent_type: "billing.googleapis.com/BillingAccount"
1402-
* parent_name_extractor: "billingAccounts/{billing_account}"
1403-
* For flexible resources, the resource name doesn't contain parent names, but
1404-
* the resource itself has parents for policy evaluation.
1405-
* Example:
1406-
* message Shelf {
1407-
* option (google.api.resource) = {
1408-
* type: "library.googleapis.com/Shelf"
1409-
* name_descriptor: {
1410-
* pattern: "shelves/{shelf}"
1411-
* parent_type: "cloudresourcemanager.googleapis.com/Project"
1412-
* }
1413-
* name_descriptor: {
1414-
* pattern: "shelves/{shelf}"
1415-
* parent_type: "cloudresourcemanager.googleapis.com/Folder"
1416-
* }
1417-
* };
1418-
* }
1419-
* The ResourceDescriptor Yaml config will look like:
1420-
* resources:
1421-
* - type: 'library.googleapis.com/Shelf'
1422-
* name_descriptor:
1423-
* - pattern: "shelves/{shelf}"
1424-
* parent_type: "cloudresourcemanager.googleapis.com/Project"
1425-
* - pattern: "shelves/{shelf}"
1426-
* parent_type: "cloudresourcemanager.googleapis.com/Folder"
1311+
* pattern: "projects/{project}/logs/{log}"
1312+
* pattern: "folders/{folder}/logs/{log}"
1313+
* pattern: "organizations/{organization}/logs/{log}"
1314+
* pattern: "billingAccounts/{billing_account}/logs/{log}"
14271315
* </pre>
14281316
*
14291317
* Protobuf type {@code google.api.ResourceDescriptor}

‎proto-google-common-protos/src/main/proto/google/api/resource.proto‎

Lines changed: 10 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -57,22 +57,15 @@ extend google.protobuf.MessageOptions {
5757
// // For Kubernetes resources, the format is {api group}/{kind}.
5858
// option (google.api.resource) = {
5959
// type: "pubsub.googleapis.com/Topic"
60-
// name_descriptor: {
61-
// pattern: "projects/{project}/topics/{topic}"
62-
// parent_type: "cloudresourcemanager.googleapis.com/Project"
63-
// parent_name_extractor: "projects/{project}"
64-
// }
60+
// pattern: "projects/{project}/topics/{topic}"
6561
// };
6662
// }
6763
//
6864
// The ResourceDescriptor Yaml config will look like:
6965
//
7066
// resources:
7167
// - type: "pubsub.googleapis.com/Topic"
72-
// name_descriptor:
73-
// - pattern: "projects/{project}/topics/{topic}"
74-
// parent_type: "cloudresourcemanager.googleapis.com/Project"
75-
// parent_name_extractor: "projects/{project}"
68+
// pattern: "projects/{project}/topics/{topic}"
7669
//
7770
// Sometimes, resources have multiple patterns, typically because they can
7871
// live under multiple parents.
@@ -82,75 +75,21 @@ extend google.protobuf.MessageOptions {
8275
// message LogEntry {
8376
// option (google.api.resource) = {
8477
// type: "logging.googleapis.com/LogEntry"
85-
// name_descriptor: {
86-
// pattern: "projects/{project}/logs/{log}"
87-
// parent_type: "cloudresourcemanager.googleapis.com/Project"
88-
// parent_name_extractor: "projects/{project}"
89-
// }
90-
// name_descriptor: {
91-
// pattern: "folders/{folder}/logs/{log}"
92-
// parent_type: "cloudresourcemanager.googleapis.com/Folder"
93-
// parent_name_extractor: "folders/{folder}"
94-
// }
95-
// name_descriptor: {
96-
// pattern: "organizations/{organization}/logs/{log}"
97-
// parent_type: "cloudresourcemanager.googleapis.com/Organization"
98-
// parent_name_extractor: "organizations/{organization}"
99-
// }
100-
// name_descriptor: {
101-
// pattern: "billingAccounts/{billing_account}/logs/{log}"
102-
// parent_type: "billing.googleapis.com/BillingAccount"
103-
// parent_name_extractor: "billingAccounts/{billing_account}"
104-
// }
78+
// pattern: "projects/{project}/logs/{log}"
79+
// pattern: "folders/{folder}/logs/{log}"
80+
// pattern: "organizations/{organization}/logs/{log}"
81+
// pattern: "billingAccounts/{billing_account}/logs/{log}"
10582
// };
10683
// }
10784
//
10885
// The ResourceDescriptor Yaml config will look like:
10986
//
11087
// resources:
11188
// - type: 'logging.googleapis.com/LogEntry'
112-
// name_descriptor:
113-
// - pattern: "projects/{project}/logs/{log}"
114-
// parent_type: "cloudresourcemanager.googleapis.com/Project"
115-
// parent_name_extractor: "projects/{project}"
116-
// - pattern: "folders/{folder}/logs/{log}"
117-
// parent_type: "cloudresourcemanager.googleapis.com/Folder"
118-
// parent_name_extractor: "folders/{folder}"
119-
// - pattern: "organizations/{organization}/logs/{log}"
120-
// parent_type: "cloudresourcemanager.googleapis.com/Organization"
121-
// parent_name_extractor: "organizations/{organization}"
122-
// - pattern: "billingAccounts/{billing_account}/logs/{log}"
123-
// parent_type: "billing.googleapis.com/BillingAccount"
124-
// parent_name_extractor: "billingAccounts/{billing_account}"
125-
//
126-
// For flexible resources, the resource name doesn't contain parent names, but
127-
// the resource itself has parents for policy evaluation.
128-
//
129-
// Example:
130-
//
131-
// message Shelf {
132-
// option (google.api.resource) = {
133-
// type: "library.googleapis.com/Shelf"
134-
// name_descriptor: {
135-
// pattern: "shelves/{shelf}"
136-
// parent_type: "cloudresourcemanager.googleapis.com/Project"
137-
// }
138-
// name_descriptor: {
139-
// pattern: "shelves/{shelf}"
140-
// parent_type: "cloudresourcemanager.googleapis.com/Folder"
141-
// }
142-
// };
143-
// }
144-
//
145-
// The ResourceDescriptor Yaml config will look like:
146-
//
147-
// resources:
148-
// - type: 'library.googleapis.com/Shelf'
149-
// name_descriptor:
150-
// - pattern: "shelves/{shelf}"
151-
// parent_type: "cloudresourcemanager.googleapis.com/Project"
152-
// - pattern: "shelves/{shelf}"
153-
// parent_type: "cloudresourcemanager.googleapis.com/Folder"
89+
// pattern: "projects/{project}/logs/{log}"
90+
// pattern: "folders/{folder}/logs/{log}"
91+
// pattern: "organizations/{organization}/logs/{log}"
92+
// pattern: "billingAccounts/{billing_account}/logs/{log}"
15493
message ResourceDescriptor {
15594
// A description of the historical or future-looking state of the
15695
// resource pattern.

0 commit comments

Comments
 (0)