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

Commit 0016405

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
docs: fix docstring formatting (#665)
- [ ] Regenerate this pull request now. Committer: @parthea PiperOrigin-RevId: 407854413 Source-Link: googleapis/googleapis@f81b7bd Source-Link: https://github.com/googleapis/googleapis-gen/commit/1f0cfde5514fae024c673b6798174ab6727cb0a5 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMWYwY2ZkZTU1MTRmYWUwMjRjNjczYjY3OTgxNzRhYjY3MjdjYjBhNSJ9
1 parent 0410544 commit 0016405

File tree

12 files changed

+66
-7
lines changed

12 files changed

+66
-7
lines changed

‎google-cloud-resourcemanager/src/main/java/com/google/cloud/resourcemanager/v3/FoldersClient.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -446,10 +446,10 @@ public final UnaryCallable<ListFoldersRequest, ListFoldersResponse> listFoldersC
446446
* suffix wildcard symbol `&#42;`.
447447
* <p>The `displayName` field in a query expression should use escaped quotes for values that
448448
* include whitespace to prevent unexpected behavior.
449-
* <p>| Field | Description |
449+
* <p>``` | Field | Description |
450450
* |-------------------------|----------------------------------------| | displayName |
451451
* Filters by displayName. | | parent | Filters by parent (for example: folders/123). | |
452-
* state, lifecycleState | Filters by state. |
452+
* state, lifecycleState | Filters by state. | ```
453453
* <p>Some example queries are:
454454
* <ul>
455455
* <li>Query `displayName=Test&#42;` returns Folder resources whose display name starts with

‎google-cloud-resourcemanager/src/main/java/com/google/cloud/resourcemanager/v3/OrganizationsClient.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -267,10 +267,10 @@ public final UnaryCallable<GetOrganizationRequest, Organization> getOrganization
267267
*
268268
* @param query Optional. An optional query string used to filter the Organizations to return in
269269
* the response. Query rules are case-insensitive.
270-
* <p>| Field | Description |
270+
* <p>``` | Field | Description |
271271
* |------------------|--------------------------------------------| | directoryCustomerId,
272272
* owner.directoryCustomerId | Filters by directory customer id. | | domain | Filters by
273-
* domain. |
273+
* domain. | ```
274274
* <p>Organizations may be queried by `directoryCustomerId` or by `domain`, where the domain
275275
* is a G Suite domain, for example:
276276
* <ul>

‎google-cloud-resourcemanager/src/main/java/com/google/cloud/resourcemanager/v3/ProjectsClient.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -451,14 +451,14 @@ public final UnaryCallable<ListProjectsRequest, ListProjectsResponse> listProjec
451451
* @param query Optional. A query string for searching for projects that the caller has
452452
* `resourcemanager.projects.get` permission to. If multiple fields are included in the query,
453453
* the it will return results that match any of the fields. Some eligible fields are:
454-
* <p>| Field | Description |
454+
* <p>``` | Field | Description |
455455
* |-------------------------|----------------------------------------------| | displayName,
456456
* name | Filters by displayName. | | parent | Project's parent. (for example: folders/123,
457457
* organizations/&#42;) Prefer parent field over parent.type and parent.id. | | parent.type |
458458
* Parent's type: `folder` or `organization`. | | parent.id | Parent's id number (for example:
459459
* 123) | | id, projectId | Filters by projectId. | | state, lifecycleState | Filters by
460460
* state. | | labels | Filters by label name or value. | | labels.&lt;key&gt; (where
461-
* &#42;key&#42; is the name of a label) | Filters by label name. |
461+
* &#42;key&#42; is the name of a label) | Filters by label name. | ```
462462
* <p>Search expressions are case insensitive.
463463
* <p>Some examples queries:
464464
* <p>| Query | Description |

‎proto-google-cloud-resourcemanager-v3/src/main/java/com/google/cloud/resourcemanager/v3/SearchFoldersRequest.java‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -208,11 +208,13 @@ public com.google.protobuf.ByteString getPageTokenBytes() {
208208
* can be used along with the suffix wildcard symbol `*`.
209209
* The `displayName` field in a query expression should use escaped quotes
210210
* for values that include whitespace to prevent unexpected behavior.
211+
* ```
211212
* | Field | Description |
212213
* |-------------------------|----------------------------------------|
213214
* | displayName | Filters by displayName. |
214215
* | parent | Filters by parent (for example: folders/123). |
215216
* | state, lifecycleState | Filters by state. |
217+
* ```
216218
* Some example queries are:
217219
* * Query `displayName=Test*` returns Folder resources whose display name
218220
* starts with "Test".
@@ -254,11 +256,13 @@ public java.lang.String getQuery() {
254256
* can be used along with the suffix wildcard symbol `*`.
255257
* The `displayName` field in a query expression should use escaped quotes
256258
* for values that include whitespace to prevent unexpected behavior.
259+
* ```
257260
* | Field | Description |
258261
* |-------------------------|----------------------------------------|
259262
* | displayName | Filters by displayName. |
260263
* | parent | Filters by parent (for example: folders/123). |
261264
* | state, lifecycleState | Filters by state. |
265+
* ```
262266
* Some example queries are:
263267
* * Query `displayName=Test*` returns Folder resources whose display name
264268
* starts with "Test".
@@ -818,11 +822,13 @@ public Builder setPageTokenBytes(com.google.protobuf.ByteString value) {
818822
* can be used along with the suffix wildcard symbol `*`.
819823
* The `displayName` field in a query expression should use escaped quotes
820824
* for values that include whitespace to prevent unexpected behavior.
825+
* ```
821826
* | Field | Description |
822827
* |-------------------------|----------------------------------------|
823828
* | displayName | Filters by displayName. |
824829
* | parent | Filters by parent (for example: folders/123). |
825830
* | state, lifecycleState | Filters by state. |
831+
* ```
826832
* Some example queries are:
827833
* * Query `displayName=Test*` returns Folder resources whose display name
828834
* starts with "Test".
@@ -863,11 +869,13 @@ public java.lang.String getQuery() {
863869
* can be used along with the suffix wildcard symbol `*`.
864870
* The `displayName` field in a query expression should use escaped quotes
865871
* for values that include whitespace to prevent unexpected behavior.
872+
* ```
866873
* | Field | Description |
867874
* |-------------------------|----------------------------------------|
868875
* | displayName | Filters by displayName. |
869876
* | parent | Filters by parent (for example: folders/123). |
870877
* | state, lifecycleState | Filters by state. |
878+
* ```
871879
* Some example queries are:
872880
* * Query `displayName=Test*` returns Folder resources whose display name
873881
* starts with "Test".
@@ -908,11 +916,13 @@ public com.google.protobuf.ByteString getQueryBytes() {
908916
* can be used along with the suffix wildcard symbol `*`.
909917
* The `displayName` field in a query expression should use escaped quotes
910918
* for values that include whitespace to prevent unexpected behavior.
919+
* ```
911920
* | Field | Description |
912921
* |-------------------------|----------------------------------------|
913922
* | displayName | Filters by displayName. |
914923
* | parent | Filters by parent (for example: folders/123). |
915924
* | state, lifecycleState | Filters by state. |
925+
* ```
916926
* Some example queries are:
917927
* * Query `displayName=Test*` returns Folder resources whose display name
918928
* starts with "Test".
@@ -952,11 +962,13 @@ public Builder setQuery(java.lang.String value) {
952962
* can be used along with the suffix wildcard symbol `*`.
953963
* The `displayName` field in a query expression should use escaped quotes
954964
* for values that include whitespace to prevent unexpected behavior.
965+
* ```
955966
* | Field | Description |
956967
* |-------------------------|----------------------------------------|
957968
* | displayName | Filters by displayName. |
958969
* | parent | Filters by parent (for example: folders/123). |
959970
* | state, lifecycleState | Filters by state. |
971+
* ```
960972
* Some example queries are:
961973
* * Query `displayName=Test*` returns Folder resources whose display name
962974
* starts with "Test".
@@ -992,11 +1004,13 @@ public Builder clearQuery() {
9921004
* can be used along with the suffix wildcard symbol `*`.
9931005
* The `displayName` field in a query expression should use escaped quotes
9941006
* for values that include whitespace to prevent unexpected behavior.
1007+
* ```
9951008
* | Field | Description |
9961009
* |-------------------------|----------------------------------------|
9971010
* | displayName | Filters by displayName. |
9981011
* | parent | Filters by parent (for example: folders/123). |
9991012
* | state, lifecycleState | Filters by state. |
1013+
* ```
10001014
* Some example queries are:
10011015
* * Query `displayName=Test*` returns Folder resources whose display name
10021016
* starts with "Test".

‎proto-google-cloud-resourcemanager-v3/src/main/java/com/google/cloud/resourcemanager/v3/SearchFoldersRequestOrBuilder.java‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,11 +76,13 @@ public interface SearchFoldersRequestOrBuilder
7676
* can be used along with the suffix wildcard symbol `*`.
7777
* The `displayName` field in a query expression should use escaped quotes
7878
* for values that include whitespace to prevent unexpected behavior.
79+
* ```
7980
* | Field | Description |
8081
* |-------------------------|----------------------------------------|
8182
* | displayName | Filters by displayName. |
8283
* | parent | Filters by parent (for example: folders/123). |
8384
* | state, lifecycleState | Filters by state. |
85+
* ```
8486
* Some example queries are:
8587
* * Query `displayName=Test*` returns Folder resources whose display name
8688
* starts with "Test".
@@ -111,11 +113,13 @@ public interface SearchFoldersRequestOrBuilder
111113
* can be used along with the suffix wildcard symbol `*`.
112114
* The `displayName` field in a query expression should use escaped quotes
113115
* for values that include whitespace to prevent unexpected behavior.
116+
* ```
114117
* | Field | Description |
115118
* |-------------------------|----------------------------------------|
116119
* | displayName | Filters by displayName. |
117120
* | parent | Filters by parent (for example: folders/123). |
118121
* | state, lifecycleState | Filters by state. |
122+
* ```
119123
* Some example queries are:
120124
* * Query `displayName=Test*` returns Folder resources whose display name
121125
* starts with "Test".

‎proto-google-cloud-resourcemanager-v3/src/main/java/com/google/cloud/resourcemanager/v3/SearchOrganizationsRequest.java‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -202,11 +202,13 @@ public com.google.protobuf.ByteString getPageTokenBytes() {
202202
* <pre>
203203
* Optional. An optional query string used to filter the Organizations to return in
204204
* the response. Query rules are case-insensitive.
205+
* ```
205206
* | Field | Description |
206207
* |------------------|--------------------------------------------|
207208
* | directoryCustomerId, owner.directoryCustomerId | Filters by directory
208209
* customer id. |
209210
* | domain | Filters by domain. |
211+
* ```
210212
* Organizations may be queried by `directoryCustomerId` or by
211213
* `domain`, where the domain is a G Suite domain, for example:
212214
* * Query `directorycustomerid:123456789` returns Organization
@@ -237,11 +239,13 @@ public java.lang.String getQuery() {
237239
* <pre>
238240
* Optional. An optional query string used to filter the Organizations to return in
239241
* the response. Query rules are case-insensitive.
242+
* ```
240243
* | Field | Description |
241244
* |------------------|--------------------------------------------|
242245
* | directoryCustomerId, owner.directoryCustomerId | Filters by directory
243246
* customer id. |
244247
* | domain | Filters by domain. |
248+
* ```
245249
* Organizations may be queried by `directoryCustomerId` or by
246250
* `domain`, where the domain is a G Suite domain, for example:
247251
* * Query `directorycustomerid:123456789` returns Organization
@@ -793,11 +797,13 @@ public Builder setPageTokenBytes(com.google.protobuf.ByteString value) {
793797
* <pre>
794798
* Optional. An optional query string used to filter the Organizations to return in
795799
* the response. Query rules are case-insensitive.
800+
* ```
796801
* | Field | Description |
797802
* |------------------|--------------------------------------------|
798803
* | directoryCustomerId, owner.directoryCustomerId | Filters by directory
799804
* customer id. |
800805
* | domain | Filters by domain. |
806+
* ```
801807
* Organizations may be queried by `directoryCustomerId` or by
802808
* `domain`, where the domain is a G Suite domain, for example:
803809
* * Query `directorycustomerid:123456789` returns Organization
@@ -827,11 +833,13 @@ public java.lang.String getQuery() {
827833
* <pre>
828834
* Optional. An optional query string used to filter the Organizations to return in
829835
* the response. Query rules are case-insensitive.
836+
* ```
830837
* | Field | Description |
831838
* |------------------|--------------------------------------------|
832839
* | directoryCustomerId, owner.directoryCustomerId | Filters by directory
833840
* customer id. |
834841
* | domain | Filters by domain. |
842+
* ```
835843
* Organizations may be queried by `directoryCustomerId` or by
836844
* `domain`, where the domain is a G Suite domain, for example:
837845
* * Query `directorycustomerid:123456789` returns Organization
@@ -861,11 +869,13 @@ public com.google.protobuf.ByteString getQueryBytes() {
861869
* <pre>
862870
* Optional. An optional query string used to filter the Organizations to return in
863871
* the response. Query rules are case-insensitive.
872+
* ```
864873
* | Field | Description |
865874
* |------------------|--------------------------------------------|
866875
* | directoryCustomerId, owner.directoryCustomerId | Filters by directory
867876
* customer id. |
868877
* | domain | Filters by domain. |
878+
* ```
869879
* Organizations may be queried by `directoryCustomerId` or by
870880
* `domain`, where the domain is a G Suite domain, for example:
871881
* * Query `directorycustomerid:123456789` returns Organization
@@ -894,11 +904,13 @@ public Builder setQuery(java.lang.String value) {
894904
* <pre>
895905
* Optional. An optional query string used to filter the Organizations to return in
896906
* the response. Query rules are case-insensitive.
907+
* ```
897908
* | Field | Description |
898909
* |------------------|--------------------------------------------|
899910
* | directoryCustomerId, owner.directoryCustomerId | Filters by directory
900911
* customer id. |
901912
* | domain | Filters by domain. |
913+
* ```
902914
* Organizations may be queried by `directoryCustomerId` or by
903915
* `domain`, where the domain is a G Suite domain, for example:
904916
* * Query `directorycustomerid:123456789` returns Organization
@@ -923,11 +935,13 @@ public Builder clearQuery() {
923935
* <pre>
924936
* Optional. An optional query string used to filter the Organizations to return in
925937
* the response. Query rules are case-insensitive.
938+
* ```
926939
* | Field | Description |
927940
* |------------------|--------------------------------------------|
928941
* | directoryCustomerId, owner.directoryCustomerId | Filters by directory
929942
* customer id. |
930943
* | domain | Filters by domain. |
944+
* ```
931945
* Organizations may be queried by `directoryCustomerId` or by
932946
* `domain`, where the domain is a G Suite domain, for example:
933947
* * Query `directorycustomerid:123456789` returns Organization

‎proto-google-cloud-resourcemanager-v3/src/main/java/com/google/cloud/resourcemanager/v3/SearchOrganizationsRequestOrBuilder.java‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,11 +70,13 @@ public interface SearchOrganizationsRequestOrBuilder
7070
* <pre>
7171
* Optional. An optional query string used to filter the Organizations to return in
7272
* the response. Query rules are case-insensitive.
73+
* ```
7374
* | Field | Description |
7475
* |------------------|--------------------------------------------|
7576
* | directoryCustomerId, owner.directoryCustomerId | Filters by directory
7677
* customer id. |
7778
* | domain | Filters by domain. |
79+
* ```
7880
* Organizations may be queried by `directoryCustomerId` or by
7981
* `domain`, where the domain is a G Suite domain, for example:
8082
* * Query `directorycustomerid:123456789` returns Organization
@@ -94,11 +96,13 @@ public interface SearchOrganizationsRequestOrBuilder
9496
* <pre>
9597
* Optional. An optional query string used to filter the Organizations to return in
9698
* the response. Query rules are case-insensitive.
99+
* ```
97100
* | Field | Description |
98101
* |------------------|--------------------------------------------|
99102
* | directoryCustomerId, owner.directoryCustomerId | Filters by directory
100103
* customer id. |
101104
* | domain | Filters by domain. |
105+
* ```
102106
* Organizations may be queried by `directoryCustomerId` or by
103107
* `domain`, where the domain is a G Suite domain, for example:
104108
* * Query `directorycustomerid:123456789` returns Organization

0 commit comments

Comments
 (0)