docs: [cloudresourcemanager] Update formatting for Purpose class do…

…cumentation (#9395) - [ ] Regenerate this pull request now. docs: Add documentation for additional acceptable formats for `namespaced_tag_key` and `namespaced_tag_value`in `EffectiveTag`, `parent` in `ListTagKeysRequest`, `parent` in `TagKey`, and `namespaced_name` in `TagValue` PiperOrigin-RevId: 529262150 Source-Link: https://togithub.com/googleapis/googleapis/commit/e6c8485d04a800238b6c6c3a57dd3fe51b03ac77 Source-Link: https://togithub.com/googleapis/googleapis-gen/commit/e3b832fc91e0fb8308b13fd723fe82cdc826eb43 Copy-Tag: eyJwIjoiamF2YS1yZXNvdXJjZW1hbmFnZXIvLk93bEJvdC55YW1sIiwiaCI6ImUzYjgzMmZjOTFlMGZiODMwOGIxM2ZkNzIzZmU4MmNkYzgyNmViNDMifQ== BEGIN_NESTED_COMMIT docs: [cloudresourcemanager] Update the table format in SearchProjects docs PiperOrigin-RevId: 528006710 Source-Link: https://togithub.com/googleapis/googleapis/commit/f373a9c06981f8dbbf2dc6e7132590ae96ffb30a Source-Link: https://togithub.com/googleapis/googleapis-gen/commit/28c21588edaf35c73af68bbb86d89713de748c7b Copy-Tag: eyJwIjoiamF2YS1yZXNvdXJjZW1hbmFnZXIvLk93bEJvdC55YW1sIiwiaCI6IjI4YzIxNTg4ZWRhZjM1YzczYWY2OGJiYjg2ZDg5NzEzZGU3NDhjN2IifQ== END_NESTED_COMMIT
googleapis · May 9, 2023 · 9cf11de · 9cf11de
1 parent 3c9e001
commit 9cf11de
Show file tree

Hide file tree

Showing 18 changed files with 459 additions and 450 deletions.
diff --git a/java-resourcemanager/README.md b/java-resourcemanager/README.md
@@ -20,7 +20,7 @@ If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file:
     <dependency>
       <groupId>com.google.cloud</groupId>
       <artifactId>libraries-bom</artifactId>
-      <version>26.12.0</version>
+      <version>26.14.0</version>
       <type>pom</type>
       <scope>import</scope>
     </dependency>
@@ -336,7 +336,7 @@ Java is a registered trademark of Oracle and/or its affiliates.
 [kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java11.html
 [stability-image]: https://img.shields.io/badge/stability-stable-green
 [maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-resourcemanager.svg
-[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-resourcemanager/1.17.0
+[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-resourcemanager/1.18.0
 [authentication]: https://github.com/googleapis/google-cloud-java#authentication
 [auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes
 [predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles

diff --git a/...oud-resourcemanager/src/main/java/com/google/cloud/resourcemanager/v3/ProjectsClient.java b/...oud-resourcemanager/src/main/java/com/google/cloud/resourcemanager/v3/ProjectsClient.java
@@ -542,23 +542,24 @@ 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,
    *     then it will return results that match any of the fields. Some eligible fields are:
-   *     <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.| ```
+   *     <p>- &#42;&#42;`displayName`, `name`&#42;&#42;: Filters by displayName. -
+   *     &#42;&#42;`parent`&#42;&#42;: Project's parent (for example: `folders/123`,
+   *     `organizations/&#42;`). Prefer `parent` field over `parent.type` and `parent.id`. -
+   *     &#42;&#42;`parent.type`&#42;&#42;: Parent's type: `folder` or `organization`. -
+   *     &#42;&#42;`parent.id`&#42;&#42;: Parent's id number (for example: `123`). - &#42;&#42;`id`,
+   *     `projectId`&#42;&#42;: Filters by projectId. - &#42;&#42;`state`,
+   *     `lifecycleState`&#42;&#42;: Filters by state. - &#42;&#42;`labels`&#42;&#42;: Filters by
+   *     label name or value. - &#42;&#42;`labels.&lt;key&gt;` (where `&lt;key&gt;` is the name of a
+   *     label)&#42;&#42;: Filters by label name.
    *     <p>Search expressions are case insensitive.
    *     <p>Some examples queries:
-   *     <p>``` | Query | Description |
-   *     |------------------|-----------------------------------------------------| | name:how&#42;
-   *     | The project's name starts with "how". | | name:Howl | The project's name is `Howl` or
-   *     `howl`. | | name:HOWL | Equivalent to above. | | NAME:howl | Equivalent to above. | |
-   *     labels.color:&#42; | The project has the label `color`. | | labels.color:red | The
-   *     project's label `color` has the value `red`. | | labels.color:red labels.size:big | The
-   *     project's label `color` has the value `red` or its label `size` has the value `big`. | ```
+   *     <p>- &#42;&#42;`name:how&#42;`&#42;&#42;: The project's name starts with "how". -
+   *     &#42;&#42;`name:Howl`&#42;&#42;: The project's name is `Howl` or `howl`. -
+   *     &#42;&#42;`name:HOWL`&#42;&#42;: Equivalent to above. - &#42;&#42;`NAME:howl`&#42;&#42;:
+   *     Equivalent to above. - &#42;&#42;`labels.color:&#42;`&#42;&#42;: The project has the label
+   *     `color`. - &#42;&#42;`labels.color:red`&#42;&#42;: The project's label `color` has the
+   *     value `red`. - &#42;&#42;`labels.color:red labels.size:big`&#42;&#42;: The project's label
+   *     `color` has the value `red` or its label `size` has the value `big`.
    *     <p>If no query is specified, the call will return projects for which the user has the
    *     `resourcemanager.projects.get` permission.
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails

diff --git a/...loud-resourcemanager/src/main/java/com/google/cloud/resourcemanager/v3/TagKeysClient.java b/...loud-resourcemanager/src/main/java/com/google/cloud/resourcemanager/v3/TagKeysClient.java
@@ -224,8 +224,8 @@ public final OperationsClient getHttpJsonOperationsClient() {
    * }
    * }</pre>
    *
-   * @param parent Required. The resource name of the new TagKey's parent. Must be of the form
-   *     `folders/{folder_id}` or `organizations/{org_id}`.
+   * @param parent Required. The resource name of the TagKey's parent. Must be of the form
+   *     `organizations/{org_id}` or `projects/{project_id}` or `projects/{project_number}`
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
    */
   public final ListTagKeysPagedResponse listTagKeys(ResourceName parent) {
@@ -256,8 +256,8 @@ public final ListTagKeysPagedResponse listTagKeys(ResourceName parent) {
    * }
    * }</pre>
    *
-   * @param parent Required. The resource name of the new TagKey's parent. Must be of the form
-   *     `folders/{folder_id}` or `organizations/{org_id}`.
+   * @param parent Required. The resource name of the TagKey's parent. Must be of the form
+   *     `organizations/{org_id}` or `projects/{project_id}` or `projects/{project_number}`
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
    */
   public final ListTagKeysPagedResponse listTagKeys(String parent) {

diff --git a/...ud-resourcemanager-v3/src/main/java/com/google/cloud/resourcemanager/v3/EffectiveTag.java b/...ud-resourcemanager-v3/src/main/java/com/google/cloud/resourcemanager/v3/EffectiveTag.java
@@ -134,9 +134,10 @@ public com.google.protobuf.ByteString getTagValueBytes() {
    *
    *
    * <pre>
-   * Namespaced name of the TagValue. Now only supported in the format
-   * `{organization_id}/{tag_key_short_name}/{tag_value_short_name}`.
-   * Other formats will be supported when we add non-org parented tags.
+   * The namespaced name of the TagValue. Can be in the form
+   * `{organization_id}/{tag_key_short_name}/{tag_value_short_name}` or
+   * `{project_id}/{tag_key_short_name}/{tag_value_short_name}` or
+   * `{project_number}/{tag_key_short_name}/{tag_value_short_name}`.
    * </pre>
    *
    * <code>string namespaced_tag_value = 2;</code>
@@ -159,9 +160,10 @@ public java.lang.String getNamespacedTagValue() {
    *
    *
    * <pre>
-   * Namespaced name of the TagValue. Now only supported in the format
-   * `{organization_id}/{tag_key_short_name}/{tag_value_short_name}`.
-   * Other formats will be supported when we add non-org parented tags.
+   * The namespaced name of the TagValue. Can be in the form
+   * `{organization_id}/{tag_key_short_name}/{tag_value_short_name}` or
+   * `{project_id}/{tag_key_short_name}/{tag_value_short_name}` or
+   * `{project_number}/{tag_key_short_name}/{tag_value_short_name}`.
    * </pre>
    *
    * <code>string namespaced_tag_value = 2;</code>
@@ -242,9 +244,10 @@ public com.google.protobuf.ByteString getTagKeyBytes() {
    *
    *
    * <pre>
-   * The namespaced_name of the TagKey. Now only supported in the format of
-   * `{organization_id}/{tag_key_short_name}`. Other formats will be
-   * supported when we add non-org parented tags.
+   * The namespaced name of the TagKey. Can be in the form
+   * `{organization_id}/{tag_key_short_name}` or
+   * `{project_id}/{tag_key_short_name}` or
+   * `{project_number}/{tag_key_short_name}`.
    * </pre>
    *
    * <code>string namespaced_tag_key = 4;</code>
@@ -267,9 +270,10 @@ public java.lang.String getNamespacedTagKey() {
    *
    *
    * <pre>
-   * The namespaced_name of the TagKey. Now only supported in the format of
-   * `{organization_id}/{tag_key_short_name}`. Other formats will be
-   * supported when we add non-org parented tags.
+   * The namespaced name of the TagKey. Can be in the form
+   * `{organization_id}/{tag_key_short_name}` or
+   * `{project_id}/{tag_key_short_name}` or
+   * `{project_number}/{tag_key_short_name}`.
    * </pre>
    *
    * <code>string namespaced_tag_key = 4;</code>
@@ -298,7 +302,8 @@ public com.google.protobuf.ByteString getNamespacedTagKeyBytes() {
    *
    * <pre>
    * The parent name of the tag key.
-   * Must be in the format `organizations/{organization_id}`.
+   * Must be in the format `organizations/{organization_id}` or
+   * `projects/{project_number}`
    * </pre>
    *
    * <code>string tag_key_parent_name = 6;</code>
@@ -322,7 +327,8 @@ public java.lang.String getTagKeyParentName() {
    *
    * <pre>
    * The parent name of the tag key.
-   * Must be in the format `organizations/{organization_id}`.
+   * Must be in the format `organizations/{organization_id}` or
+   * `projects/{project_number}`
    * </pre>
    *
    * <code>string tag_key_parent_name = 6;</code>
@@ -938,9 +944,10 @@ public Builder setTagValueBytes(com.google.protobuf.ByteString value) {
      *
      *
      * <pre>
-     * Namespaced name of the TagValue. Now only supported in the format
-     * `{organization_id}/{tag_key_short_name}/{tag_value_short_name}`.
-     * Other formats will be supported when we add non-org parented tags.
+     * The namespaced name of the TagValue. Can be in the form
+     * `{organization_id}/{tag_key_short_name}/{tag_value_short_name}` or
+     * `{project_id}/{tag_key_short_name}/{tag_value_short_name}` or
+     * `{project_number}/{tag_key_short_name}/{tag_value_short_name}`.
      * </pre>
      *
      * <code>string namespaced_tag_value = 2;</code>
@@ -962,9 +969,10 @@ public java.lang.String getNamespacedTagValue() {
      *
      *
      * <pre>
-     * Namespaced name of the TagValue. Now only supported in the format
-     * `{organization_id}/{tag_key_short_name}/{tag_value_short_name}`.
-     * Other formats will be supported when we add non-org parented tags.
+     * The namespaced name of the TagValue. Can be in the form
+     * `{organization_id}/{tag_key_short_name}/{tag_value_short_name}` or
+     * `{project_id}/{tag_key_short_name}/{tag_value_short_name}` or
+     * `{project_number}/{tag_key_short_name}/{tag_value_short_name}`.
      * </pre>
      *
      * <code>string namespaced_tag_value = 2;</code>
@@ -986,9 +994,10 @@ public com.google.protobuf.ByteString getNamespacedTagValueBytes() {
      *
      *
      * <pre>
-     * Namespaced name of the TagValue. Now only supported in the format
-     * `{organization_id}/{tag_key_short_name}/{tag_value_short_name}`.
-     * Other formats will be supported when we add non-org parented tags.
+     * The namespaced name of the TagValue. Can be in the form
+     * `{organization_id}/{tag_key_short_name}/{tag_value_short_name}` or
+     * `{project_id}/{tag_key_short_name}/{tag_value_short_name}` or
+     * `{project_number}/{tag_key_short_name}/{tag_value_short_name}`.
      * </pre>
      *
      * <code>string namespaced_tag_value = 2;</code>
@@ -1009,9 +1018,10 @@ public Builder setNamespacedTagValue(java.lang.String value) {
      *
      *
      * <pre>
-     * Namespaced name of the TagValue. Now only supported in the format
-     * `{organization_id}/{tag_key_short_name}/{tag_value_short_name}`.
-     * Other formats will be supported when we add non-org parented tags.
+     * The namespaced name of the TagValue. Can be in the form
+     * `{organization_id}/{tag_key_short_name}/{tag_value_short_name}` or
+     * `{project_id}/{tag_key_short_name}/{tag_value_short_name}` or
+     * `{project_number}/{tag_key_short_name}/{tag_value_short_name}`.
      * </pre>
      *
      * <code>string namespaced_tag_value = 2;</code>
@@ -1028,9 +1038,10 @@ public Builder clearNamespacedTagValue() {
      *
      *
      * <pre>
-     * Namespaced name of the TagValue. Now only supported in the format
-     * `{organization_id}/{tag_key_short_name}/{tag_value_short_name}`.
-     * Other formats will be supported when we add non-org parented tags.
+     * The namespaced name of the TagValue. Can be in the form
+     * `{organization_id}/{tag_key_short_name}/{tag_value_short_name}` or
+     * `{project_id}/{tag_key_short_name}/{tag_value_short_name}` or
+     * `{project_number}/{tag_key_short_name}/{tag_value_short_name}`.
      * </pre>
      *
      * <code>string namespaced_tag_value = 2;</code>
@@ -1165,9 +1176,10 @@ public Builder setTagKeyBytes(com.google.protobuf.ByteString value) {
      *
      *
      * <pre>
-     * The namespaced_name of the TagKey. Now only supported in the format of
-     * `{organization_id}/{tag_key_short_name}`. Other formats will be
-     * supported when we add non-org parented tags.
+     * The namespaced name of the TagKey. Can be in the form
+     * `{organization_id}/{tag_key_short_name}` or
+     * `{project_id}/{tag_key_short_name}` or
+     * `{project_number}/{tag_key_short_name}`.
      * </pre>
      *
      * <code>string namespaced_tag_key = 4;</code>
@@ -1189,9 +1201,10 @@ public java.lang.String getNamespacedTagKey() {
      *
      *
      * <pre>
-     * The namespaced_name of the TagKey. Now only supported in the format of
-     * `{organization_id}/{tag_key_short_name}`. Other formats will be
-     * supported when we add non-org parented tags.
+     * The namespaced name of the TagKey. Can be in the form
+     * `{organization_id}/{tag_key_short_name}` or
+     * `{project_id}/{tag_key_short_name}` or
+     * `{project_number}/{tag_key_short_name}`.
      * </pre>
      *
      * <code>string namespaced_tag_key = 4;</code>
@@ -1213,9 +1226,10 @@ public com.google.protobuf.ByteString getNamespacedTagKeyBytes() {
      *
      *
      * <pre>
-     * The namespaced_name of the TagKey. Now only supported in the format of
-     * `{organization_id}/{tag_key_short_name}`. Other formats will be
-     * supported when we add non-org parented tags.
+     * The namespaced name of the TagKey. Can be in the form
+     * `{organization_id}/{tag_key_short_name}` or
+     * `{project_id}/{tag_key_short_name}` or
+     * `{project_number}/{tag_key_short_name}`.
      * </pre>
      *
      * <code>string namespaced_tag_key = 4;</code>
@@ -1236,9 +1250,10 @@ public Builder setNamespacedTagKey(java.lang.String value) {
      *
      *
      * <pre>
-     * The namespaced_name of the TagKey. Now only supported in the format of
-     * `{organization_id}/{tag_key_short_name}`. Other formats will be
-     * supported when we add non-org parented tags.
+     * The namespaced name of the TagKey. Can be in the form
+     * `{organization_id}/{tag_key_short_name}` or
+     * `{project_id}/{tag_key_short_name}` or
+     * `{project_number}/{tag_key_short_name}`.
      * </pre>
      *
      * <code>string namespaced_tag_key = 4;</code>
@@ -1255,9 +1270,10 @@ public Builder clearNamespacedTagKey() {
      *
      *
      * <pre>
-     * The namespaced_name of the TagKey. Now only supported in the format of
-     * `{organization_id}/{tag_key_short_name}`. Other formats will be
-     * supported when we add non-org parented tags.
+     * The namespaced name of the TagKey. Can be in the form
+     * `{organization_id}/{tag_key_short_name}` or
+     * `{project_id}/{tag_key_short_name}` or
+     * `{project_number}/{tag_key_short_name}`.
      * </pre>
      *
      * <code>string namespaced_tag_key = 4;</code>
@@ -1282,7 +1298,8 @@ public Builder setNamespacedTagKeyBytes(com.google.protobuf.ByteString value) {
      *
      * <pre>
      * The parent name of the tag key.
-     * Must be in the format `organizations/{organization_id}`.
+     * Must be in the format `organizations/{organization_id}` or
+     * `projects/{project_number}`
      * </pre>
      *
      * <code>string tag_key_parent_name = 6;</code>
@@ -1305,7 +1322,8 @@ public java.lang.String getTagKeyParentName() {
      *
      * <pre>
      * The parent name of the tag key.
-     * Must be in the format `organizations/{organization_id}`.
+     * Must be in the format `organizations/{organization_id}` or
+     * `projects/{project_number}`
      * </pre>
      *
      * <code>string tag_key_parent_name = 6;</code>
@@ -1328,7 +1346,8 @@ public com.google.protobuf.ByteString getTagKeyParentNameBytes() {
      *
      * <pre>
      * The parent name of the tag key.
-     * Must be in the format `organizations/{organization_id}`.
+     * Must be in the format `organizations/{organization_id}` or
+     * `projects/{project_number}`
      * </pre>
      *
      * <code>string tag_key_parent_name = 6;</code>
@@ -1350,7 +1369,8 @@ public Builder setTagKeyParentName(java.lang.String value) {
      *
      * <pre>
      * The parent name of the tag key.
-     * Must be in the format `organizations/{organization_id}`.
+     * Must be in the format `organizations/{organization_id}` or
+     * `projects/{project_number}`
      * </pre>
      *
      * <code>string tag_key_parent_name = 6;</code>
@@ -1368,7 +1388,8 @@ public Builder clearTagKeyParentName() {
      *
      * <pre>
      * The parent name of the tag key.
-     * Must be in the format `organizations/{organization_id}`.
+     * Must be in the format `organizations/{organization_id}` or
+     * `projects/{project_number}`
      * </pre>
      *
      * <code>string tag_key_parent_name = 6;</code>