Skip to content
Permalink
Browse files
docs(regen): updated javadoc from protoc update (#43)
  • Loading branch information
yoshi-automation authored and chingor13 committed Jan 7, 2020
1 parent 57c82ce commit 71e899962543dc148f6d9541dd9ab0ad03b5e2d9
Showing with 1,233 additions and 92 deletions.
  1. +14 −1 .kokoro/build.sh
  2. +31 −0 .kokoro/continuous/samples.cfg
  3. +31 −0 .kokoro/nightly/samples.cfg
  4. +31 −0 .kokoro/presubmit/samples.cfg
  5. +103 −1 CONTRIBUTING.md
  6. +38 −1 ...billingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/AllUpdatesRule.java
  7. +8 −0 ...dgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/AllUpdatesRuleOrBuilder.java
  8. +1 −1 ...ingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/BillingAccountName.java
  9. +90 −15 ...e-cloud-billingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/Budget.java
  10. +31 −3 ...d-billingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/BudgetAmount.java
  11. +8 −0 ...budgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/BudgetAmountOrBuilder.java
  12. +8 −16 ...ud-billingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/BudgetModel.java
  13. +1 −1 ...oud-billingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/BudgetName.java
  14. +24 −0 ...illingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/BudgetOrBuilder.java
  15. +12 −20 ...dgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/BudgetServiceOuterClass.java
  16. +30 −1 ...ngbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/CreateBudgetRequest.java
  17. +8 −0 ...-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/CreateBudgetRequestOrBuilder.java
  18. +22 −1 ...ngbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/DeleteBudgetRequest.java
  19. +4 −0 ...-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/DeleteBudgetRequestOrBuilder.java
  20. +111 −14 ...e-cloud-billingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/Filter.java
  21. +24 −0 ...illingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/FilterOrBuilder.java
  22. +22 −1 ...llingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/GetBudgetRequest.java
  23. +4 −0 ...ets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/GetBudgetRequestOrBuilder.java
  24. +6 −0 ...llingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/LastPeriodAmount.java
  25. +47 −1 ...ingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/ListBudgetsRequest.java
  26. +10 −0 ...s-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/ListBudgetsRequestOrBuilder.java
  27. +22 −3 ...ngbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/ListBudgetsResponse.java
  28. +4 −0 ...-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/ListBudgetsResponseOrBuilder.java
  29. +40 −2 ...-billingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/ThresholdRule.java
  30. +6 −0 ...udgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/ThresholdRuleOrBuilder.java
  31. +22 −1 ...ngbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/UpdateBudgetRequest.java
  32. +8 −0 ...-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/UpdateBudgetRequestOrBuilder.java
  33. +0 −4 ...d-billingbudgets-v1beta1/src/main/proto/google/cloud/billing/budgets/v1beta1/budget_service.proto
  34. +412 −5 synth.metadata
@@ -44,13 +44,26 @@ test)
bash .kokoro/coerce_logs.sh
;;
lint)
mvn com.coveo:fmt-maven-plugin:check
mvn \
-Penable-samples \
com.coveo:fmt-maven-plugin:check
;;
javadoc)
mvn javadoc:javadoc javadoc:test-javadoc
;;
integration)
mvn -B ${INTEGRATION_TEST_ARGS} \
-Penable-integration-tests \
-DtrimStackTrace=false \
-Dclirr.skip=true \
-Denforcer.skip=true \
-fae \
verify
bash .kokoro/coerce_logs.sh
;;
samples)
mvn -B \
-Penable-samples \
-DtrimStackTrace=false \
-Dclirr.skip=true \
-Denforcer.skip=true \
@@ -0,0 +1,31 @@
# Format: //devtools/kokoro/config/proto/build.proto

# Configure the docker image for kokoro-trampoline.
env_vars: {
key: "TRAMPOLINE_IMAGE"
value: "gcr.io/cloud-devrel-kokoro-resources/java8"
}

env_vars: {
key: "JOB_TYPE"
value: "samples"
}

env_vars: {
key: "GCLOUD_PROJECT"
value: "gcloud-devel"
}

env_vars: {
key: "GOOGLE_APPLICATION_CREDENTIALS"
value: "keystore/73713_java_it_service_account"
}

before_action {
fetch_keystore {
keystore_resource {
keystore_config_id: 73713
keyname: "java_it_service_account"
}
}
}
@@ -0,0 +1,31 @@
# Format: //devtools/kokoro/config/proto/build.proto

# Configure the docker image for kokoro-trampoline.
env_vars: {
key: "TRAMPOLINE_IMAGE"
value: "gcr.io/cloud-devrel-kokoro-resources/java8"
}

env_vars: {
key: "JOB_TYPE"
value: "samples"
}

env_vars: {
key: "GCLOUD_PROJECT"
value: "gcloud-devel"
}

