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

docs: update comments for ListVoicesRequest #611

Merged
merged 2 commits into from Dec 28, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Expand Up @@ -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-\\*"` (Norwegian) and `"nb-\\*"` (Norwegian Bokmal) voices; specifying `"zh"`
* will also get supported `"cmn-\\*"` 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-\\*"` (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) {
Expand Down
Expand Up @@ -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-\*"` (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.
* </pre>
*
* <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
Expand All @@ -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>
Expand Down Expand Up @@ -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>
Expand All @@ -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>
Expand All @@ -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>
Expand All @@ -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>
Expand All @@ -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>
Expand Down
Expand Up @@ -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>
Expand All @@ -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>
Expand Down
Expand Up @@ -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];
}

Expand Down