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

docs: fix docstring formatting #665

Merged
merged 2 commits into from Nov 6, 2021
Merged

docs: fix docstring formatting #665

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2acd4ac
docs: fix docstring formatting
gcf-owl-bot[bot] Nov 5, 2021
cd75e13
🦉 Updates from OwlBot
gcf-owl-bot[bot] Nov 5, 2021
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
4 changes: 2 additions & 2 deletions ...loud-resourcemanager/src/main/java/com/google/cloud/resourcemanager/v3/FoldersClient.java
View file
Open in desktop
Expand Up @@ -446,10 +446,10 @@ public final UnaryCallable<ListFoldersRequest, ListFoldersResponse> listFoldersC
* suffix wildcard symbol `&#42;`.
* <p>The `displayName` field in a query expression should use escaped quotes for values that
* include whitespace to prevent unexpected behavior.
* <p>| Field | Description |
* <p>``` | Field | Description |
* |-------------------------|----------------------------------------| | displayName |
* Filters by displayName. | | parent | Filters by parent (for example: folders/123). | |
* state, lifecycleState | Filters by state. |
* state, lifecycleState | Filters by state. | ```
* <p>Some example queries are:
* <ul>
* <li>Query `displayName=Test&#42;` returns Folder resources whose display name starts with
Expand Down
4 changes: 2 additions & 2 deletions ...esourcemanager/src/main/java/com/google/cloud/resourcemanager/v3/OrganizationsClient.java
View file
Open in desktop
Expand Up @@ -267,10 +267,10 @@ public final UnaryCallable<GetOrganizationRequest, Organization> getOrganization
*
* @param query Optional. An optional query string used to filter the Organizations to return in
* the response. Query rules are case-insensitive.
* <p>| Field | Description |
* <p>``` | Field | Description |
* |------------------|--------------------------------------------| | directoryCustomerId,
* owner.directoryCustomerId | Filters by directory customer id. | | domain | Filters by
* domain. |
* domain. | ```
* <p>Organizations may be queried by `directoryCustomerId` or by `domain`, where the domain
* is a G Suite domain, for example:
* <ul>
Expand Down
4 changes: 2 additions & 2 deletions ...oud-resourcemanager/src/main/java/com/google/cloud/resourcemanager/v3/ProjectsClient.java
View file
Open in desktop
Expand Up @@ -451,14 +451,14 @@ public final UnaryCallable<ListProjectsRequest, ListProjectsResponse> listProjec
* @param query Optional. A query string for searching for projects that the caller has
* `resourcemanager.projects.get` permission to. If multiple fields are included in the query,
* the it will return results that match any of the fields. Some eligible fields are:
* <p>| Field | Description |
* <p>``` | Field | Description |
* |-------------------------|----------------------------------------------| | displayName,
* name | Filters by displayName. | | parent | Project's parent. (for example: folders/123,
* organizations/&#42;) Prefer parent field over parent.type and parent.id. | | parent.type |
* Parent's type: `folder` or `organization`. | | parent.id | Parent's id number (for example:
* 123) | | id, projectId | Filters by projectId. | | state, lifecycleState | Filters by
* state. | | labels | Filters by label name or value. | | labels.&lt;key&gt; (where
* &#42;key&#42; is the name of a label) | Filters by label name. |
* &#42;key&#42; is the name of a label) | Filters by label name. | ```
* <p>Search expressions are case insensitive.
* <p>Some examples queries:
* <p>| Query | Description |
Expand Down
14 changes: 14 additions & 0 deletions ...rcemanager-v3/src/main/java/com/google/cloud/resourcemanager/v3/SearchFoldersRequest.java
View file
Open in desktop
Expand Up @@ -208,11 +208,13 @@ public com.google.protobuf.ByteString getPageTokenBytes() {
* can be used along with the suffix wildcard symbol `*`.
* The `displayName` field in a query expression should use escaped quotes
* for values that include whitespace to prevent unexpected behavior.
* ```
* | Field | Description |
* |-------------------------|----------------------------------------|
* | displayName | Filters by displayName. |
* | parent | Filters by parent (for example: folders/123). |
* | state, lifecycleState | Filters by state. |
* ```
* Some example queries are:
* * Query `displayName=Test*` returns Folder resources whose display name
* starts with "Test".
Expand Down Expand Up @@ -254,11 +256,13 @@ public java.lang.String getQuery() {
* can be used along with the suffix wildcard symbol `*`.
* The `displayName` field in a query expression should use escaped quotes
* for values that include whitespace to prevent unexpected behavior.
* ```
* | Field | Description |
* |-------------------------|----------------------------------------|
* | displayName | Filters by displayName. |
* | parent | Filters by parent (for example: folders/123). |
* | state, lifecycleState | Filters by state. |
* ```
* Some example queries are:
* * Query `displayName=Test*` returns Folder resources whose display name
* starts with "Test".
Expand Down Expand Up @@ -818,11 +822,13 @@ public Builder setPageTokenBytes(com.google.protobuf.ByteString value) {
* can be used along with the suffix wildcard symbol `*`.
* The `displayName` field in a query expression should use escaped quotes
* for values that include whitespace to prevent unexpected behavior.
* ```
* | Field | Description |
* |-------------------------|----------------------------------------|
* | displayName | Filters by displayName. |
* | parent | Filters by parent (for example: folders/123). |
* | state, lifecycleState | Filters by state. |
* ```
* Some example queries are:
* * Query `displayName=Test*` returns Folder resources whose display name
* starts with "Test".
Expand Down Expand Up @@ -863,11 +869,13 @@ public java.lang.String getQuery() {
* can be used along with the suffix wildcard symbol `*`.
* The `displayName` field in a query expression should use escaped quotes
* for values that include whitespace to prevent unexpected behavior.
* ```
* | Field | Description |
* |-------------------------|----------------------------------------|
* | displayName | Filters by displayName. |
* | parent | Filters by parent (for example: folders/123). |
* | state, lifecycleState | Filters by state. |
* ```
* Some example queries are:
* * Query `displayName=Test*` returns Folder resources whose display name
* starts with "Test".
Expand Down Expand Up @@ -908,11 +916,13 @@ public com.google.protobuf.ByteString getQueryBytes() {
* can be used along with the suffix wildcard symbol `*`.
* The `displayName` field in a query expression should use escaped quotes
* for values that include whitespace to prevent unexpected behavior.
* ```
* | Field | Description |
* |-------------------------|----------------------------------------|
* | displayName | Filters by displayName. |
* | parent | Filters by parent (for example: folders/123). |
* | state, lifecycleState | Filters by state. |
* ```
* Some example queries are:
* * Query `displayName=Test*` returns Folder resources whose display name
* starts with "Test".
Expand Down Expand Up @@ -952,11 +962,13 @@ public Builder setQuery(java.lang.String value) {
* can be used along with the suffix wildcard symbol `*`.
* The `displayName` field in a query expression should use escaped quotes
* for values that include whitespace to prevent unexpected behavior.
* ```
* | Field | Description |
* |-------------------------|----------------------------------------|
* | displayName | Filters by displayName. |
* | parent | Filters by parent (for example: folders/123). |
* | state, lifecycleState | Filters by state. |
* ```
* Some example queries are:
* * Query `displayName=Test*` returns Folder resources whose display name
* starts with "Test".
Expand Down Expand Up @@ -992,11 +1004,13 @@ public Builder clearQuery() {
* can be used along with the suffix wildcard symbol `*`.
* The `displayName` field in a query expression should use escaped quotes
* for values that include whitespace to prevent unexpected behavior.
* ```
* | Field | Description |
* |-------------------------|----------------------------------------|
* | displayName | Filters by displayName. |
* | parent | Filters by parent (for example: folders/123). |
* | state, lifecycleState | Filters by state. |
* ```
* Some example queries are:
* * Query `displayName=Test*` returns Folder resources whose display name
* starts with "Test".
Expand Down
4 changes: 4 additions & 0 deletions ...r-v3/src/main/java/com/google/cloud/resourcemanager/v3/SearchFoldersRequestOrBuilder.java
View file
Open in desktop
Expand Up @@ -76,11 +76,13 @@ public interface SearchFoldersRequestOrBuilder
* can be used along with the suffix wildcard symbol `*`.
* The `displayName` field in a query expression should use escaped quotes
* for values that include whitespace to prevent unexpected behavior.
* ```
* | Field | Description |
* |-------------------------|----------------------------------------|
* | displayName | Filters by displayName. |
* | parent | Filters by parent (for example: folders/123). |
* | state, lifecycleState | Filters by state. |
* ```
* Some example queries are:
* * Query `displayName=Test*` returns Folder resources whose display name
* starts with "Test".
Expand Down Expand Up @@ -111,11 +113,13 @@ public interface SearchFoldersRequestOrBuilder
* can be used along with the suffix wildcard symbol `*`.
* The `displayName` field in a query expression should use escaped quotes
* for values that include whitespace to prevent unexpected behavior.
* ```
* | Field | Description |
* |-------------------------|----------------------------------------|
* | displayName | Filters by displayName. |
* | parent | Filters by parent (for example: folders/123). |
* | state, lifecycleState | Filters by state. |
* ```
* Some example queries are:
* * Query `displayName=Test*` returns Folder resources whose display name
* starts with "Test".
Expand Down
14 changes: 14 additions & 0 deletions ...ager-v3/src/main/java/com/google/cloud/resourcemanager/v3/SearchOrganizationsRequest.java
View file
Open in desktop
Expand Up @@ -202,11 +202,13 @@ public com.google.protobuf.ByteString getPageTokenBytes() {
* <pre>
* Optional. An optional query string used to filter the Organizations to return in
* the response. Query rules are case-insensitive.
* ```
* | Field | Description |
* |------------------|--------------------------------------------|
* | directoryCustomerId, owner.directoryCustomerId | Filters by directory
* customer id. |
* | domain | Filters by domain. |
* ```
* Organizations may be queried by `directoryCustomerId` or by
* `domain`, where the domain is a G Suite domain, for example:
* * Query `directorycustomerid:123456789` returns Organization
Expand Down Expand Up @@ -237,11 +239,13 @@ public java.lang.String getQuery() {
* <pre>
* Optional. An optional query string used to filter the Organizations to return in
* the response. Query rules are case-insensitive.
* ```
* | Field | Description |
* |------------------|--------------------------------------------|
* | directoryCustomerId, owner.directoryCustomerId | Filters by directory
* customer id. |
* | domain | Filters by domain. |
* ```
* Organizations may be queried by `directoryCustomerId` or by
* `domain`, where the domain is a G Suite domain, for example:
* * Query `directorycustomerid:123456789` returns Organization
Expand Down Expand Up @@ -793,11 +797,13 @@ public Builder setPageTokenBytes(com.google.protobuf.ByteString value) {
* <pre>
* Optional. An optional query string used to filter the Organizations to return in
* the response. Query rules are case-insensitive.
* ```
* | Field | Description |
* |------------------|--------------------------------------------|
* | directoryCustomerId, owner.directoryCustomerId | Filters by directory
* customer id. |
* | domain | Filters by domain. |
* ```
* Organizations may be queried by `directoryCustomerId` or by
* `domain`, where the domain is a G Suite domain, for example:
* * Query `directorycustomerid:123456789` returns Organization
Expand Down Expand Up @@ -827,11 +833,13 @@ public java.lang.String getQuery() {
* <pre>
* Optional. An optional query string used to filter the Organizations to return in
* the response. Query rules are case-insensitive.
* ```
* | Field | Description |
* |------------------|--------------------------------------------|
* | directoryCustomerId, owner.directoryCustomerId | Filters by directory
* customer id. |
* | domain | Filters by domain. |
* ```
* Organizations may be queried by `directoryCustomerId` or by
* `domain`, where the domain is a G Suite domain, for example:
* * Query `directorycustomerid:123456789` returns Organization
Expand Down Expand Up @@ -861,11 +869,13 @@ public com.google.protobuf.ByteString getQueryBytes() {
* <pre>
* Optional. An optional query string used to filter the Organizations to return in
* the response. Query rules are case-insensitive.
* ```
* | Field | Description |
* |------------------|--------------------------------------------|
* | directoryCustomerId, owner.directoryCustomerId | Filters by directory
* customer id. |
* | domain | Filters by domain. |
* ```
* Organizations may be queried by `directoryCustomerId` or by
* `domain`, where the domain is a G Suite domain, for example:
* * Query `directorycustomerid:123456789` returns Organization
Expand Down Expand Up @@ -894,11 +904,13 @@ public Builder setQuery(java.lang.String value) {
* <pre>
* Optional. An optional query string used to filter the Organizations to return in
* the response. Query rules are case-insensitive.
* ```
* | Field | Description |
* |------------------|--------------------------------------------|
* | directoryCustomerId, owner.directoryCustomerId | Filters by directory
* customer id. |
* | domain | Filters by domain. |
* ```
* Organizations may be queried by `directoryCustomerId` or by
* `domain`, where the domain is a G Suite domain, for example:
* * Query `directorycustomerid:123456789` returns Organization
Expand All @@ -923,11 +935,13 @@ public Builder clearQuery() {
* <pre>
* Optional. An optional query string used to filter the Organizations to return in
* the response. Query rules are case-insensitive.
* ```
* | Field | Description |
* |------------------|--------------------------------------------|
* | directoryCustomerId, owner.directoryCustomerId | Filters by directory
* customer id. |
* | domain | Filters by domain. |
* ```
* Organizations may be queried by `directoryCustomerId` or by
* `domain`, where the domain is a G Suite domain, for example:
* * Query `directorycustomerid:123456789` returns Organization
Expand Down
4 changes: 4 additions & 0 deletions ...rc/main/java/com/google/cloud/resourcemanager/v3/SearchOrganizationsRequestOrBuilder.java
View file
Open in desktop
Expand Up @@ -70,11 +70,13 @@ public interface SearchOrganizationsRequestOrBuilder
* <pre>
* Optional. An optional query string used to filter the Organizations to return in
* the response. Query rules are case-insensitive.
* ```
* | Field | Description |
* |------------------|--------------------------------------------|
* | directoryCustomerId, owner.directoryCustomerId | Filters by directory
* customer id. |
* | domain | Filters by domain. |
* ```
* Organizations may be queried by `directoryCustomerId` or by
* `domain`, where the domain is a G Suite domain, for example:
* * Query `directorycustomerid:123456789` returns Organization
Expand All @@ -94,11 +96,13 @@ public interface SearchOrganizationsRequestOrBuilder
* <pre>
* Optional. An optional query string used to filter the Organizations to return in
* the response. Query rules are case-insensitive.
* ```
* | Field | Description |
* |------------------|--------------------------------------------|
* | directoryCustomerId, owner.directoryCustomerId | Filters by directory
* customer id. |
* | domain | Filters by domain. |
* ```
* Organizations may be queried by `directoryCustomerId` or by
* `domain`, where the domain is a G Suite domain, for example:
* * Query `directorycustomerid:123456789` returns Organization
Expand Down