feat: deprecate GroupName in favor of ErrorGroupName (#30)

* [CHANGE ME] Re-generated to pick up changes in the API or client library generator. * fix: deprecate GroupName and put back method as deprecated for compatibility * fix: modify synth.py to inject deprecated helpers Co-authored-by: Jeff Ching <chingor@google.com>
googleapis · Dec 23, 2019 · 5c2b4e2 · 5c2b4e2
1 parent b25499b
commit 5c2b4e2
Show file tree

Hide file tree

Showing 71 changed files with 4,109 additions and 1,358 deletions.
diff --git a/.github/release-please.yml b/.github/release-please.yml
@@ -1 +1,2 @@
 releaseType: java-yoshi
+bumpMinorPreMajor: true
diff --git a/.kokoro/build.sh b/.kokoro/build.sh
@@ -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
@@ -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
     ;;
@@ -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
diff --git a/.kokoro/dependencies.sh b/.kokoro/dependencies.sh
@@ -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
diff --git a/.kokoro/release/publish_javadoc.sh b/.kokoro/release/publish_javadoc.sh
@@ -33,7 +33,7 @@ python3 -m pip install gcp-docuploader
 # compile all packages
 mvn clean install -B -DskipTests=true
 
-NAME=clouderrorreporting
+NAME=google-cloud-errorreporting
 VERSION=$(grep ${NAME}: versions.txt | cut -d: -f3)
 
 # build the docs

diff --git a/...orting/src/main/java/com/google/cloud/errorreporting/v1beta1/ErrorGroupServiceClient.java b/...orting/src/main/java/com/google/cloud/errorreporting/v1beta1/ErrorGroupServiceClient.java
@@ -21,6 +21,7 @@
 import com.google.cloud.errorreporting.v1beta1.stub.ErrorGroupServiceStub;
 import com.google.cloud.errorreporting.v1beta1.stub.ErrorGroupServiceStubSettings;
 import com.google.devtools.clouderrorreporting.v1beta1.ErrorGroup;
+import com.google.devtools.clouderrorreporting.v1beta1.ErrorGroupName;
 import com.google.devtools.clouderrorreporting.v1beta1.GetGroupRequest;
 import com.google.devtools.clouderrorreporting.v1beta1.GroupName;
 import com.google.devtools.clouderrorreporting.v1beta1.UpdateGroupRequest;
@@ -38,7 +39,7 @@
  * <pre>
  * <code>
  * try (ErrorGroupServiceClient errorGroupServiceClient = ErrorGroupServiceClient.create()) {
- *   GroupName groupName = GroupName.of("[PROJECT]", "[GROUP]");
+ *   ErrorGroupName groupName = ErrorGroupName.of("[PROJECT]", "[GROUP]");
  *   ErrorGroup response = errorGroupServiceClient.getGroup(groupName);
  * }
  * </code>
@@ -149,7 +150,7 @@ public ErrorGroupServiceStub getStub() {
     return stub;
   }
 
-  // AUTO-GENERATED DOCUMENTATION AND METHOD
+  // Inserted by synthtool to preserve backwards-compatibility
   /**
    * Get the specified group.
    *
@@ -162,14 +163,16 @@ public ErrorGroupServiceStub getStub() {
    * }
    * </code></pre>
    *
-   * @param groupName [Required] The group resource name. Written as
+   * @param groupName Required. The group resource name. Written as
    *     &lt;code&gt;projects/&lt;var&gt;projectID&lt;/var&gt;/groups/&lt;var&gt;group_name&lt;/var&gt;&lt;/code&gt;.
    *     Call &lt;a href="/error-reporting/reference/rest/v1beta1/projects.groupStats/list"&gt;
    *     &lt;code&gt;groupStats.list&lt;/code&gt;&lt;/a&gt; to return a list of groups belonging to
    *     this project.
    *     <p>Example: &lt;code&gt;projects/my-project-123/groups/my-group&lt;/code&gt;
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+   * @deprecated Use ErrorGroupServiceClient#getGroup(ErrorGroupName)
    */
+  @Deprecated
   public final ErrorGroup getGroup(GroupName groupName) {
 
     GetGroupRequest request =
@@ -187,12 +190,42 @@ public final ErrorGroup getGroup(GroupName groupName) {
    *
    * <pre><code>
    * try (ErrorGroupServiceClient errorGroupServiceClient = ErrorGroupServiceClient.create()) {
-   *   GroupName groupName = GroupName.of("[PROJECT]", "[GROUP]");
+   *   ErrorGroupName groupName = ErrorGroupName.of("[PROJECT]", "[GROUP]");
+   *   ErrorGroup response = errorGroupServiceClient.getGroup(groupName);
+   * }
+   * </code></pre>
+   *
+   * @param groupName Required. The group resource name. Written as
+   *     &lt;code&gt;projects/&lt;var&gt;projectID&lt;/var&gt;/groups/&lt;var&gt;group_name&lt;/var&gt;&lt;/code&gt;.
+   *     Call &lt;a href="/error-reporting/reference/rest/v1beta1/projects.groupStats/list"&gt;
+   *     &lt;code&gt;groupStats.list&lt;/code&gt;&lt;/a&gt; to return a list of groups belonging to
+   *     this project.
+   *     <p>Example: &lt;code&gt;projects/my-project-123/groups/my-group&lt;/code&gt;
+   * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+   */
+  public final ErrorGroup getGroup(ErrorGroupName groupName) {
+
+    GetGroupRequest request =
+        GetGroupRequest.newBuilder()
+            .setGroupName(groupName == null ? null : groupName.toString())
+            .build();
+    return getGroup(request);
+  }
+
+  // AUTO-GENERATED DOCUMENTATION AND METHOD
+  /**
+   * Get the specified group.
+   *
+   * <p>Sample code:
+   *
+   * <pre><code>
+   * try (ErrorGroupServiceClient errorGroupServiceClient = ErrorGroupServiceClient.create()) {
+   *   ErrorGroupName groupName = ErrorGroupName.of("[PROJECT]", "[GROUP]");
    *   ErrorGroup response = errorGroupServiceClient.getGroup(groupName.toString());
    * }
    * </code></pre>
    *
-   * @param groupName [Required] The group resource name. Written as
+   * @param groupName Required. The group resource name. Written as
    *     &lt;code&gt;projects/&lt;var&gt;projectID&lt;/var&gt;/groups/&lt;var&gt;group_name&lt;/var&gt;&lt;/code&gt;.
    *     Call &lt;a href="/error-reporting/reference/rest/v1beta1/projects.groupStats/list"&gt;
    *     &lt;code&gt;groupStats.list&lt;/code&gt;&lt;/a&gt; to return a list of groups belonging to
@@ -214,7 +247,7 @@ public final ErrorGroup getGroup(String groupName) {
    *
    * <pre><code>
    * try (ErrorGroupServiceClient errorGroupServiceClient = ErrorGroupServiceClient.create()) {
-   *   GroupName groupName = GroupName.of("[PROJECT]", "[GROUP]");
+   *   ErrorGroupName groupName = ErrorGroupName.of("[PROJECT]", "[GROUP]");
    *   GetGroupRequest request = GetGroupRequest.newBuilder()
    *     .setGroupName(groupName.toString())
    *     .build();
@@ -237,7 +270,7 @@ public final ErrorGroup getGroup(GetGroupRequest request) {
    *
    * <pre><code>
    * try (ErrorGroupServiceClient errorGroupServiceClient = ErrorGroupServiceClient.create()) {
-   *   GroupName groupName = GroupName.of("[PROJECT]", "[GROUP]");
+   *   ErrorGroupName groupName = ErrorGroupName.of("[PROJECT]", "[GROUP]");
    *   GetGroupRequest request = GetGroupRequest.newBuilder()
    *     .setGroupName(groupName.toString())
    *     .build();
@@ -264,7 +297,7 @@ public final UnaryCallable<GetGroupRequest, ErrorGroup> getGroupCallable() {
    * }
    * </code></pre>
    *
-   * @param group [Required] The group which replaces the resource on the server.
+   * @param group Required. The group which replaces the resource on the server.
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
    */
   public final ErrorGroup updateGroup(ErrorGroup group) {

diff --git a/...orting/src/main/java/com/google/cloud/errorreporting/v1beta1/ErrorStatsServiceClient.java b/...orting/src/main/java/com/google/cloud/errorreporting/v1beta1/ErrorStatsServiceClient.java
@@ -181,17 +181,18 @@ public ErrorStatsServiceStub getStub() {
    * }
    * </code></pre>
    *
-   * @param projectName [Required] The resource name of the Google Cloud Platform project. Written
-   *     as &lt;code&gt;projects/&lt;/code&gt; plus the &lt;a
+   * @param projectName Required. The resource name of the Google Cloud Platform project. Written as
+   *     &lt;code&gt;projects/&lt;/code&gt; plus the &lt;a
    *     href="https://support.google.com/cloud/answer/6158840"&gt;Google Cloud Platform project
    *     ID&lt;/a&gt;.
    *     <p>Example: &lt;code&gt;projects/my-project-123&lt;/code&gt;.
-   * @param timeRange [Optional] List data for the given time range. If not set a default time range
-   *     is used. The field time_range_begin in the response will specify the beginning of this time
-   *     range. Only &lt;code&gt;ErrorGroupStats&lt;/code&gt; with a non-zero count in the given
-   *     time range are returned, unless the request contains an explicit group_id list. If a
-   *     group_id list is given, also &lt;code&gt;ErrorGroupStats&lt;/code&gt; with zero occurrences
-   *     are returned.
+   * @param timeRange Optional. List data for the given time range. If not set, a default time range
+   *     is used. The field &lt;code&gt;time_range_begin&lt;/code&gt; in the response will specify
+   *     the beginning of this time range. Only &lt;code&gt;ErrorGroupStats&lt;/code&gt; with a
+   *     non-zero count in the given time range are returned, unless the request contains an
+   *     explicit &lt;code&gt;group_id&lt;/code&gt; list. If a &lt;code&gt;group_id&lt;/code&gt;
+   *     list is given, also &lt;code&gt;ErrorGroupStats&lt;/code&gt; with zero occurrences are
+   *     returned.
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
    */
   public final ListGroupStatsPagedResponse listGroupStats(
@@ -220,17 +221,18 @@ public final ListGroupStatsPagedResponse listGroupStats(
    * }
    * </code></pre>
    *
-   * @param projectName [Required] The resource name of the Google Cloud Platform project. Written
-   *     as &lt;code&gt;projects/&lt;/code&gt; plus the &lt;a
+   * @param projectName Required. The resource name of the Google Cloud Platform project. Written as
+   *     &lt;code&gt;projects/&lt;/code&gt; plus the &lt;a
    *     href="https://support.google.com/cloud/answer/6158840"&gt;Google Cloud Platform project
    *     ID&lt;/a&gt;.
    *     <p>Example: &lt;code&gt;projects/my-project-123&lt;/code&gt;.
-   * @param timeRange [Optional] List data for the given time range. If not set a default time range
-   *     is used. The field time_range_begin in the response will specify the beginning of this time
-   *     range. Only &lt;code&gt;ErrorGroupStats&lt;/code&gt; with a non-zero count in the given
-   *     time range are returned, unless the request contains an explicit group_id list. If a
-   *     group_id list is given, also &lt;code&gt;ErrorGroupStats&lt;/code&gt; with zero occurrences
-   *     are returned.
+   * @param timeRange Optional. List data for the given time range. If not set, a default time range
+   *     is used. The field &lt;code&gt;time_range_begin&lt;/code&gt; in the response will specify
+   *     the beginning of this time range. Only &lt;code&gt;ErrorGroupStats&lt;/code&gt; with a
+   *     non-zero count in the given time range are returned, unless the request contains an
+   *     explicit &lt;code&gt;group_id&lt;/code&gt; list. If a &lt;code&gt;group_id&lt;/code&gt;
+   *     list is given, also &lt;code&gt;ErrorGroupStats&lt;/code&gt; with zero occurrences are
+   *     returned.
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
    */
   public final ListGroupStatsPagedResponse listGroupStats(
@@ -252,10 +254,8 @@ public final ListGroupStatsPagedResponse listGroupStats(
    * <pre><code>
    * try (ErrorStatsServiceClient errorStatsServiceClient = ErrorStatsServiceClient.create()) {
    *   ProjectName projectName = ProjectName.of("[PROJECT]");
-   *   QueryTimeRange timeRange = QueryTimeRange.newBuilder().build();
    *   ListGroupStatsRequest request = ListGroupStatsRequest.newBuilder()
    *     .setProjectName(projectName.toString())
-   *     .setTimeRange(timeRange)
    *     .build();
    *   for (ErrorGroupStats element : errorStatsServiceClient.listGroupStats(request).iterateAll()) {
    *     // doThingsWith(element);
@@ -279,10 +279,8 @@ public final ListGroupStatsPagedResponse listGroupStats(ListGroupStatsRequest re
    * <pre><code>
    * try (ErrorStatsServiceClient errorStatsServiceClient = ErrorStatsServiceClient.create()) {
    *   ProjectName projectName = ProjectName.of("[PROJECT]");
-   *   QueryTimeRange timeRange = QueryTimeRange.newBuilder().build();
    *   ListGroupStatsRequest request = ListGroupStatsRequest.newBuilder()
    *     .setProjectName(projectName.toString())
-   *     .setTimeRange(timeRange)
    *     .build();
    *   ApiFuture&lt;ListGroupStatsPagedResponse&gt; future = errorStatsServiceClient.listGroupStatsPagedCallable().futureCall(request);
    *   // Do something
@@ -306,10 +304,8 @@ public final ListGroupStatsPagedResponse listGroupStats(ListGroupStatsRequest re
    * <pre><code>
    * try (ErrorStatsServiceClient errorStatsServiceClient = ErrorStatsServiceClient.create()) {
    *   ProjectName projectName = ProjectName.of("[PROJECT]");
-   *   QueryTimeRange timeRange = QueryTimeRange.newBuilder().build();
    *   ListGroupStatsRequest request = ListGroupStatsRequest.newBuilder()
    *     .setProjectName(projectName.toString())
-   *     .setTimeRange(timeRange)
    *     .build();
    *   while (true) {
    *     ListGroupStatsResponse response = errorStatsServiceClient.listGroupStatsCallable().call(request);
@@ -347,10 +343,10 @@ public final ListGroupStatsPagedResponse listGroupStats(ListGroupStatsRequest re
    * }
    * </code></pre>
    *
-   * @param projectName [Required] The resource name of the Google Cloud Platform project. Written
-   *     as `projects/` plus the [Google Cloud Platform project
+   * @param projectName Required. The resource name of the Google Cloud Platform project. Written as
+   *     `projects/` plus the [Google Cloud Platform project
    *     ID](https://support.google.com/cloud/answer/6158840). Example: `projects/my-project-123`.
-   * @param groupId [Required] The group for which events shall be returned.
+   * @param groupId Required. The group for which events shall be returned.
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
    */
   public final ListEventsPagedResponse listEvents(ProjectName projectName, String groupId) {
@@ -378,10 +374,10 @@ public final ListEventsPagedResponse listEvents(ProjectName projectName, String
    * }
    * </code></pre>
    *
-   * @param projectName [Required] The resource name of the Google Cloud Platform project. Written
-   *     as `projects/` plus the [Google Cloud Platform project
+   * @param projectName Required. The resource name of the Google Cloud Platform project. Written as
+   *     `projects/` plus the [Google Cloud Platform project
    *     ID](https://support.google.com/cloud/answer/6158840). Example: `projects/my-project-123`.
-   * @param groupId [Required] The group for which events shall be returned.
+   * @param groupId Required. The group for which events shall be returned.
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
    */
   public final ListEventsPagedResponse listEvents(String projectName, String groupId) {
@@ -489,8 +485,8 @@ public final UnaryCallable<ListEventsRequest, ListEventsResponse> listEventsCall
    * }
    * </code></pre>
    *
-   * @param projectName [Required] The resource name of the Google Cloud Platform project. Written
-   *     as `projects/` plus the [Google Cloud Platform project
+   * @param projectName Required. The resource name of the Google Cloud Platform project. Written as
+   *     `projects/` plus the [Google Cloud Platform project
    *     ID](https://support.google.com/cloud/answer/6158840). Example: `projects/my-project-123`.
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
    */
@@ -516,8 +512,8 @@ public final DeleteEventsResponse deleteEvents(ProjectName projectName) {
    * }
    * </code></pre>
    *
-   * @param projectName [Required] The resource name of the Google Cloud Platform project. Written
-   *     as `projects/` plus the [Google Cloud Platform project
+   * @param projectName Required. The resource name of the Google Cloud Platform project. Written as
+   *     `projects/` plus the [Google Cloud Platform project
    *     ID](https://support.google.com/cloud/answer/6158840). Example: `projects/my-project-123`.
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
    */