docs: update comments for ListVoicesRequest (#635)

* docs: update comments for ListVoicesRequest PiperOrigin-RevId: 424942023 Source-Link: googleapis/googleapis@8ce1934 Source-Link: googleapis/googleapis-gen@40dbea3 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNDBkYmVhMzQyNTRhYWVkYmUyZjhjNDgzYTU0ZTMyZDA3NWQ1ZmVkOSJ9 * 🦉 Updates from OwlBot See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
googleapis · Feb 3, 2022 · c23ee84 · c23ee84
1 parent 5561528
commit c23ee84
Show file tree

Hide file tree

Showing 4 changed files with 75 additions and 76 deletions.
diff --git a/...cloud-texttospeech/src/main/java/com/google/cloud/texttospeech/v1/TextToSpeechClient.java b/...cloud-texttospeech/src/main/java/com/google/cloud/texttospeech/v1/TextToSpeechClient.java
@@ -151,12 +151,11 @@ public TextToSpeechStub getStub() {
    * }</pre>
    *
    * @param languageCode Optional. Recommended.
-   *     [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If specified, the
-   *     ListVoices call will only return voices that can be used to synthesize this language_code.
-   *     E.g. when specifying `"en-NZ"`, you will get supported `"en-\\&#42;"` voices; when
-   *     specifying `"no"`, you will get supported `"no-\\&#42;"` (Norwegian) and `"nb-\\&#42;"`
-   *     (Norwegian Bokmal) voices; specifying `"zh"` will also get supported `"cmn-\\&#42;"`
-   *     voices; specifying `"zh-hk"` will also get supported `"yue-\\&#42;"` voices.
+   *     [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If not specified, the
+   *     API will return all supported voices. If specified, the ListVoices call will only return
+   *     voices that can be used to synthesize this language_code. For example, if you specify
+   *     `"en-NZ"`, all `"en-NZ"` voices will be returned. If you specify `"no"`, both
+   *     `"no-\\&#42;"` (Norwegian) and `"nb-\\&#42;"` (Norwegian Bokmal) voices will be returned.
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
    */
   public final ListVoicesResponse listVoices(String languageCode) {

diff --git a/...oud-texttospeech-v1/src/main/java/com/google/cloud/texttospeech/v1/ListVoicesRequest.java b/...oud-texttospeech-v1/src/main/java/com/google/cloud/texttospeech/v1/ListVoicesRequest.java
@@ -118,13 +118,13 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
    *
    * <pre>
    * Optional. Recommended.
-   * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If
-   * specified, the ListVoices call will only return voices that can be used to
-   * synthesize this language_code. E.g. when specifying `"en-NZ"`, you will get
-   * supported `"en-&#92;*"` voices; when specifying `"no"`, you will get supported
-   * `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices; specifying
-   * `"zh"` will also get supported `"cmn-&#92;*"` voices; specifying `"zh-hk"` will
-   * also get supported `"yue-&#92;*"` voices.
+   * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
+   * If not specified, the API will return all supported voices.
+   * If specified, the ListVoices call will only return voices that can be used
+   * to synthesize this language_code. For example, if you specify `"en-NZ"`,
+   * all `"en-NZ"` voices will be returned. If you specify `"no"`, both
+   * `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices will be
+   * returned.
    * </pre>
    *
    * <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -148,13 +148,13 @@ public java.lang.String getLanguageCode() {
    *
    * <pre>
    * Optional. Recommended.
-   * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If
-   * specified, the ListVoices call will only return voices that can be used to
-   * synthesize this language_code. E.g. when specifying `"en-NZ"`, you will get
-   * supported `"en-&#92;*"` voices; when specifying `"no"`, you will get supported
-   * `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices; specifying
-   * `"zh"` will also get supported `"cmn-&#92;*"` voices; specifying `"zh-hk"` will
-   * also get supported `"yue-&#92;*"` voices.
+   * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
+   * If not specified, the API will return all supported voices.
+   * If specified, the ListVoices call will only return voices that can be used
+   * to synthesize this language_code. For example, if you specify `"en-NZ"`,
+   * all `"en-NZ"` voices will be returned. If you specify `"no"`, both
+   * `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices will be
+   * returned.
    * </pre>
    *
    * <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -498,13 +498,13 @@ public Builder mergeFrom(
      *
      * <pre>
      * Optional. Recommended.
-     * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If
-     * specified, the ListVoices call will only return voices that can be used to
-     * synthesize this language_code. E.g. when specifying `"en-NZ"`, you will get
-     * supported `"en-&#92;*"` voices; when specifying `"no"`, you will get supported
-     * `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices; specifying
-     * `"zh"` will also get supported `"cmn-&#92;*"` voices; specifying `"zh-hk"` will
-     * also get supported `"yue-&#92;*"` voices.
+     * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
+     * If not specified, the API will return all supported voices.
+     * If specified, the ListVoices call will only return voices that can be used
+     * to synthesize this language_code. For example, if you specify `"en-NZ"`,
+     * all `"en-NZ"` voices will be returned. If you specify `"no"`, both
+     * `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices will be
+     * returned.
      * </pre>
      *
      * <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -527,13 +527,13 @@ public java.lang.String getLanguageCode() {
      *
      * <pre>
      * Optional. Recommended.
-     * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If
-     * specified, the ListVoices call will only return voices that can be used to
-     * synthesize this language_code. E.g. when specifying `"en-NZ"`, you will get
-     * supported `"en-&#92;*"` voices; when specifying `"no"`, you will get supported
-     * `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices; specifying
-     * `"zh"` will also get supported `"cmn-&#92;*"` voices; specifying `"zh-hk"` will
-     * also get supported `"yue-&#92;*"` voices.
+     * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
+     * If not specified, the API will return all supported voices.
+     * If specified, the ListVoices call will only return voices that can be used
+     * to synthesize this language_code. For example, if you specify `"en-NZ"`,
+     * all `"en-NZ"` voices will be returned. If you specify `"no"`, both
+     * `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices will be
+     * returned.
      * </pre>
      *
      * <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -556,13 +556,13 @@ public com.google.protobuf.ByteString getLanguageCodeBytes() {
      *
      * <pre>
      * Optional. Recommended.
-     * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If
-     * specified, the ListVoices call will only return voices that can be used to
-     * synthesize this language_code. E.g. when specifying `"en-NZ"`, you will get
-     * supported `"en-&#92;*"` voices; when specifying `"no"`, you will get supported
-     * `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices; specifying
-     * `"zh"` will also get supported `"cmn-&#92;*"` voices; specifying `"zh-hk"` will
-     * also get supported `"yue-&#92;*"` voices.
+     * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
+     * If not specified, the API will return all supported voices.
+     * If specified, the ListVoices call will only return voices that can be used
+     * to synthesize this language_code. For example, if you specify `"en-NZ"`,
+     * all `"en-NZ"` voices will be returned. If you specify `"no"`, both
+     * `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices will be
+     * returned.
      * </pre>
      *
      * <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -584,13 +584,13 @@ public Builder setLanguageCode(java.lang.String value) {
      *
      * <pre>
      * Optional. Recommended.
-     * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If
-     * specified, the ListVoices call will only return voices that can be used to
-     * synthesize this language_code. E.g. when specifying `"en-NZ"`, you will get
-     * supported `"en-&#92;*"` voices; when specifying `"no"`, you will get supported
-     * `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices; specifying
-     * `"zh"` will also get supported `"cmn-&#92;*"` voices; specifying `"zh-hk"` will
-     * also get supported `"yue-&#92;*"` voices.
+     * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
+     * If not specified, the API will return all supported voices.
+     * If specified, the ListVoices call will only return voices that can be used
+     * to synthesize this language_code. For example, if you specify `"en-NZ"`,
+     * all `"en-NZ"` voices will be returned. If you specify `"no"`, both
+     * `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices will be
+     * returned.
      * </pre>
      *
      * <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -608,13 +608,13 @@ public Builder clearLanguageCode() {
      *
      * <pre>
      * Optional. Recommended.
-     * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If
-     * specified, the ListVoices call will only return voices that can be used to
-     * synthesize this language_code. E.g. when specifying `"en-NZ"`, you will get
-     * supported `"en-&#92;*"` voices; when specifying `"no"`, you will get supported
-     * `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices; specifying
-     * `"zh"` will also get supported `"cmn-&#92;*"` voices; specifying `"zh-hk"` will
-     * also get supported `"yue-&#92;*"` voices.
+     * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
+     * If not specified, the API will return all supported voices.
+     * If specified, the ListVoices call will only return voices that can be used
+     * to synthesize this language_code. For example, if you specify `"en-NZ"`,
+     * all `"en-NZ"` voices will be returned. If you specify `"no"`, both
+     * `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices will be
+     * returned.
      * </pre>
      *
      * <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>

diff --git a/...ospeech-v1/src/main/java/com/google/cloud/texttospeech/v1/ListVoicesRequestOrBuilder.java b/...ospeech-v1/src/main/java/com/google/cloud/texttospeech/v1/ListVoicesRequestOrBuilder.java
@@ -28,13 +28,13 @@ public interface ListVoicesRequestOrBuilder
    *
    * <pre>
    * Optional. Recommended.
-   * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If
-   * specified, the ListVoices call will only return voices that can be used to
-   * synthesize this language_code. E.g. when specifying `"en-NZ"`, you will get
-   * supported `"en-&#92;*"` voices; when specifying `"no"`, you will get supported
-   * `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices; specifying
-   * `"zh"` will also get supported `"cmn-&#92;*"` voices; specifying `"zh-hk"` will
-   * also get supported `"yue-&#92;*"` voices.
+   * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
+   * If not specified, the API will return all supported voices.
+   * If specified, the ListVoices call will only return voices that can be used
+   * to synthesize this language_code. For example, if you specify `"en-NZ"`,
+   * all `"en-NZ"` voices will be returned. If you specify `"no"`, both
+   * `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices will be
+   * returned.
    * </pre>
    *
    * <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -47,13 +47,13 @@ public interface ListVoicesRequestOrBuilder
    *
    * <pre>
    * Optional. Recommended.
-   * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If
-   * specified, the ListVoices call will only return voices that can be used to
-   * synthesize this language_code. E.g. when specifying `"en-NZ"`, you will get
-   * supported `"en-&#92;*"` voices; when specifying `"no"`, you will get supported
-   * `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices; specifying
-   * `"zh"` will also get supported `"cmn-&#92;*"` voices; specifying `"zh-hk"` will
-   * also get supported `"yue-&#92;*"` voices.
+   * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
+   * If not specified, the API will return all supported voices.
+   * If specified, the ListVoices call will only return voices that can be used
+   * to synthesize this language_code. For example, if you specify `"en-NZ"`,
+   * all `"en-NZ"` voices will be returned. If you specify `"no"`, both
+   * `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices will be
+   * returned.
    * </pre>
    *
    * <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>

diff --git a/...-google-cloud-texttospeech-v1/src/main/proto/google/cloud/texttospeech/v1/cloud_tts.proto b/...-google-cloud-texttospeech-v1/src/main/proto/google/cloud/texttospeech/v1/cloud_tts.proto
@@ -61,13 +61,13 @@ service TextToSpeech {
 // The top-level message sent by the client for the `ListVoices` method.
 message ListVoicesRequest {
   // Optional. Recommended.
-  // [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If
-  // specified, the ListVoices call will only return voices that can be used to
-  // synthesize this language_code. E.g. when specifying `"en-NZ"`, you will get
-  // supported `"en-\*"` voices; when specifying `"no"`, you will get supported
-  // `"no-\*"` (Norwegian) and `"nb-\*"` (Norwegian Bokmal) voices; specifying
-  // `"zh"` will also get supported `"cmn-\*"` voices; specifying `"zh-hk"` will
-  // also get supported `"yue-\*"` voices.
+  // [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
+  // If not specified, the API will return all supported voices.
+  // If specified, the ListVoices call will only return voices that can be used
+  // to synthesize this language_code. For example, if you specify `"en-NZ"`,
+  // all `"en-NZ"` voices will be returned. If you specify `"no"`, both
+  // `"no-\*"` (Norwegian) and `"nb-\*"` (Norwegian Bokmal) voices will be
+  // returned.
   string language_code = 1 [(google.api.field_behavior) = OPTIONAL];
 }