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

Commit 9d8bb12

Browse files
yoshi-automationchingor13
authored andcommitted
docs: regenerate javadoc, update common templates (#35)
1 parent 772ca94 commit 9d8bb12

File tree

11 files changed

+59
-47
lines changed

11 files changed

+59
-47
lines changed

.github/release-please.yml

+1
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
11
releaseType: java-yoshi
2+
bumpMinorPreMajor: true

.kokoro/build.sh

+10-4
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ echo ${JOB_TYPE}
2727
mvn install -B -V \
2828
-DskipTests=true \
2929
-Dclirr.skip=true \
30+
-Denforcer.skip=true \
3031
-Dmaven.javadoc.skip=true \
3132
-Dgcloud.download.skip=true \
3233
-T 1C
@@ -38,7 +39,7 @@ fi
3839

3940
case ${JOB_TYPE} in
4041
test)
41-
mvn test -B -Dclirr.skip=true
42+
mvn test -B -Dclirr.skip=true -Denforcer.skip=true
4243
bash ${KOKORO_GFILE_DIR}/codecov.sh
4344
bash .kokoro/coerce_logs.sh
4445
;;
@@ -49,12 +50,17 @@ javadoc)
4950
mvn javadoc:javadoc javadoc:test-javadoc
5051
;;
5152
integration)
52-
mvn -B ${INTEGRATION_TEST_ARGS} -DtrimStackTrace=false -Dclirr.skip=true -fae verify
53+
mvn -B ${INTEGRATION_TEST_ARGS} \
54+
-DtrimStackTrace=false \
55+
-Dclirr.skip=true \
56+
-Denforcer.skip=true \
57+
-fae \
58+
verify
5359
bash .kokoro/coerce_logs.sh
5460
;;
5561
clirr)
56-
mvn -B clirr:check
62+
mvn -B -Denforcer.skip=true clirr:check
5763
;;
5864
*)
5965
;;
60-
esac
66+
esac

.kokoro/dependencies.sh

+5-1
Original file line numberDiff line numberDiff line change
@@ -23,5 +23,9 @@ echo $JOB_TYPE
2323

2424
export MAVEN_OPTS="-Xmx1024m -XX:MaxPermSize=128m"
2525

26-
mvn install -DskipTests=true -B -V
26+
# this should run maven enforcer
27+
mvn install -B -V \
28+
-DskipTests=true \
29+
-Dclirr.skip=true
30+
2731
mvn -B dependency:analyze -DfailOnWarning=true

google-cloud-datalabeling/src/test/java/com/google/cloud/datalabeling/v1beta1/DataLabelingServiceClientTest.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@
4444
import java.io.IOException;
4545
import java.util.Arrays;
4646
import java.util.List;
47+
import java.util.UUID;
4748
import java.util.concurrent.ExecutionException;
4849
import org.junit.After;
4950
import org.junit.AfterClass;
@@ -64,7 +65,7 @@ public static void startStaticServer() {
6465
mockDataLabelingService = new MockDataLabelingService();
6566
serviceHelper =
6667
new MockServiceHelper(
67-
"in-process-1", Arrays.<MockGrpcService>asList(mockDataLabelingService));
68+
UUID.randomUUID().toString(), Arrays.<MockGrpcService>asList(mockDataLabelingService));
6869
serviceHelper.start();
6970
}
7071

proto-google-cloud-datalabeling-v1beta1/src/main/java/com/google/cloud/datalabeling/v1beta1/HumanAnnotationConfig.java