env_vars: {
key: "GOOGLE_APPLICATION_CREDENTIALS"
value: "keystore/73713_java_it_service_account"
}

before_action {
fetch_keystore {
keystore_resource {
keystore_config_id: 73713
keyname: "java_it_service_account"
}
}
}
@@ -0,0 +1,31 @@
# Format: //devtools/kokoro/config/proto/build.proto

# Configure the docker image for kokoro-trampoline.
env_vars: {
key: "TRAMPOLINE_IMAGE"
value: "gcr.io/cloud-devrel-kokoro-resources/java8"
}

env_vars: {
key: "JOB_TYPE"
value: "samples"
}

env_vars: {
key: "GCLOUD_PROJECT"
value: "gcloud-devel"
}

env_vars: {
key: "GOOGLE_APPLICATION_CREDENTIALS"
value: "keystore/73713_java_it_service_account"
}

before_action {
fetch_keystore {
keystore_resource {
keystore_config_id: 73713
keyname: "java_it_service_account"
}
}
}
@@ -25,4 +25,106 @@ information on using pull requests.
## Community Guidelines

This project follows
[Google's Open Source Community Guidelines](https://opensource.google.com/conduct/).
[Google's Open Source Community Guidelines](https://opensource.google.com/conduct/).

## Building the project

To build, package, and run all unit tests run the command

```
mvn clean verify
```

### Running Integration tests

To include integration tests when building the project, you need access to
a GCP Project with a valid service account.

For instructions on how to generate a service account and corresponding
credentials JSON see: [Creating a Service Account][1].

Then run the following to build, package, run all unit tests and run all
integration tests.

```bash
export GOOGLE_APPLICATION_CREDENTIALS=/path/to/service/account.json
mvn -Penable-integration-tests clean verify
```

## Code Samples

Code Samples must be bundled in separate Maven modules, and guarded by a
Maven profile with the name `enable-samples`.

The samples must be separate from the primary project for a few reasons:
1. Primary projects have a minimum Java version of Java 7 whereas samples have
a minimum Java version of Java 8. Due to this we need the ability to
selectively exclude samples from a build run.
2. Many code samples depend on external GCP services and need
credentials to access the service.
3. Code samples are not released as Maven artifacts and must be excluded from
release builds.

### Building

```bash
mvn -Penable-samples clean verify
```

Some samples require access to GCP services and require a service account:

```bash
export GOOGLE_APPLICATION_CREDENTIALS=/path/to/service/account.json
mvn -Penable-samples clean verify
```

### Profile Config

1. To add samples in a profile to your Maven project, add the following to your
`pom.xml`

```xml
<project>
[...]
<profiles>
<profile>
<id>enable-samples</id>
<modules>
<module>sample</module>
</modules>
</profile>
</profiles>
[...]
</project>
```

2. [Activate](#profile-activation) the profile.
3. Define your samples in a normal Maven project in the `samples/` directory

### Profile Activation

To include code samples when building and testing the project, enable the
`enable-samples` Maven profile.

#### Command line

To activate the Maven profile on the command line add `-Penable-samples` to your
Maven command.

#### Maven `settings.xml`

To activate the Maven profile in your `~/.m2/settings.xml` add an entry of
`enable-samples` following the instructions in [Active Profiles][2].

This method has the benefit of applying to all projects you build (and is
respected by IntelliJ IDEA) and is recommended if you are going to be
contributing samples to several projects.

#### IntelliJ IDEA

To activate the Maven Profile inside IntelliJ IDEA, follow the instructions in
[Activate Maven profiles][3] to activate `enable-samples`.

[1]: https://cloud.google.com/docs/authentication/getting-started#creating_a_service_account
[2]: https://maven.apache.org/settings.html#Active_Profiles
[3]: https://www.jetbrains.com/help/idea/work-with-maven-profiles.html#activate_maven_profiles
@@ -44,6 +44,12 @@ private AllUpdatesRule() {
schemaVersion_ = "";
}

@java.lang.Override
@SuppressWarnings({"unused"})
protected java.lang.Object newInstance(UnusedPrivateParameter unused) {
return new AllUpdatesRule();
}

@java.lang.Override
public final com.google.protobuf.UnknownFieldSet getUnknownFields() {
return this.unknownFields;
@@ -57,7 +63,6 @@ private AllUpdatesRule(
if (extensionRegistry == null) {
throw new java.lang.NullPointerException();
}
int mutable_bitField0_ = 0;
com.google.protobuf.UnknownFieldSet.Builder unknownFields =
com.google.protobuf.UnknownFieldSet.newBuilder();
try {
@@ -136,6 +141,8 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
* </pre>
*
* <code>string pubsub_topic = 1 [(.google.api.field_behavior) = REQUIRED];</code>
*
* @return The pubsubTopic.
*/
public java.lang.String getPubsubTopic() {
java.lang.Object ref = pubsubTopic_;
@@ -166,6 +173,8 @@ public java.lang.String getPubsubTopic() {
* </pre>
*
* <code>string pubsub_topic = 1 [(.google.api.field_behavior) = REQUIRED];</code>
*
* @return The bytes for pubsubTopic.
*/
public com.google.protobuf.ByteString getPubsubTopicBytes() {
java.lang.Object ref = pubsubTopic_;
@@ -191,6 +200,8 @@ public com.google.protobuf.ByteString getPubsubTopicBytes() {
* </pre>
*
* <code>string schema_version = 2 [(.google.api.field_behavior) = REQUIRED];</code>
*
* @return The schemaVersion.
*/
public java.lang.String getSchemaVersion() {
java.lang.Object ref = schemaVersion_;
@@ -213,6 +224,8 @@ public java.lang.String getSchemaVersion() {
* </pre>
*
* <code>string schema_version = 2 [(.google.api.field_behavior) = REQUIRED];</code>
*
* @return The bytes for schemaVersion.
*/
public com.google.protobuf.ByteString getSchemaVersionBytes() {
java.lang.Object ref = schemaVersion_;
@@ -582,6 +595,8 @@ public Builder mergeFrom(
* </pre>
*
* <code>string pubsub_topic = 1 [(.google.api.field_behavior) = REQUIRED];</code>
*
* @return The pubsubTopic.
*/
public java.lang.String getPubsubTopic() {
java.lang.Object ref = pubsubTopic_;
@@ -612,6 +627,8 @@ public java.lang.String getPubsubTopic() {
* </pre>
*
* <code>string pubsub_topic = 1 [(.google.api.field_behavior) = REQUIRED];</code>
*
* @return The bytes for pubsubTopic.
*/
public com.google.protobuf.ByteString getPubsubTopicBytes() {
java.lang.Object ref = pubsubTopic_;
@@ -642,6 +659,9 @@ public com.google.protobuf.ByteString getPubsubTopicBytes() {
* </pre>
*
* <code>string pubsub_topic = 1 [(.google.api.field_behavior) = REQUIRED];</code>
*
* @param value The pubsubTopic to set.
* @return This builder for chaining.
*/
public Builder setPubsubTopic(java.lang.String value) {
if (value == null) {
@@ -670,6 +690,8 @@ public Builder setPubsubTopic(java.lang.String value) {
* </pre>
*
* <code>string pubsub_topic = 1 [(.google.api.field_behavior) = REQUIRED];</code>
*
* @return This builder for chaining.
*/
public Builder clearPubsubTopic() {

@@ -695,6 +717,9 @@ public Builder clearPubsubTopic() {
* </pre>
*
* <code>string pubsub_topic = 1 [(.google.api.field_behavior) = REQUIRED];</code>
*
* @param value The bytes for pubsubTopic to set.
* @return This builder for chaining.
*/
public Builder setPubsubTopicBytes(com.google.protobuf.ByteString value) {
if (value == null) {
@@ -718,6 +743,8 @@ public Builder setPubsubTopicBytes(com.google.protobuf.ByteString value) {
* </pre>
*
* <code>string schema_version = 2 [(.google.api.field_behavior) = REQUIRED];</code>
*
* @return The schemaVersion.
*/
public java.lang.String getSchemaVersion() {
java.lang.Object ref = schemaVersion_;
@@ -740,6 +767,8 @@ public java.lang.String getSchemaVersion() {
* </pre>
*
* <code>string schema_version = 2 [(.google.api.field_behavior) = REQUIRED];</code>
*
* @return The bytes for schemaVersion.
*/
public com.google.protobuf.ByteString getSchemaVersionBytes() {
java.lang.Object ref = schemaVersion_;
@@ -762,6 +791,9 @@ public com.google.protobuf.ByteString getSchemaVersionBytes() {
* </pre>
*
* <code>string schema_version = 2 [(.google.api.field_behavior) = REQUIRED];</code>
*
* @param value The schemaVersion to set.
* @return This builder for chaining.
*/
public Builder setSchemaVersion(java.lang.String value) {
if (value == null) {
@@ -782,6 +814,8 @@ public Builder setSchemaVersion(java.lang.String value) {
* </pre>
*
* <code>string schema_version = 2 [(.google.api.field_behavior) = REQUIRED];</code>
*
* @return This builder for chaining.
*/
public Builder clearSchemaVersion() {

@@ -799,6 +833,9 @@ public Builder clearSchemaVersion() {
* </pre>
*
* <code>string schema_version = 2 [(.google.api.field_behavior) = REQUIRED];</code>
*
* @param value The bytes for schemaVersion to set.
* @return This builder for chaining.
*/
public Builder setSchemaVersionBytes(com.google.protobuf.ByteString value) {
if (value == null) {

0 comments on commit 71e8999

Please sign in to comment.