Skip to content
This repository was archived by the owner on Sep 16, 2023. It is now read-only.

Commit c23ee84

Browse files
docs: update comments for ListVoicesRequest (#635)
* docs: update comments for ListVoicesRequest PiperOrigin-RevId: 424942023 Source-Link: googleapis/googleapis@8ce1934 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 <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent 5561528 commit c23ee84

File tree

4 files changed

+75
-76
lines changed

4 files changed

+75
-76
lines changed

google-cloud-texttospeech/src/main/java/com/google/cloud/texttospeech/v1/TextToSpeechClient.java

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -151,12 +151,11 @@ public TextToSpeechStub getStub() {
151151
* }</pre>
152152
*
153153
* @param languageCode Optional. Recommended.
154-
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If specified, the
155-
* ListVoices call will only return voices that can be used to synthesize this language_code.
156-
* E.g. when specifying `"en-NZ"`, you will get supported `"en-\\&#42;"` voices; when
157-
* specifying `"no"`, you will get supported `"no-\\&#42;"` (Norwegian) and `"nb-\\&#42;"`
158-
* (Norwegian Bokmal) voices; specifying `"zh"` will also get supported `"cmn-\\&#42;"`
159-
* voices; specifying `"zh-hk"` will also get supported `"yue-\\&#42;"` voices.
154+
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If not specified, the
155+
* API will return all supported voices. If specified, the ListVoices call will only return
156+
* voices that can be used to synthesize this language_code. For example, if you specify
157+
* `"en-NZ"`, all `"en-NZ"` voices will be returned. If you specify `"no"`, both
158+
* `"no-\\&#42;"` (Norwegian) and `"nb-\\&#42;"` (Norwegian Bokmal) voices will be returned.
160159
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
161160
*/
162161
public final ListVoicesResponse listVoices(String languageCode) {

proto-google-cloud-texttospeech-v1/src/main/java/com/google/cloud/texttospeech/v1/ListVoicesRequest.java

Lines changed: 49 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -118,13 +118,13 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
118118
*
119119
* <pre>
120120
* Optional. Recommended.
121-
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If
122-
* specified, the ListVoices call will only return voices that can be used to
123-
* synthesize this language_code. E.g. when specifying `"en-NZ"`, you will get
124-
* supported `"en-&#92;*"` voices; when specifying `"no"`, you will get supported
125-
* `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices; specifying
126-
* `"zh"` will also get supported `"cmn-&#92;*"` voices; specifying `"zh-hk"` will
127-
* also get supported `"yue-&#92;*"` voices.
121+
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
122+
* If not specified, the API will return all supported voices.
123+
* If specified, the ListVoices call will only return voices that can be used
124+
* to synthesize this language_code. For example, if you specify `"en-NZ"`,
125+
* all `"en-NZ"` voices will be returned. If you specify `"no"`, both
126+
* `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices will be
127+
* returned.
128128
* </pre>
129129
*
130130
* <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -148,13 +148,13 @@ public java.lang.String getLanguageCode() {
148148
*
149149
* <pre>
150150
* Optional. Recommended.
151-
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If
152-
* specified, the ListVoices call will only return voices that can be used to
153-
* synthesize this language_code. E.g. when specifying `"en-NZ"`, you will get
154-
* supported `"en-&#92;*"` voices; when specifying `"no"`, you will get supported
155-
* `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices; specifying
156-
* `"zh"` will also get supported `"cmn-&#92;*"` voices; specifying `"zh-hk"` will
157-
* also get supported `"yue-&#92;*"` voices.
151+
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
152+
* If not specified, the API will return all supported voices.
153+
* If specified, the ListVoices call will only return voices that can be used
154+
* to synthesize this language_code. For example, if you specify `"en-NZ"`,
155+
* all `"en-NZ"` voices will be returned. If you specify `"no"`, both
156+
* `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices will be
157+
* returned.
158158
* </pre>
159159
*
160160
* <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -498,13 +498,13 @@ public Builder mergeFrom(
498498
*
499499
* <pre>
500500
* Optional. Recommended.
501-
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If
502-
* specified, the ListVoices call will only return voices that can be used to
503-
* synthesize this language_code. E.g. when specifying `"en-NZ"`, you will get
504-
* supported `"en-&#92;*"` voices; when specifying `"no"`, you will get supported
505-
* `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices; specifying
506-
* `"zh"` will also get supported `"cmn-&#92;*"` voices; specifying `"zh-hk"` will
507-
* also get supported `"yue-&#92;*"` voices.
501+
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
502+
* If not specified, the API will return all supported voices.
503+
* If specified, the ListVoices call will only return voices that can be used
504+
* to synthesize this language_code. For example, if you specify `"en-NZ"`,
505+
* all `"en-NZ"` voices will be returned. If you specify `"no"`, both
506+
* `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices will be
507+
* returned.
508508
* </pre>
509509
*
510510
* <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -527,13 +527,13 @@ public java.lang.String getLanguageCode() {
527527
*
528528
* <pre>
529529
* Optional. Recommended.
530-
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If
531-
* specified, the ListVoices call will only return voices that can be used to
532-
* synthesize this language_code. E.g. when specifying `"en-NZ"`, you will get
533-
* supported `"en-&#92;*"` voices; when specifying `"no"`, you will get supported
534-
* `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices; specifying
535-
* `"zh"` will also get supported `"cmn-&#92;*"` voices; specifying `"zh-hk"` will
536-
* also get supported `"yue-&#92;*"` voices.
530+
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
531+
* If not specified, the API will return all supported voices.
532+
* If specified, the ListVoices call will only return voices that can be used
533+
* to synthesize this language_code. For example, if you specify `"en-NZ"`,
534+
* all `"en-NZ"` voices will be returned. If you specify `"no"`, both
535+
* `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices will be
536+
* returned.
537537
* </pre>
538538
*
539539
* <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -556,13 +556,13 @@ public com.google.protobuf.ByteString getLanguageCodeBytes() {
556556
*
557557
* <pre>
558558
* Optional. Recommended.
559-
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If
560-
* specified, the ListVoices call will only return voices that can be used to
561-
* synthesize this language_code. E.g. when specifying `"en-NZ"`, you will get
562-
* supported `"en-&#92;*"` voices; when specifying `"no"`, you will get supported
563-
* `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices; specifying
564-
* `"zh"` will also get supported `"cmn-&#92;*"` voices; specifying `"zh-hk"` will
565-
* also get supported `"yue-&#92;*"` voices.
559+
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
560+
* If not specified, the API will return all supported voices.
561+
* If specified, the ListVoices call will only return voices that can be used
562+
* to synthesize this language_code. For example, if you specify `"en-NZ"`,
563+
* all `"en-NZ"` voices will be returned. If you specify `"no"`, both
564+
* `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices will be
565+
* returned.
566566
* </pre>
567567
*
568568
* <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -584,13 +584,13 @@ public Builder setLanguageCode(java.lang.String value) {
584584
*
585585
* <pre>
586586
* Optional. Recommended.
587-
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If
588-
* specified, the ListVoices call will only return voices that can be used to
589-
* synthesize this language_code. E.g. when specifying `"en-NZ"`, you will get
590-
* supported `"en-&#92;*"` voices; when specifying `"no"`, you will get supported
591-
* `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices; specifying
592-
* `"zh"` will also get supported `"cmn-&#92;*"` voices; specifying `"zh-hk"` will
593-
* also get supported `"yue-&#92;*"` voices.
587+
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
588+
* If not specified, the API will return all supported voices.
589+
* If specified, the ListVoices call will only return voices that can be used
590+
* to synthesize this language_code. For example, if you specify `"en-NZ"`,
591+
* all `"en-NZ"` voices will be returned. If you specify `"no"`, both
592+
* `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices will be
593+
* returned.
594594
* </pre>
595595
*
596596
* <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -608,13 +608,13 @@ public Builder clearLanguageCode() {
608608
*
609609
* <pre>
610610
* Optional. Recommended.
611-
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If
612-
* specified, the ListVoices call will only return voices that can be used to
613-
* synthesize this language_code. E.g. when specifying `"en-NZ"`, you will get
614-
* supported `"en-&#92;*"` voices; when specifying `"no"`, you will get supported
615-
* `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices; specifying
616-
* `"zh"` will also get supported `"cmn-&#92;*"` voices; specifying `"zh-hk"` will
617-
* also get supported `"yue-&#92;*"` voices.
611+
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
612+
* If not specified, the API will return all supported voices.
613+
* If specified, the ListVoices call will only return voices that can be used
614+
* to synthesize this language_code. For example, if you specify `"en-NZ"`,
615+
* all `"en-NZ"` voices will be returned. If you specify `"no"`, both
616+
* `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices will be
617+
* returned.
618618
* </pre>
619619
*
620620
* <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>

proto-google-cloud-texttospeech-v1/src/main/java/com/google/cloud/texttospeech/v1/ListVoicesRequestOrBuilder.java

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,13 @@ public interface ListVoicesRequestOrBuilder
2828
*
2929
* <pre>
3030
* Optional. Recommended.
31-
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If
32-
* specified, the ListVoices call will only return voices that can be used to
33-
* synthesize this language_code. E.g. when specifying `"en-NZ"`, you will get
34-
* supported `"en-&#92;*"` voices; when specifying `"no"`, you will get supported
35-
* `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices; specifying
36-
* `"zh"` will also get supported `"cmn-&#92;*"` voices; specifying `"zh-hk"` will
37-
* also get supported `"yue-&#92;*"` voices.
31+
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
32+
* If not specified, the API will return all supported voices.
33+
* If specified, the ListVoices call will only return voices that can be used
34+
* to synthesize this language_code. For example, if you specify `"en-NZ"`,
35+
* all `"en-NZ"` voices will be returned. If you specify `"no"`, both
36+
* `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices will be
37+
* returned.
3838
* </pre>
3939
*
4040
* <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -47,13 +47,13 @@ public interface ListVoicesRequestOrBuilder
4747
*
4848
* <pre>
4949
* Optional. Recommended.
50-
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If
51-
* specified, the ListVoices call will only return voices that can be used to
52-
* synthesize this language_code. E.g. when specifying `"en-NZ"`, you will get
53-
* supported `"en-&#92;*"` voices; when specifying `"no"`, you will get supported
54-
* `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices; specifying
55-
* `"zh"` will also get supported `"cmn-&#92;*"` voices; specifying `"zh-hk"` will
56-
* also get supported `"yue-&#92;*"` voices.
50+
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
51+
* If not specified, the API will return all supported voices.
52+
* If specified, the ListVoices call will only return voices that can be used
53+
* to synthesize this language_code. For example, if you specify `"en-NZ"`,
54+
* all `"en-NZ"` voices will be returned. If you specify `"no"`, both
55+
* `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices will be
56+
* returned.
5757
* </pre>
5858
*
5959
* <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>

proto-google-cloud-texttospeech-v1/src/main/proto/google/cloud/texttospeech/v1/cloud_tts.proto

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -61,13 +61,13 @@ service TextToSpeech {
6161
// The top-level message sent by the client for the `ListVoices` method.
6262
message ListVoicesRequest {
6363
// Optional. Recommended.
64-
// [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If
65-
// specified, the ListVoices call will only return voices that can be used to
66-
// synthesize this language_code. E.g. when specifying `"en-NZ"`, you will get
67-
// supported `"en-\*"` voices; when specifying `"no"`, you will get supported
68-
// `"no-\*"` (Norwegian) and `"nb-\*"` (Norwegian Bokmal) voices; specifying
69-
// `"zh"` will also get supported `"cmn-\*"` voices; specifying `"zh-hk"` will
70-
// also get supported `"yue-\*"` voices.
64+
// [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
65+
// If not specified, the API will return all supported voices.
66+
// If specified, the ListVoices call will only return voices that can be used
67+
// to synthesize this language_code. For example, if you specify `"en-NZ"`,
68+
// all `"en-NZ"` voices will be returned. If you specify `"no"`, both
69+
// `"no-\*"` (Norwegian) and `"nb-\*"` (Norwegian Bokmal) voices will be
70+
// returned.
7171
string language_code = 1 [(google.api.field_behavior) = OPTIONAL];
7272
}
7373

0 commit comments

Comments
 (0)