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

Commit 9323550

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
docs: update comments for ListVoicesRequest (#611)
- [ ] Regenerate this pull request now. PiperOrigin-RevId: 417752787 Source-Link: googleapis/googleapis@3e58417 Source-Link: https://github.com/googleapis/googleapis-gen/commit/e9ad9d638600638a00b072ffa8d418a7898f2d46 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZTlhZDlkNjM4NjAwNjM4YTAwYjA3MmZmYThkNDE4YTc4OThmMmQ0NiJ9
1 parent 42196e5 commit 9323550

File tree

4 files changed

+43
-55
lines changed

4 files changed

+43
-55
lines changed

Diff for: ‎google-cloud-texttospeech/src/main/java/com/google/cloud/texttospeech/v1beta1/TextToSpeechClient.java

+3-5
Original file line numberDiff line numberDiff line change
@@ -154,11 +154,9 @@ public TextToSpeechStub getStub() {
154154
* @param languageCode Optional. Recommended.
155155
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If not specified, the
156156
* API will return all supported voices. If specified, the ListVoices call will only return
157-
* voices that can be used to synthesize this language_code. E.g. when specifying `"en-NZ"`,
158-
* you will get supported `"en-NZ"` voices; when specifying `"no"`, you will get supported
159-
* `"no-\\*"` (Norwegian) and `"nb-\\*"` (Norwegian Bokmal) voices; specifying `"zh"`
160-
* will also get supported `"cmn-\\*"` voices; specifying `"zh-hk"` will also get
161-
* supported `"yue-hk"` voices.
157+
* voices that can be used to synthesize this language_code. For example, if you specify
158+
* `"en-NZ"`, all `"en-NZ"` voices will be returned. If you specify `"no"`, both
159+
* `"no-\\*"` (Norwegian) and `"nb-\\*"` (Norwegian Bokmal) voices will be returned.
162160
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
163161
*/
164162
public final ListVoicesResponse listVoices(String languageCode) {

Diff for: ‎proto-google-cloud-texttospeech-v1beta1/src/main/java/com/google/cloud/texttospeech/v1beta1/ListVoicesRequest.java

+28-35
Original file line numberDiff line numberDiff line change
@@ -121,11 +121,10 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
121121
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
122122
* If not specified, the API will return all supported voices.
123123
* If specified, the ListVoices call will only return voices that can be used
124-
* to synthesize this language_code. E.g. when specifying `"en-NZ"`, you will
125-
* get supported `"en-NZ"` voices; when specifying `"no"`, you will get
126-
* supported `"no-\*"` (Norwegian) and `"nb-\*"` (Norwegian Bokmal) voices;
127-
* specifying `"zh"` will also get supported `"cmn-\*"` voices; specifying
128-
* `"zh-hk"` will also get supported `"yue-hk"` voices.
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-\*"` (Norwegian) and `"nb-\*"` (Norwegian Bokmal) voices will be
127+
* returned.
129128
* </pre>
130129
*
131130
* <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -152,11 +151,10 @@ public java.lang.String getLanguageCode() {
152151
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
153152
* If not specified, the API will return all supported voices.
154153
* If specified, the ListVoices call will only return voices that can be used
155-
* to synthesize this language_code. E.g. when specifying `"en-NZ"`, you will
156-
* get supported `"en-NZ"` voices; when specifying `"no"`, you will get
157-
* supported `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices;
158-
* specifying `"zh"` will also get supported `"cmn-&#92;*"` voices; specifying
159-
* `"zh-hk"` will also get supported `"yue-hk"` voices.
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.
160158
* </pre>
161159
*
162160
* <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -504,11 +502,10 @@ public Builder mergeFrom(
504502
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
505503
* If not specified, the API will return all supported voices.
506504
* If specified, the ListVoices call will only return voices that can be used
507-
* to synthesize this language_code. E.g. when specifying `"en-NZ"`, you will
508-
* get supported `"en-NZ"` voices; when specifying `"no"`, you will get
509-
* supported `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices;
510-
* specifying `"zh"` will also get supported `"cmn-&#92;*"` voices; specifying
511-
* `"zh-hk"` will also get supported `"yue-hk"` voices.
505+
* to synthesize this language_code. For example, if you specify `"en-NZ"`,
506+
* all `"en-NZ"` voices will be returned. If you specify `"no"`, both
507+
* `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices will be
508+
* returned.
512509
* </pre>
513510
*
514511
* <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -534,11 +531,10 @@ public java.lang.String getLanguageCode() {
534531
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
535532
* If not specified, the API will return all supported voices.
536533
* If specified, the ListVoices call will only return voices that can be used
537-
* to synthesize this language_code. E.g. when specifying `"en-NZ"`, you will
538-
* get supported `"en-NZ"` voices; when specifying `"no"`, you will get
539-
* supported `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices;
540-
* specifying `"zh"` will also get supported `"cmn-&#92;*"` voices; specifying
541-
* `"zh-hk"` will also get supported `"yue-hk"` voices.
534+
* to synthesize this language_code. For example, if you specify `"en-NZ"`,
535+
* all `"en-NZ"` voices will be returned. If you specify `"no"`, both
536+
* `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices will be
537+
* returned.
542538
* </pre>
543539
*
544540
* <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -564,11 +560,10 @@ public com.google.protobuf.ByteString getLanguageCodeBytes() {
564560
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
565561
* If not specified, the API will return all supported voices.
566562
* If specified, the ListVoices call will only return voices that can be used
567-
* to synthesize this language_code. E.g. when specifying `"en-NZ"`, you will
568-
* get supported `"en-NZ"` voices; when specifying `"no"`, you will get
569-
* supported `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices;
570-
* specifying `"zh"` will also get supported `"cmn-&#92;*"` voices; specifying
571-
* `"zh-hk"` will also get supported `"yue-hk"` voices.
563+
* to synthesize this language_code. For example, if you specify `"en-NZ"`,
564+
* all `"en-NZ"` voices will be returned. If you specify `"no"`, both
565+
* `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices will be
566+
* returned.
572567
* </pre>
573568
*
574569
* <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -593,11 +588,10 @@ public Builder setLanguageCode(java.lang.String value) {
593588
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
594589
* If not specified, the API will return all supported voices.
595590
* If specified, the ListVoices call will only return voices that can be used
596-
* to synthesize this language_code. E.g. when specifying `"en-NZ"`, you will
597-
* get supported `"en-NZ"` voices; when specifying `"no"`, you will get
598-
* supported `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices;
599-
* specifying `"zh"` will also get supported `"cmn-&#92;*"` voices; specifying
600-
* `"zh-hk"` will also get supported `"yue-hk"` voices.
591+
* to synthesize this language_code. For example, if you specify `"en-NZ"`,
592+
* all `"en-NZ"` voices will be returned. If you specify `"no"`, both
593+
* `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices will be
594+
* returned.
601595
* </pre>
602596
*
603597
* <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -618,11 +612,10 @@ public Builder clearLanguageCode() {
618612
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
619613
* If not specified, the API will return all supported voices.
620614
* If specified, the ListVoices call will only return voices that can be used
621-
* to synthesize this language_code. E.g. when specifying `"en-NZ"`, you will
622-
* get supported `"en-NZ"` voices; when specifying `"no"`, you will get
623-
* supported `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices;
624-
* specifying `"zh"` will also get supported `"cmn-&#92;*"` voices; specifying
625-
* `"zh-hk"` will also get supported `"yue-hk"` voices.
615+
* to synthesize this language_code. For example, if you specify `"en-NZ"`,
616+
* all `"en-NZ"` voices will be returned. If you specify `"no"`, both
617+
* `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices will be
618+
* returned.
626619
* </pre>
627620
*
628621
* <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>

Diff for: ‎proto-google-cloud-texttospeech-v1beta1/src/main/java/com/google/cloud/texttospeech/v1beta1/ListVoicesRequestOrBuilder.java

+8-10
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,10 @@ public interface ListVoicesRequestOrBuilder
3131
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
3232
* If not specified, the API will return all supported voices.
3333
* If specified, the ListVoices call will only return voices that can be used
34-
* to synthesize this language_code. E.g. when specifying `"en-NZ"`, you will
35-
* get supported `"en-NZ"` voices; when specifying `"no"`, you will get
36-
* supported `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices;
37-
* specifying `"zh"` will also get supported `"cmn-&#92;*"` voices; specifying
38-
* `"zh-hk"` will also get supported `"yue-hk"` voices.
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.
3938
* </pre>
4039
*
4140
* <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -51,11 +50,10 @@ public interface ListVoicesRequestOrBuilder
5150
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
5251
* If not specified, the API will return all supported voices.
5352
* If specified, the ListVoices call will only return voices that can be used
54-
* to synthesize this language_code. E.g. when specifying `"en-NZ"`, you will
55-
* get supported `"en-NZ"` voices; when specifying `"no"`, you will get
56-
* supported `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices;
57-
* specifying `"zh"` will also get supported `"cmn-&#92;*"` voices; specifying
58-
* `"zh-hk"` will also get supported `"yue-hk"` voices.
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.
5957
* </pre>
6058
*
6159
* <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>

Diff for: ‎proto-google-cloud-texttospeech-v1beta1/src/main/proto/google/cloud/texttospeech/v1beta1/cloud_tts.proto

+4-5
Original file line numberDiff line numberDiff line change
@@ -64,11 +64,10 @@ message ListVoicesRequest {
6464
// [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
6565
// If not specified, the API will return all supported voices.
6666
// If specified, the ListVoices call will only return voices that can be used
67-
// to synthesize this language_code. E.g. when specifying `"en-NZ"`, you will
68-
// get supported `"en-NZ"` voices; when specifying `"no"`, you will get
69-
// supported `"no-\*"` (Norwegian) and `"nb-\*"` (Norwegian Bokmal) voices;
70-
// specifying `"zh"` will also get supported `"cmn-\*"` voices; specifying
71-
// `"zh-hk"` will also get supported `"yue-hk"` voices.
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.
7271
string language_code = 1 [(google.api.field_behavior) = OPTIONAL];
7372
}
7473

0 commit comments

Comments
 (0)