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

docs: regenerate javadoc, update common templates #35

Merged
merged 1 commit into from Nov 19, 2019
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
1 change: 1 addition & 0 deletions .github/release-please.yml
@@ -1 +1,2 @@
releaseType: java-yoshi
bumpMinorPreMajor: true
14 changes: 10 additions & 4 deletions .kokoro/build.sh
Expand Up @@ -27,6 +27,7 @@ echo ${JOB_TYPE}
mvn install -B -V \
-DskipTests=true \
-Dclirr.skip=true \
-Denforcer.skip=true \
-Dmaven.javadoc.skip=true \
-Dgcloud.download.skip=true \
-T 1C
Expand All @@ -38,7 +39,7 @@ fi

case ${JOB_TYPE} in
test)
mvn test -B -Dclirr.skip=true
mvn test -B -Dclirr.skip=true -Denforcer.skip=true
bash ${KOKORO_GFILE_DIR}/codecov.sh
bash .kokoro/coerce_logs.sh
;;
Expand All @@ -49,12 +50,17 @@ javadoc)
mvn javadoc:javadoc javadoc:test-javadoc
;;
integration)
mvn -B ${INTEGRATION_TEST_ARGS} -DtrimStackTrace=false -Dclirr.skip=true -fae verify
mvn -B ${INTEGRATION_TEST_ARGS} \
-DtrimStackTrace=false \
-Dclirr.skip=true \
-Denforcer.skip=true \
-fae \
verify
bash .kokoro/coerce_logs.sh
;;
clirr)
mvn -B clirr:check
mvn -B -Denforcer.skip=true clirr:check
;;
*)
;;
esac
esac
6 changes: 5 additions & 1 deletion .kokoro/dependencies.sh
Expand Up @@ -23,5 +23,9 @@ echo $JOB_TYPE

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

mvn install -DskipTests=true -B -V
# this should run maven enforcer
mvn install -B -V \
-DskipTests=true \
-Dclirr.skip=true

mvn -B dependency:analyze -DfailOnWarning=true
Expand Up @@ -44,6 +44,7 @@
import java.io.IOException;
import java.util.Arrays;
import java.util.List;
import java.util.UUID;
import java.util.concurrent.ExecutionException;
import org.junit.After;
import org.junit.AfterClass;
Expand All @@ -64,7 +65,7 @@ public static void startStaticServer() {
mockDataLabelingService = new MockDataLabelingService();
serviceHelper =
new MockServiceHelper(
"in-process-1", Arrays.<MockGrpcService>asList(mockDataLabelingService));
UUID.randomUUID().toString(), Arrays.<MockGrpcService>asList(mockDataLabelingService));
serviceHelper.start();
}