+14-14
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
187187
*
188188
*
189189
* <pre>
190-
* Required except for LabelAudio case. Instruction resource name.
190+
* Required. Instruction resource name.
191191
* </pre>
192192
*
193193
* <code>string instruction = 1;</code>
@@ -207,7 +207,7 @@ public java.lang.String getInstruction() {
207207
*
208208
*
209209
* <pre>
210-
* Required except for LabelAudio case. Instruction resource name.
210+
* Required. Instruction resource name.
211211
* </pre>
212212
*
213213
* <code>string instruction = 1;</code>
@@ -371,7 +371,7 @@ public com.google.protobuf.ByteString getLabelGroupBytes() {
371371
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
372372
* Default value is en-US.
373373
* Only need to set this when task is language related. For example, French
374-
* text classification or Chinese audio transcription.
374+
* text classification.
375375
* </pre>
376376
*
377377
* <code>string language_code = 5;</code>
@@ -395,7 +395,7 @@ public java.lang.String getLanguageCode() {
395395
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
396396
* Default value is en-US.
397397
* Only need to set this when task is language related. For example, French
398-
* text classification or Chinese audio transcription.
398+
* text classification.
399399
* </pre>
400400
*
401401
* <code>string language_code = 5;</code>
@@ -1075,7 +1075,7 @@ public Builder mergeFrom(
10751075
*
10761076
*
10771077
* <pre>
1078-
* Required except for LabelAudio case. Instruction resource name.
1078+
* Required. Instruction resource name.
10791079
* </pre>
10801080
*
10811081
* <code>string instruction = 1;</code>
@@ -1095,7 +1095,7 @@ public java.lang.String getInstruction() {
10951095
*
10961096
*
10971097
* <pre>
1098-
* Required except for LabelAudio case. Instruction resource name.
1098+
* Required. Instruction resource name.
10991099
* </pre>
11001100
*
11011101
* <code>string instruction = 1;</code>
@@ -1115,7 +1115,7 @@ public com.google.protobuf.ByteString getInstructionBytes() {
11151115
*
11161116
*
11171117
* <pre>
1118-
* Required except for LabelAudio case. Instruction resource name.
1118+
* Required. Instruction resource name.
11191119
* </pre>
11201120
*
11211121
* <code>string instruction = 1;</code>
@@ -1133,7 +1133,7 @@ public Builder setInstruction(java.lang.String value) {
11331133
*
11341134
*
11351135
* <pre>
1136-
* Required except for LabelAudio case. Instruction resource name.
1136+
* Required. Instruction resource name.
11371137
* </pre>
11381138
*
11391139
* <code>string instruction = 1;</code>
@@ -1148,7 +1148,7 @@ public Builder clearInstruction() {
11481148
*
11491149
*
11501150
* <pre>
1151-
* Required except for LabelAudio case. Instruction resource name.
1151+
* Required. Instruction resource name.
11521152
* </pre>
11531153
*
11541154
* <code>string instruction = 1;</code>
@@ -1475,7 +1475,7 @@ public Builder setLabelGroupBytes(com.google.protobuf.ByteString value) {
14751475
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
14761476
* Default value is en-US.
14771477
* Only need to set this when task is language related. For example, French
1478-
* text classification or Chinese audio transcription.
1478+
* text classification.
14791479
* </pre>
14801480
*
14811481
* <code>string language_code = 5;</code>
@@ -1499,7 +1499,7 @@ public java.lang.String getLanguageCode() {
14991499
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
15001500
* Default value is en-US.
15011501
* Only need to set this when task is language related. For example, French
1502-
* text classification or Chinese audio transcription.
1502+
* text classification.
15031503
* </pre>
15041504
*
15051505
* <code>string language_code = 5;</code>
@@ -1523,7 +1523,7 @@ public com.google.protobuf.ByteString getLanguageCodeBytes() {
15231523
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
15241524
* Default value is en-US.
15251525
* Only need to set this when task is language related. For example, French
1526-
* text classification or Chinese audio transcription.
1526+
* text classification.
15271527
* </pre>
15281528
*
15291529
* <code>string language_code = 5;</code>
@@ -1545,7 +1545,7 @@ public Builder setLanguageCode(java.lang.String value) {
15451545
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
15461546
* Default value is en-US.
15471547
* Only need to set this when task is language related. For example, French
1548-
* text classification or Chinese audio transcription.
1548+
* text classification.
15491549
* </pre>
15501550
*
15511551
* <code>string language_code = 5;</code>
@@ -1564,7 +1564,7 @@ public Builder clearLanguageCode() {
15641564
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
15651565
* Default value is en-US.
15661566
* Only need to set this when task is language related. For example, French
1567-
* text classification or Chinese audio transcription.
1567+
* text classification.
15681568
* </pre>
15691569
*
15701570
* <code>string language_code = 5;</code>

proto-google-cloud-datalabeling-v1beta1/src/main/java/com/google/cloud/datalabeling/v1beta1/HumanAnnotationConfigOrBuilder.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ public interface HumanAnnotationConfigOrBuilder
2727
*
2828
*
2929
* <pre>
30-
* Required except for LabelAudio case. Instruction resource name.
30+
* Required. Instruction resource name.
3131
* </pre>
3232
*
3333
* <code>string instruction = 1;</code>
@@ -37,7 +37,7 @@ public interface HumanAnnotationConfigOrBuilder
3737
*
3838
*
3939
* <pre>
40-
* Required except for LabelAudio case. Instruction resource name.
40+
* Required. Instruction resource name.
4141
* </pre>
4242
*
4343
* <code>string instruction = 1;</code>
@@ -123,7 +123,7 @@ public interface HumanAnnotationConfigOrBuilder
123123
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
124124
* Default value is en-US.
125125
* Only need to set this when task is language related. For example, French
126-
* text classification or Chinese audio transcription.
126+
* text classification.
127127
* </pre>
128128
*
129129
* <code>string language_code = 5;</code>
@@ -137,7 +137,7 @@ public interface HumanAnnotationConfigOrBuilder
137137
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
138138
* Default value is en-US.
139139
* Only need to set this when task is language related. For example, French
140-
* text classification or Chinese audio transcription.
140+
* text classification.
141141
* </pre>
142142
*
143143
* <code>string language_code = 5;</code>

proto-google-cloud-datalabeling-v1beta1/src/main/java/com/google/cloud/datalabeling/v1beta1/OutputConfig.java

+12-12
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ public DestinationCase getDestinationCase() {
183183
*
184184
* <pre>
185185
* Output to a file in Cloud Storage. Should be used for labeling output
186-
* other thanimage segmentation.
186+
* other than image segmentation.
187187
* </pre>
188188
*
189189
* <code>.google.cloud.datalabeling.v1beta1.GcsDestination gcs_destination = 1;</code>
@@ -196,7 +196,7 @@ public boolean hasGcsDestination() {
196196
*
197197
* <pre>
198198
* Output to a file in Cloud Storage. Should be used for labeling output
199-
* other thanimage segmentation.
199+
* other than image segmentation.
200200
* </pre>
201201
*
202202
* <code>.google.cloud.datalabeling.v1beta1.GcsDestination gcs_destination = 1;</code>
@@ -212,7 +212,7 @@ public com.google.cloud.datalabeling.v1beta1.GcsDestination getGcsDestination()
212212
*
213213
* <pre>
214214
* Output to a file in Cloud Storage. Should be used for labeling output
215-
* other thanimage segmentation.
215+
* other than image segmentation.
216216
* </pre>
217217
*
218218
* <code>.google.cloud.datalabeling.v1beta1.GcsDestination gcs_destination = 1;</code>
@@ -675,7 +675,7 @@ public Builder clearDestination() {
675675
*
676676
* <pre>
677677
* Output to a file in Cloud Storage. Should be used for labeling output
678-
* other thanimage segmentation.
678+
* other than image segmentation.
679679
* </pre>
680680
*
681681
* <code>.google.cloud.datalabeling.v1beta1.GcsDestination gcs_destination = 1;</code>
@@ -688,7 +688,7 @@ public boolean hasGcsDestination() {
688688
*
689689
* <pre>
690690
* Output to a file in Cloud Storage. Should be used for labeling output
691-
* other thanimage segmentation.
691+
* other than image segmentation.
692692
* </pre>
693693
*
694694
* <code>.google.cloud.datalabeling.v1beta1.GcsDestination gcs_destination = 1;</code>
@@ -711,7 +711,7 @@ public com.google.cloud.datalabeling.v1beta1.GcsDestination getGcsDestination()
711711
*
712712
* <pre>
713713
* Output to a file in Cloud Storage. Should be used for labeling output
714-
* other thanimage segmentation.
714+
* other than image segmentation.
715715
* </pre>
716716
*
717717
* <code>.google.cloud.datalabeling.v1beta1.GcsDestination gcs_destination = 1;</code>
@@ -734,7 +734,7 @@ public Builder setGcsDestination(com.google.cloud.datalabeling.v1beta1.GcsDestin
734734
*
735735
* <pre>
736736
* Output to a file in Cloud Storage. Should be used for labeling output
737-
* other thanimage segmentation.
737+
* other than image segmentation.
738738
* </pre>
739739
*
740740
* <code>.google.cloud.datalabeling.v1beta1.GcsDestination gcs_destination = 1;</code>
@@ -755,7 +755,7 @@ public Builder setGcsDestination(
755755
*
756756
* <pre>
757757
* Output to a file in Cloud Storage. Should be used for labeling output
758-
* other thanimage segmentation.
758+
* other than image segmentation.
759759
* </pre>
760760
*
761761
* <code>.google.cloud.datalabeling.v1beta1.GcsDestination gcs_destination = 1;</code>
@@ -788,7 +788,7 @@ public Builder mergeGcsDestination(com.google.cloud.datalabeling.v1beta1.GcsDest
788788
*
789789
* <pre>
790790
* Output to a file in Cloud Storage. Should be used for labeling output
791-
* other thanimage segmentation.
791+
* other than image segmentation.
792792
* </pre>
793793
*
794794
* <code>.google.cloud.datalabeling.v1beta1.GcsDestination gcs_destination = 1;</code>
@@ -814,7 +814,7 @@ public Builder clearGcsDestination() {
814814
*
815815
* <pre>
816816
* Output to a file in Cloud Storage. Should be used for labeling output
817-
* other thanimage segmentation.
817+
* other than image segmentation.
818818
* </pre>
819819
*
820820
* <code>.google.cloud.datalabeling.v1beta1.GcsDestination gcs_destination = 1;</code>
@@ -827,7 +827,7 @@ public com.google.cloud.datalabeling.v1beta1.GcsDestination.Builder getGcsDestin
827827
*
828828
* <pre>
829829
* Output to a file in Cloud Storage. Should be used for labeling output
830-
* other thanimage segmentation.
830+
* other than image segmentation.
831831
* </pre>
832832
*
833833
* <code>.google.cloud.datalabeling.v1beta1.GcsDestination gcs_destination = 1;</code>
@@ -848,7 +848,7 @@ public com.google.cloud.datalabeling.v1beta1.GcsDestination.Builder getGcsDestin
848848
*
849849
* <pre>
850850
* Output to a file in Cloud Storage. Should be used for labeling output
851-
* other thanimage segmentation.
851+
* other than image segmentation.
852852
* </pre>
853853
*
854854
* <code>.google.cloud.datalabeling.v1beta1.GcsDestination gcs_destination = 1;</code>

proto-google-cloud-datalabeling-v1beta1/src/main/java/com/google/cloud/datalabeling/v1beta1/OutputConfigOrBuilder.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ public interface OutputConfigOrBuilder
2828
*
2929
* <pre>
3030
* Output to a file in Cloud Storage. Should be used for labeling output
31-
* other thanimage segmentation.
31+
* other than image segmentation.
3232
* </pre>
3333
*
3434
* <code>.google.cloud.datalabeling.v1beta1.GcsDestination gcs_destination = 1;</code>
@@ -39,7 +39,7 @@ public interface OutputConfigOrBuilder
3939
*
4040
* <pre>
4141
* Output to a file in Cloud Storage. Should be used for labeling output
42-
* other thanimage segmentation.
42+
* other than image segmentation.
4343
* </pre>
4444
*
4545
* <code>.google.cloud.datalabeling.v1beta1.GcsDestination gcs_destination = 1;</code>
@@ -50,7 +50,7 @@ public interface OutputConfigOrBuilder
5050
*
5151
* <pre>
5252
* Output to a file in Cloud Storage. Should be used for labeling output
53-
* other thanimage segmentation.
53+
* other than image segmentation.
5454
* </pre>
5555
*
5656
* <code>.google.cloud.datalabeling.v1beta1.GcsDestination gcs_destination = 1;</code>

proto-google-cloud-datalabeling-v1beta1/src/main/proto/google/cloud/datalabeling/v1beta1/dataset.proto

+1-1
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ message OutputConfig {
135135
// Required. Location to output data to.
136136
oneof destination {
137137
// Output to a file in Cloud Storage. Should be used for labeling output
138-
// other thanimage segmentation.
138+
// other than image segmentation.
139139
GcsDestination gcs_destination = 1;
140140

141141
// Output to a folder in Cloud Storage. Should be used for image

proto-google-cloud-datalabeling-v1beta1/src/main/proto/google/cloud/datalabeling/v1beta1/human_annotation_config.proto

+2-2
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ enum StringAggregationType {
3939

4040
// Configuration for how human labeling task should be done.
4141
message HumanAnnotationConfig {
42-
// Required except for LabelAudio case. Instruction resource name.
42+
// Required. Instruction resource name.
4343
string instruction = 1;
4444

4545
// Required. A human-readable name for AnnotatedDataset defined by
@@ -59,7 +59,7 @@ message HumanAnnotationConfig {
5959
// [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
6060
// Default value is en-US.
6161
// Only need to set this when task is language related. For example, French
62-
// text classification or Chinese audio transcription.
62+
// text classification.
6363
string language_code = 5;
6464

6565
// Optional. Replication of questions. Each question will be sent to up to

0 commit comments

Comments
 (0)