docs: update comments for ListVoicesRequest (#611)

- [ ] Regenerate this pull request now. PiperOrigin-RevId: 417752787 Source-Link: googleapis/googleapis@3e58417 Source-Link: googleapis/googleapis-gen@e9ad9d6 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZTlhZDlkNjM4NjAwNjM4YTAwYjA3MmZmYThkNDE4YTc4OThmMmQ0NiJ9
googleapis · Dec 28, 2021 · 9323550 · 9323550
1 parent 42196e5
commit 9323550
Show file tree

Hide file tree

Showing 4 changed files with 43 additions and 55 deletions.
diff --git a/...-texttospeech/src/main/java/com/google/cloud/texttospeech/v1beta1/TextToSpeechClient.java b/...-texttospeech/src/main/java/com/google/cloud/texttospeech/v1beta1/TextToSpeechClient.java
@@ -154,11 +154,9 @@ public TextToSpeechStub getStub() {
    * @param languageCode Optional. Recommended.
    *     [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. E.g. when specifying `"en-NZ"`,
-   *     you will get supported `"en-NZ"` 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-hk"` voices.
+   *     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/...speech-v1beta1/src/main/java/com/google/cloud/texttospeech/v1beta1/ListVoicesRequest.java b/...speech-v1beta1/src/main/java/com/google/cloud/texttospeech/v1beta1/ListVoicesRequest.java
@@ -121,11 +121,10 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
    * [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. E.g. when specifying `"en-NZ"`, you will
-   * get supported `"en-NZ"` 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-hk"` voices.
+   * 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>
@@ -152,11 +151,10 @@ public java.lang.String getLanguageCode() {
    * [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. E.g. when specifying `"en-NZ"`, you will
-   * get supported `"en-NZ"` 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-hk"` voices.
+   * 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>
@@ -504,11 +502,10 @@ public Builder mergeFrom(
      * [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. E.g. when specifying `"en-NZ"`, you will
-     * get supported `"en-NZ"` 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-hk"` voices.
+     * 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>
@@ -534,11 +531,10 @@ public java.lang.String getLanguageCode() {
      * [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. E.g. when specifying `"en-NZ"`, you will
-     * get supported `"en-NZ"` 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-hk"` voices.
+     * 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>
@@ -564,11 +560,10 @@ public com.google.protobuf.ByteString getLanguageCodeBytes() {
      * [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. E.g. when specifying `"en-NZ"`, you will
-     * get supported `"en-NZ"` 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-hk"` voices.
+     * 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>
@@ -593,11 +588,10 @@ public Builder setLanguageCode(java.lang.String value) {
      * [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. E.g. when specifying `"en-NZ"`, you will
-     * get supported `"en-NZ"` 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-hk"` voices.
+     * 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>
@@ -618,11 +612,10 @@ public Builder clearLanguageCode() {
      * [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. E.g. when specifying `"en-NZ"`, you will
-     * get supported `"en-NZ"` 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-hk"` voices.
+     * 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/...beta1/src/main/java/com/google/cloud/texttospeech/v1beta1/ListVoicesRequestOrBuilder.java b/...beta1/src/main/java/com/google/cloud/texttospeech/v1beta1/ListVoicesRequestOrBuilder.java
@@ -31,11 +31,10 @@ public interface ListVoicesRequestOrBuilder
    * [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. E.g. when specifying `"en-NZ"`, you will
-   * get supported `"en-NZ"` 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-hk"` voices.
+   * 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>
@@ -51,11 +50,10 @@ public interface ListVoicesRequestOrBuilder
    * [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. E.g. when specifying `"en-NZ"`, you will
-   * get supported `"en-NZ"` 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-hk"` voices.
+   * 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/...oud-texttospeech-v1beta1/src/main/proto/google/cloud/texttospeech/v1beta1/cloud_tts.proto b/...oud-texttospeech-v1beta1/src/main/proto/google/cloud/texttospeech/v1beta1/cloud_tts.proto
@@ -64,11 +64,10 @@ message ListVoicesRequest {
   // [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. E.g. when specifying `"en-NZ"`, you will
-  // get supported `"en-NZ"` 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-hk"` voices.
+  // 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];
 }