Expand Down
Expand Up @@ -187,7 +187,7 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
*
*
* <pre>
* Required except for LabelAudio case. Instruction resource name.
* Required. Instruction resource name.
* </pre>
*
* <code>string instruction = 1;</code>
Expand All @@ -207,7 +207,7 @@ public java.lang.String getInstruction() {
*
*
* <pre>
* Required except for LabelAudio case. Instruction resource name.
* Required. Instruction resource name.
* </pre>
*
* <code>string instruction = 1;</code>
Expand Down Expand Up @@ -371,7 +371,7 @@ public com.google.protobuf.ByteString getLabelGroupBytes() {
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
* Default value is en-US.
* Only need to set this when task is language related. For example, French
* text classification or Chinese audio transcription.
* text classification.
* </pre>
*
* <code>string language_code = 5;</code>
Expand All @@ -395,7 +395,7 @@ public java.lang.String getLanguageCode() {
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
* Default value is en-US.
* Only need to set this when task is language related. For example, French
* text classification or Chinese audio transcription.
* text classification.
* </pre>
*
* <code>string language_code = 5;</code>
Expand Down Expand Up @@ -1075,7 +1075,7 @@ public Builder mergeFrom(
*
*
* <pre>
* Required except for LabelAudio case. Instruction resource name.
* Required. Instruction resource name.
* </pre>
*
* <code>string instruction = 1;</code>
Expand All @@ -1095,7 +1095,7 @@ public java.lang.String getInstruction() {
*
*
* <pre>
* Required except for LabelAudio case. Instruction resource name.
* Required. Instruction resource name.
* </pre>
*
* <code>string instruction = 1;</code>
Expand All @@ -1115,7 +1115,7 @@ public com.google.protobuf.ByteString getInstructionBytes() {
*
*
* <pre>
* Required except for LabelAudio case. Instruction resource name.
* Required. Instruction resource name.
* </pre>
*
* <code>string instruction = 1;</code>
Expand All @@ -1133,7 +1133,7 @@ public Builder setInstruction(java.lang.String value) {
*
*
* <pre>
* Required except for LabelAudio case. Instruction resource name.
* Required. Instruction resource name.
* </pre>
*
* <code>string instruction = 1;</code>
Expand All @@ -1148,7 +1148,7 @@ public Builder clearInstruction() {
*
*
* <pre>
* Required except for LabelAudio case. Instruction resource name.
* Required. Instruction resource name.
* </pre>
*
* <code>string instruction = 1;</code>
Expand Down Expand Up @@ -1475,7 +1475,7 @@ public Builder setLabelGroupBytes(com.google.protobuf.ByteString value) {
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
* Default value is en-US.
* Only need to set this when task is language related. For example, French
* text classification or Chinese audio transcription.
* text classification.
* </pre>
*
* <code>string language_code = 5;</code>
Expand All @@ -1499,7 +1499,7 @@ public java.lang.String getLanguageCode() {
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
* Default value is en-US.
* Only need to set this when task is language related. For example, French
* text classification or Chinese audio transcription.
* text classification.
* </pre>
*
* <code>string language_code = 5;</code>
Expand All @@ -1523,7 +1523,7 @@ public com.google.protobuf.ByteString getLanguageCodeBytes() {
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
* Default value is en-US.
* Only need to set this when task is language related. For example, French
* text classification or Chinese audio transcription.
* text classification.
* </pre>
*
* <code>string language_code = 5;</code>
Expand All @@ -1545,7 +1545,7 @@ public Builder setLanguageCode(java.lang.String value) {
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
* Default value is en-US.
* Only need to set this when task is language related. For example, French
* text classification or Chinese audio transcription.
* text classification.
* </pre>
*
* <code>string language_code = 5;</code>
Expand All @@ -1564,7 +1564,7 @@ public Builder clearLanguageCode() {
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
* Default value is en-US.
* Only need to set this when task is language related. For example, French
* text classification or Chinese audio transcription.
* text classification.
* </pre>
*
* <code>string language_code = 5;</code>
Expand Down
Expand Up @@ -27,7 +27,7 @@ public interface HumanAnnotationConfigOrBuilder
*
*
* <pre>
* Required except for LabelAudio case. Instruction resource name.
* Required. Instruction resource name.
* </pre>
*
* <code>string instruction = 1;</code>
Expand All @@ -37,7 +37,7 @@ public interface HumanAnnotationConfigOrBuilder
*
*
* <pre>
* Required except for LabelAudio case. Instruction resource name.
* Required. Instruction resource name.
* </pre>
*
* <code>string instruction = 1;</code>
Expand Down Expand Up @@ -123,7 +123,7 @@ public interface HumanAnnotationConfigOrBuilder
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
* Default value is en-US.
* Only need to set this when task is language related. For example, French
* text classification or Chinese audio transcription.
* text classification.
* </pre>
*
* <code>string language_code = 5;</code>
Expand All @@ -137,7 +137,7 @@ public interface HumanAnnotationConfigOrBuilder
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
* Default value is en-US.
* Only need to set this when task is language related. For example, French
* text classification or Chinese audio transcription.
* text classification.
* </pre>
*
* <code>string language_code = 5;</code>
Expand Down
Expand Up @@ -183,7 +183,7 @@ public DestinationCase getDestinationCase() {
*
* <pre>
* Output to a file in Cloud Storage. Should be used for labeling output
* other thanimage segmentation.
* other than image segmentation.
* </pre>
*
* <code>.google.cloud.datalabeling.v1beta1.GcsDestination gcs_destination = 1;</code>
Expand All @@ -196,7 +196,7 @@ public boolean hasGcsDestination() {
*
* <pre>
* Output to a file in Cloud Storage. Should be used for labeling output
* other thanimage segmentation.
* other than image segmentation.
* </pre>
*
* <code>.google.cloud.datalabeling.v1beta1.GcsDestination gcs_destination = 1;</code>
Expand All @@ -212,7 +212,7 @@ public com.google.cloud.datalabeling.v1beta1.GcsDestination getGcsDestination()
*
* <pre>
* Output to a file in Cloud Storage. Should be used for labeling output
* other thanimage segmentation.
* other than image segmentation.
* </pre>
*
* <code>.google.cloud.datalabeling.v1beta1.GcsDestination gcs_destination = 1;</code>
Expand Down Expand Up @@ -675,7 +675,7 @@ public Builder clearDestination() {
*
* <pre>
* Output to a file in Cloud Storage. Should be used for labeling output
* other thanimage segmentation.
* other than image segmentation.
* </pre>
*
* <code>.google.cloud.datalabeling.v1beta1.GcsDestination gcs_destination = 1;</code>
Expand All @@ -688,7 +688,7 @@ public boolean hasGcsDestination() {
*
* <pre>
* Output to a file in Cloud Storage. Should be used for labeling output
* other thanimage segmentation.
* other than image segmentation.
* </pre>
*
* <code>.google.cloud.datalabeling.v1beta1.GcsDestination gcs_destination = 1;</code>
Expand All @@ -711,7 +711,7 @@ public com.google.cloud.datalabeling.v1beta1.GcsDestination getGcsDestination()
*
* <pre>
* Output to a file in Cloud Storage. Should be used for labeling output
* other thanimage segmentation.
* other than image segmentation.
* </pre>
*
* <code>.google.cloud.datalabeling.v1beta1.GcsDestination gcs_destination = 1;</code>
Expand All @@ -734,7 +734,7 @@ public Builder setGcsDestination(com.google.cloud.datalabeling.v1beta1.GcsDestin
*
* <pre>
* Output to a file in Cloud Storage. Should be used for labeling output
* other thanimage segmentation.
* other than image segmentation.
* </pre>
*
* <code>.google.cloud.datalabeling.v1beta1.GcsDestination gcs_destination = 1;</code>
Expand All @@ -755,7 +755,7 @@ public Builder setGcsDestination(
*
* <pre>
* Output to a file in Cloud Storage. Should be used for labeling output
* other thanimage segmentation.
* other than image segmentation.
* </pre>
*
* <code>.google.cloud.datalabeling.v1beta1.GcsDestination gcs_destination = 1;</code>
Expand Down Expand Up @@ -788,7 +788,7 @@ public Builder mergeGcsDestination(com.google.cloud.datalabeling.v1beta1.GcsDest
*
* <pre>
* Output to a file in Cloud Storage. Should be used for labeling output
* other thanimage segmentation.
* other than image segmentation.
* </pre>
*
* <code>.google.cloud.datalabeling.v1beta1.GcsDestination gcs_destination = 1;</code>
Expand All @@ -814,7 +814,7 @@ public Builder clearGcsDestination() {
*
* <pre>
* Output to a file in Cloud Storage. Should be used for labeling output
* other thanimage segmentation.
* other than image segmentation.
* </pre>
*
* <code>.google.cloud.datalabeling.v1beta1.GcsDestination gcs_destination = 1;</code>
Expand All @@ -827,7 +827,7 @@ public com.google.cloud.datalabeling.v1beta1.GcsDestination.Builder getGcsDestin
*
* <pre>
* Output to a file in Cloud Storage. Should be used for labeling output
* other thanimage segmentation.
* other than image segmentation.
* </pre>
*
* <code>.google.cloud.datalabeling.v1beta1.GcsDestination gcs_destination = 1;</code>
Expand All @@ -848,7 +848,7 @@ public com.google.cloud.datalabeling.v1beta1.GcsDestination.Builder getGcsDestin
*
* <pre>
* Output to a file in Cloud Storage. Should be used for labeling output
* other thanimage segmentation.
* other than image segmentation.
* </pre>
*
* <code>.google.cloud.datalabeling.v1beta1.GcsDestination gcs_destination = 1;</code>
Expand Down
Expand Up @@ -28,7 +28,7 @@ public interface OutputConfigOrBuilder
*
* <pre>
* Output to a file in Cloud Storage. Should be used for labeling output
* other thanimage segmentation.
* other than image segmentation.
* </pre>
*
* <code>.google.cloud.datalabeling.v1beta1.GcsDestination gcs_destination = 1;</code>
Expand All @@ -39,7 +39,7 @@ public interface OutputConfigOrBuilder
*
* <pre>
* Output to a file in Cloud Storage. Should be used for labeling output
* other thanimage segmentation.
* other than image segmentation.
* </pre>
*
* <code>.google.cloud.datalabeling.v1beta1.GcsDestination gcs_destination = 1;</code>
Expand All @@ -50,7 +50,7 @@ public interface OutputConfigOrBuilder
*
* <pre>
* Output to a file in Cloud Storage. Should be used for labeling output
* other thanimage segmentation.
* other than image segmentation.
* </pre>
*
* <code>.google.cloud.datalabeling.v1beta1.GcsDestination gcs_destination = 1;</code>
Expand Down
Expand Up @@ -135,7 +135,7 @@ message OutputConfig {
// Required. Location to output data to.
oneof destination {
// Output to a file in Cloud Storage. Should be used for labeling output
// other thanimage segmentation.
// other than image segmentation.
GcsDestination gcs_destination = 1;

// Output to a folder in Cloud Storage. Should be used for image
Expand Down
Expand Up @@ -39,7 +39,7 @@ enum StringAggregationType {

// Configuration for how human labeling task should be done.
message HumanAnnotationConfig {
// Required except for LabelAudio case. Instruction resource name.
// Required. Instruction resource name.
string instruction = 1;

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

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