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

Commit d5e5488

Browse files
yoshi-automationchingor13
yoshi-automation
authored and
chingor13
committed
docs(regen): updated javadocs from protoc update (#25)
1 parent 34fd98e commit d5e5488

37 files changed

+935
-87
lines changed

Diff for: ‎proto-google-cloud-texttospeech-v1/src/main/java/com/google/cloud/texttospeech/v1/AudioConfig.java

+103-13
Large diffs are not rendered by default.

Diff for: ‎proto-google-cloud-texttospeech-v1/src/main/java/com/google/cloud/texttospeech/v1/AudioConfigOrBuilder.java

+22
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ public interface AudioConfigOrBuilder
3333
* <code>
3434
* .google.cloud.texttospeech.v1.AudioEncoding audio_encoding = 1 [(.google.api.field_behavior) = REQUIRED];
3535
* </code>
36+
*
37+
* @return The enum numeric value on the wire for audioEncoding.
3638
*/
3739
int getAudioEncodingValue();
3840
/**
@@ -45,6 +47,8 @@ public interface AudioConfigOrBuilder
4547
* <code>
4648
* .google.cloud.texttospeech.v1.AudioEncoding audio_encoding = 1 [(.google.api.field_behavior) = REQUIRED];
4749
* </code>
50+
*
51+
* @return The audioEncoding.
4852
*/
4953
com.google.cloud.texttospeech.v1.AudioEncoding getAudioEncoding();
5054

@@ -61,6 +65,8 @@ public interface AudioConfigOrBuilder
6165
* <code>
6266
* double speaking_rate = 2 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
6367
* </code>
68+
*
69+
* @return The speakingRate.
6470
*/
6571
double getSpeakingRate();
6672

@@ -76,6 +82,8 @@ public interface AudioConfigOrBuilder
7682
* <code>
7783
* double pitch = 3 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
7884
* </code>
85+
*
86+
* @return The pitch.
7987
*/
8088
double getPitch();
8189

@@ -96,6 +104,8 @@ public interface AudioConfigOrBuilder
96104
* <code>
97105
* double volume_gain_db = 4 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
98106
* </code>
107+
*
108+
* @return The volumeGainDb.
99109
*/
100110
double getVolumeGainDb();
101111

@@ -113,6 +123,8 @@ public interface AudioConfigOrBuilder
113123
* </pre>
114124
*
115125
* <code>int32 sample_rate_hertz = 5 [(.google.api.field_behavior) = OPTIONAL];</code>
126+
*
127+
* @return The sampleRateHertz.
116128
*/
117129
int getSampleRateHertz();
118130

@@ -131,6 +143,8 @@ public interface AudioConfigOrBuilder
131143
* <code>
132144
* repeated string effects_profile_id = 6 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
133145
* </code>
146+
*
147+
* @return A list containing the effectsProfileId.
134148
*/
135149
java.util.List<java.lang.String> getEffectsProfileIdList();
136150
/**
@@ -148,6 +162,8 @@ public interface AudioConfigOrBuilder
148162
* <code>
149163
* repeated string effects_profile_id = 6 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
150164
* </code>
165+
*
166+
* @return The count of effectsProfileId.
151167
*/
152168
int getEffectsProfileIdCount();
153169
/**
@@ -165,6 +181,9 @@ public interface AudioConfigOrBuilder
165181
* <code>
166182
* repeated string effects_profile_id = 6 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
167183
* </code>
184+
*
185+
* @param index The index of the element to return.
186+
* @return The effectsProfileId at the given index.
168187
*/
169188
java.lang.String getEffectsProfileId(int index);
170189
/**
@@ -182,6 +201,9 @@ public interface AudioConfigOrBuilder
182201
* <code>
183202
* repeated string effects_profile_id = 6 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
184203
* </code>
204+
*
205+
* @param index The index of the value to return.
206+
* @return The bytes of the effectsProfileId at the given index.
185207
*/
186208
com.google.protobuf.ByteString getEffectsProfileIdBytes(int index);
187209
}

Diff for: ‎proto-google-cloud-texttospeech-v1/src/main/java/com/google/cloud/texttospeech/v1/AudioEncoding.java

+9-1
Original file line numberDiff line numberDiff line change
@@ -129,12 +129,20 @@ public final int getNumber() {
129129
return value;
130130
}
131131

132-
/** @deprecated Use {@link #forNumber(int)} instead. */
132+
/**
133+
* @param value The numeric wire value of the corresponding enum entry.
134+
* @return The enum associated with the given numeric wire value.
135+
* @deprecated Use {@link #forNumber(int)} instead.
136+
*/
133137
@java.lang.Deprecated
134138
public static AudioEncoding valueOf(int value) {
135139
return forNumber(value);
136140
}
137141

