From c23ee84435cf5c25d648c679c982b4001e9dbe94 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Thu, 3 Feb 2022 00:08:35 -0500 Subject: [PATCH] docs: update comments for ListVoicesRequest (#635) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * docs: update comments for ListVoicesRequest PiperOrigin-RevId: 424942023 Source-Link: https://github.com/googleapis/googleapis/commit/8ce193463ae79d1580533d636a6a016d4963867c Source-Link: https://github.com/googleapis/googleapis-gen/commit/40dbea34254aaedbe2f8c483a54e32d075d5fed9 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 --- .../texttospeech/v1/TextToSpeechClient.java | 11 +-- .../texttospeech/v1/ListVoicesRequest.java | 98 +++++++++---------- .../v1/ListVoicesRequestOrBuilder.java | 28 +++--- .../cloud/texttospeech/v1/cloud_tts.proto | 14 +-- 4 files changed, 75 insertions(+), 76 deletions(-) diff --git a/google-cloud-texttospeech/src/main/java/com/google/cloud/texttospeech/v1/TextToSpeechClient.java b/google-cloud-texttospeech/src/main/java/com/google/cloud/texttospeech/v1/TextToSpeechClient.java index 36aa5929..e6b49b3b 100644 --- a/google-cloud-texttospeech/src/main/java/com/google/cloud/texttospeech/v1/TextToSpeechClient.java +++ b/google-cloud-texttospeech/src/main/java/com/google/cloud/texttospeech/v1/TextToSpeechClient.java @@ -151,12 +151,11 @@ public TextToSpeechStub getStub() { * } * * @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-\\*"` 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. * @throws com.google.api.gax.rpc.ApiException if the remote call fails */ public final ListVoicesResponse listVoices(String languageCode) { diff --git a/proto-google-cloud-texttospeech-v1/src/main/java/com/google/cloud/texttospeech/v1/ListVoicesRequest.java b/proto-google-cloud-texttospeech-v1/src/main/java/com/google/cloud/texttospeech/v1/ListVoicesRequest.java index 19967c29..3897e9db 100644 --- a/proto-google-cloud-texttospeech-v1/src/main/java/com/google/cloud/texttospeech/v1/ListVoicesRequest.java +++ b/proto-google-cloud-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() { * * 
    * 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]; @@ -148,13 +148,13 @@ public java.lang.String getLanguageCode() { * * 
    * 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]; @@ -498,13 +498,13 @@ public Builder mergeFrom( * * 
      * 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]; @@ -527,13 +527,13 @@ public java.lang.String getLanguageCode() { * * 
      * 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]; @@ -556,13 +556,13 @@ public com.google.protobuf.ByteString getLanguageCodeBytes() { * * 
      * 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]; @@ -584,13 +584,13 @@ public Builder setLanguageCode(java.lang.String value) { * * 
      * 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]; @@ -608,13 +608,13 @@ public Builder clearLanguageCode() { * * 
      * 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]; diff --git a/proto-google-cloud-texttospeech-v1/src/main/java/com/google/cloud/texttospeech/v1/ListVoicesRequestOrBuilder.java b/proto-google-cloud-texttospeech-v1/src/main/java/com/google/cloud/texttospeech/v1/ListVoicesRequestOrBuilder.java index ce0b67b6..2743df8f 100644 --- a/proto-google-cloud-texttospeech-v1/src/main/java/com/google/cloud/texttospeech/v1/ListVoicesRequestOrBuilder.java +++ b/proto-google-cloud-texttospeech-v1/src/main/java/com/google/cloud/texttospeech/v1/ListVoicesRequestOrBuilder.java @@ -28,13 +28,13 @@ public interface ListVoicesRequestOrBuilder * * 
    * 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]; @@ -47,13 +47,13 @@ public interface ListVoicesRequestOrBuilder * * 
    * 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]; diff --git a/proto-google-cloud-texttospeech-v1/src/main/proto/google/cloud/texttospeech/v1/cloud_tts.proto b/proto-google-cloud-texttospeech-v1/src/main/proto/google/cloud/texttospeech/v1/cloud_tts.proto index a10bfe60..7f64fd45 100644 --- a/proto-google-cloud-texttospeech-v1/src/main/proto/google/cloud/texttospeech/v1/cloud_tts.proto +++ b/proto-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]; }