142+
/**
143+
* @param value The numeric wire value of the corresponding enum entry.
144+
* @return The enum associated with the given numeric wire value.
145+
*/
138146
public static AudioEncoding forNumber(int value) {
139147
switch (value) {
140148
case 0:

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

+22-1
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,12 @@ private ListVoicesRequest() {
4141
languageCode_ = "";
4242
}
4343

44+
@java.lang.Override
45+
@SuppressWarnings({"unused"})
46+
protected java.lang.Object newInstance(UnusedPrivateParameter unused) {
47+
return new ListVoicesRequest();
48+
}
49+
4450
@java.lang.Override
4551
public final com.google.protobuf.UnknownFieldSet getUnknownFields() {
4652
return this.unknownFields;
@@ -54,7 +60,6 @@ private ListVoicesRequest(
5460
if (extensionRegistry == null) {
5561
throw new java.lang.NullPointerException();
5662
}
57-
int mutable_bitField0_ = 0;
5863
com.google.protobuf.UnknownFieldSet.Builder unknownFields =
5964
com.google.protobuf.UnknownFieldSet.newBuilder();
6065
try {
@@ -123,6 +128,8 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
123128
* </pre>
124129
*
125130
* <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
131+
*
132+
* @return The languageCode.
126133
*/
127134
public java.lang.String getLanguageCode() {
128135
java.lang.Object ref = languageCode_;
@@ -150,6 +157,8 @@ public java.lang.String getLanguageCode() {
150157
* </pre>
151158
*
152159
* <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
160+
*
161+
* @return The bytes for languageCode.
153162
*/
154163
public com.google.protobuf.ByteString getLanguageCodeBytes() {
155164
java.lang.Object ref = languageCode_;
@@ -497,6 +506,8 @@ public Builder mergeFrom(
497506
* </pre>
498507
*
499508
* <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
509+
*
510+
* @return The languageCode.
500511
*/
501512
public java.lang.String getLanguageCode() {
502513
java.lang.Object ref = languageCode_;
@@ -524,6 +535,8 @@ public java.lang.String getLanguageCode() {
524535
* </pre>
525536
*
526537
* <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
538+
*
539+
* @return The bytes for languageCode.
527540
*/
528541
public com.google.protobuf.ByteString getLanguageCodeBytes() {
529542
java.lang.Object ref = languageCode_;
@@ -551,6 +564,9 @@ public com.google.protobuf.ByteString getLanguageCodeBytes() {
551564
* </pre>
552565
*
553566
* <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
567+
*
568+
* @param value The languageCode to set.
569+
* @return This builder for chaining.
554570
*/
555571
public Builder setLanguageCode(java.lang.String value) {
556572
if (value == null) {
@@ -576,6 +592,8 @@ public Builder setLanguageCode(java.lang.String value) {
576592
* </pre>
577593
*
578594
* <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
595+
*
596+
* @return This builder for chaining.
579597
*/
580598
public Builder clearLanguageCode() {
581599

@@ -598,6 +616,9 @@ public Builder clearLanguageCode() {
598616
* </pre>
599617
*
600618
* <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
619+
*
620+
* @param value The bytes for languageCode to set.
621+
* @return This builder for chaining.
601622
*/
602623
public Builder setLanguageCodeBytes(com.google.protobuf.ByteString value) {
603624
if (value == null) {

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

+4
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ public interface ListVoicesRequestOrBuilder
3838
* </pre>
3939
*
4040
* <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
41+
*
42+
* @return The languageCode.
4143
*/
4244
java.lang.String getLanguageCode();
4345
/**
@@ -55,6 +57,8 @@ public interface ListVoicesRequestOrBuilder
5557
* </pre>
5658
*
5759
* <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
60+
*
61+
* @return The bytes for languageCode.
5862
*/
5963
com.google.protobuf.ByteString getLanguageCodeBytes();
6064
}

Diff for: ‎proto-google-cloud-texttospeech-v1/src/main/java/com/google/cloud/texttospeech/v1/ListVoicesResponse.java

+6
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,12 @@ private ListVoicesResponse() {
4141
voices_ = java.util.Collections.emptyList();
4242
}
4343

44+
@java.lang.Override
45+
@SuppressWarnings({"unused"})
46+
protected java.lang.Object newInstance(UnusedPrivateParameter unused) {
47+
return new ListVoicesResponse();
48+
}
49+
4450
@java.lang.Override
4551
public final com.google.protobuf.UnknownFieldSet getUnknownFields() {
4652
return this.unknownFields;

Diff for: ‎proto-google-cloud-texttospeech-v1/src/main/java/com/google/cloud/texttospeech/v1/SsmlVoiceGender.java

+9-1
Original file line numberDiff line numberDiff line change
@@ -129,12 +129,20 @@ public final int getNumber() {
129129
return value;
130130
}
131131

132-
/** @deprecated Use {@link #forNumber(int)} instead. */
132+
/**
133+
* @param value The numeric wire value of the corresponding enum entry.
134+
* @return The enum associated with the given numeric wire value.
135+
* @deprecated Use {@link #forNumber(int)} instead.
136+
*/
133137
@java.lang.Deprecated
134138
public static SsmlVoiceGender valueOf(int value) {
135139
return forNumber(value);
136140
}
137141

142+
/**
143+
* @param value The numeric wire value of the corresponding enum entry.
144+
* @return The enum associated with the given numeric wire value.
145+
*/
138146
public static SsmlVoiceGender forNumber(int value) {
139147
switch (value) {
140148
case 0:

0 commit comments

Comments
 (0)