docs: [cloudchannel] A comment for service `CloudChannelReportsServic…

…e` is changed (#10175) * docs: A comment for service `CloudChannelReportsService` is changed docs: A comment for method `RunReportJob` in service `CloudChannelReportsService` is changed docs: A comment for method `FetchReportResults` in service `CloudChannelReportsService` is changed docs: A comment for method `ListReports` in service `CloudChannelReportsService` is changed PiperOrigin-RevId: 592812793 Source-Link: googleapis/googleapis@f3c9569 Source-Link: https://github.com/googleapis/googleapis-gen/commit/d705bd449db1c759478a5e9e05b0375220c9ccf0 Copy-Tag: eyJwIjoiamF2YS1jaGFubmVsLy5Pd2xCb3QueWFtbCIsImgiOiJkNzA1YmQ0NDlkYjFjNzU5NDc4YTVlOWUwNWIwMzc1MjIwYzljY2YwIn0= * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
googleapis · Jan 2, 2024 · 8675fa6 · 8675fa6
1 parent 1e65292
commit 8675fa6
Show file tree

Hide file tree

Showing 41 changed files with 423 additions and 96 deletions.
diff --git a/java-channel/README.md b/java-channel/README.md
@@ -195,7 +195,7 @@ Java is a registered trademark of Oracle and/or its affiliates.
 [kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java11.html
 [stability-image]: https://img.shields.io/badge/stability-stable-green
 [maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-channel.svg
-[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-channel/3.34.0
+[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-channel/3.36.0
 [authentication]: https://github.com/googleapis/google-cloud-java#authentication
 [auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes
 [predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles

diff --git a/...d-channel/src/main/java/com/google/cloud/channel/v1/CloudChannelReportsServiceClient.java b/...d-channel/src/main/java/com/google/cloud/channel/v1/CloudChannelReportsServiceClient.java
@@ -43,6 +43,9 @@
  * retrieve and combine a variety of data in Cloud Channel for multiple products (Google Cloud,
  * Google Voice, and Google Workspace.)
  *
+ * <p>Deprecated: This service is being deprecated. Please use [Export Channel Services data to
+ * BigQuery](https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery) instead.
+ *
  * <p>This class provides the ability to make remote calls to the backing service through method
  * calls that map to API methods. Sample code to get started:
  *
@@ -139,7 +142,10 @@
  * }</pre>
  *
  * <p>Please refer to the GitHub repository's samples for more quickstart code snippets.
+ *
+ * @deprecated This class is deprecated and will be removed in the next major version update.
  */
+@Deprecated
 @Generated("by gapic-generator-java")
 public class CloudChannelReportsServiceClient implements BackgroundResource {
   private final CloudChannelReportsServiceSettings settings;
@@ -245,6 +251,9 @@ public final OperationsClient getHttpJsonOperationsClient() {
    * with the
    * [RunReportJobResponse.report_job][google.cloud.channel.v1.RunReportJobResponse.report_job].
    *
+   * <p>Deprecated: Please use [Export Channel Services data to
+   * BigQuery](https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery) instead.
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -269,7 +278,9 @@ public final OperationsClient getHttpJsonOperationsClient() {
    *
    * @param request The request object containing all of the parameters for the API call.
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+   * @deprecated This method is deprecated and will be removed in the next major version update.
    */
+  @Deprecated
   public final OperationFuture<RunReportJobResponse, OperationMetadata> runReportJobAsync(
       RunReportJobRequest request) {
     return runReportJobOperationCallable().futureCall(request);
@@ -303,6 +314,9 @@ public final OperationFuture<RunReportJobResponse, OperationMetadata> runReportJ
    * with the
    * [RunReportJobResponse.report_job][google.cloud.channel.v1.RunReportJobResponse.report_job].
    *
+   * <p>Deprecated: Please use [Export Channel Services data to
+   * BigQuery](https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery) instead.
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -326,7 +340,10 @@ public final OperationFuture<RunReportJobResponse, OperationMetadata> runReportJ
    *   RunReportJobResponse response = future.get();
    * }
    * }</pre>
+   *
+   * @deprecated This method is deprecated and will be removed in the next major version update.
    */
+  @Deprecated
   public final OperationCallable<RunReportJobRequest, RunReportJobResponse, OperationMetadata>
       runReportJobOperationCallable() {
     return stub.runReportJobOperationCallable();
@@ -360,6 +377,9 @@ public final OperationFuture<RunReportJobResponse, OperationMetadata> runReportJ
    * with the
    * [RunReportJobResponse.report_job][google.cloud.channel.v1.RunReportJobResponse.report_job].
    *
+   * <p>Deprecated: Please use [Export Channel Services data to
+   * BigQuery](https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery) instead.
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -383,7 +403,10 @@ public final OperationFuture<RunReportJobResponse, OperationMetadata> runReportJ
    *   Operation response = future.get();
    * }
    * }</pre>
+   *
+   * @deprecated This method is deprecated and will be removed in the next major version update.
    */
+  @Deprecated
   public final UnaryCallable<RunReportJobRequest, Operation> runReportJobCallable() {
     return stub.runReportJobCallable();
   }
@@ -393,6 +416,9 @@ public final UnaryCallable<RunReportJobRequest, Operation> runReportJobCallable(
    * Retrieves data generated by
    * [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob].
    *
+   * <p>Deprecated: Please use [Export Channel Services data to
+   * BigQuery](https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery) instead.
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -415,7 +441,9 @@ public final UnaryCallable<RunReportJobRequest, Operation> runReportJobCallable(
    *     [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob].
    *     Report_job uses the format: accounts/{account_id}/reportJobs/{report_job_id}
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+   * @deprecated This method is deprecated and will be removed in the next major version update.
    */
+  @Deprecated
   public final FetchReportResultsPagedResponse fetchReportResults(ReportJobName reportJob) {
     FetchReportResultsRequest request =
         FetchReportResultsRequest.newBuilder()
@@ -429,6 +457,9 @@ public final FetchReportResultsPagedResponse fetchReportResults(ReportJobName re
    * Retrieves data generated by
    * [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob].
    *
+   * <p>Deprecated: Please use [Export Channel Services data to
+   * BigQuery](https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery) instead.
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -451,7 +482,9 @@ public final FetchReportResultsPagedResponse fetchReportResults(ReportJobName re
    *     [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob].
    *     Report_job uses the format: accounts/{account_id}/reportJobs/{report_job_id}
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+   * @deprecated This method is deprecated and will be removed in the next major version update.
    */
+  @Deprecated
   public final FetchReportResultsPagedResponse fetchReportResults(String reportJob) {
     FetchReportResultsRequest request =
         FetchReportResultsRequest.newBuilder().setReportJob(reportJob).build();
@@ -463,6 +496,9 @@ public final FetchReportResultsPagedResponse fetchReportResults(String reportJob
    * Retrieves data generated by
    * [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob].
    *
+   * <p>Deprecated: Please use [Export Channel Services data to
+   * BigQuery](https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery) instead.
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -489,7 +525,9 @@ public final FetchReportResultsPagedResponse fetchReportResults(String reportJob
    *
    * @param request The request object containing all of the parameters for the API call.
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+   * @deprecated This method is deprecated and will be removed in the next major version update.
    */
+  @Deprecated
   public final FetchReportResultsPagedResponse fetchReportResults(
       FetchReportResultsRequest request) {
     return fetchReportResultsPagedCallable().call(request);
@@ -500,6 +538,9 @@ public final FetchReportResultsPagedResponse fetchReportResults(
    * Retrieves data generated by
    * [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob].
    *
+   * <p>Deprecated: Please use [Export Channel Services data to
+   * BigQuery](https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery) instead.
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -525,7 +566,10 @@ public final FetchReportResultsPagedResponse fetchReportResults(
    *   }
    * }
    * }</pre>
+   *
+   * @deprecated This method is deprecated and will be removed in the next major version update.
    */
+  @Deprecated
   public final UnaryCallable<FetchReportResultsRequest, FetchReportResultsPagedResponse>
       fetchReportResultsPagedCallable() {
     return stub.fetchReportResultsPagedCallable();
@@ -536,6 +580,9 @@ public final FetchReportResultsPagedResponse fetchReportResults(
    * Retrieves data generated by
    * [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob].
    *
+   * <p>Deprecated: Please use [Export Channel Services data to
+   * BigQuery](https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery) instead.
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -568,7 +615,10 @@ public final FetchReportResultsPagedResponse fetchReportResults(
    *   }
    * }
    * }</pre>
+   *
+   * @deprecated This method is deprecated and will be removed in the next major version update.
    */
+  @Deprecated
   public final UnaryCallable<FetchReportResultsRequest, FetchReportResultsResponse>
       fetchReportResultsCallable() {
     return stub.fetchReportResultsCallable();
@@ -579,6 +629,9 @@ public final FetchReportResultsPagedResponse fetchReportResults(
    * Lists the reports that RunReportJob can run. These reports include an ID, a description, and
    * the list of columns that will be in the result.
    *
+   * <p>Deprecated: Please use [Export Channel Services data to
+   * BigQuery](https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery) instead.
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -599,7 +652,9 @@ public final FetchReportResultsPagedResponse fetchReportResults(
    * @param parent Required. The resource name of the partner account to list available reports for.
    *     Parent uses the format: accounts/{account_id}
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+   * @deprecated This method is deprecated and will be removed in the next major version update.
    */
+  @Deprecated
   public final ListReportsPagedResponse listReports(String parent) {
     ListReportsRequest request = ListReportsRequest.newBuilder().setParent(parent).build();
     return listReports(request);
@@ -610,6 +665,9 @@ public final ListReportsPagedResponse listReports(String parent) {
    * Lists the reports that RunReportJob can run. These reports include an ID, a description, and
    * the list of columns that will be in the result.
    *
+   * <p>Deprecated: Please use [Export Channel Services data to
+   * BigQuery](https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery) instead.
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -635,7 +693,9 @@ public final ListReportsPagedResponse listReports(String parent) {
    *
    * @param request The request object containing all of the parameters for the API call.
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+   * @deprecated This method is deprecated and will be removed in the next major version update.
    */
+  @Deprecated
   public final ListReportsPagedResponse listReports(ListReportsRequest request) {
     return listReportsPagedCallable().call(request);
   }
@@ -645,6 +705,9 @@ public final ListReportsPagedResponse listReports(ListReportsRequest request) {
    * Lists the reports that RunReportJob can run. These reports include an ID, a description, and
    * the list of columns that will be in the result.
    *
+   * <p>Deprecated: Please use [Export Channel Services data to
+   * BigQuery](https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery) instead.
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -670,7 +733,10 @@ public final ListReportsPagedResponse listReports(ListReportsRequest request) {
    *   }
    * }
    * }</pre>
+   *
+   * @deprecated This method is deprecated and will be removed in the next major version update.
    */
+  @Deprecated
   public final UnaryCallable<ListReportsRequest, ListReportsPagedResponse>
       listReportsPagedCallable() {
     return stub.listReportsPagedCallable();
@@ -681,6 +747,9 @@ public final ListReportsPagedResponse listReports(ListReportsRequest request) {
    * Lists the reports that RunReportJob can run. These reports include an ID, a description, and
    * the list of columns that will be in the result.
    *
+   * <p>Deprecated: Please use [Export Channel Services data to
+   * BigQuery](https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery) instead.
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -713,7 +782,10 @@ public final ListReportsPagedResponse listReports(ListReportsRequest request) {
    *   }
    * }
    * }</pre>
+   *
+   * @deprecated This method is deprecated and will be removed in the next major version update.
    */
+  @Deprecated
   public final UnaryCallable<ListReportsRequest, ListReportsResponse> listReportsCallable() {
     return stub.listReportsCallable();
   }

diff --git a/...channel/src/main/java/com/google/cloud/channel/v1/CloudChannelReportsServiceSettings.java b/...channel/src/main/java/com/google/cloud/channel/v1/CloudChannelReportsServiceSettings.java
@@ -75,32 +75,55 @@
  * CloudChannelReportsServiceSettings cloudChannelReportsServiceSettings =
  *     cloudChannelReportsServiceSettingsBuilder.build();
  * }</pre>
+ *
+ * @deprecated This class is deprecated and will be removed in the next major version update.
  */
+@Deprecated
 @Generated("by gapic-generator-java")
 public class CloudChannelReportsServiceSettings
     extends ClientSettings<CloudChannelReportsServiceSettings> {
 
-  /** Returns the object with the settings used for calls to runReportJob. */
+  /**
+   * Returns the object with the settings used for calls to runReportJob.
+   *
+   * @deprecated This method is deprecated and will be removed in the next major version update.
+   */
+  @Deprecated
   public UnaryCallSettings<RunReportJobRequest, Operation> runReportJobSettings() {
     return ((CloudChannelReportsServiceStubSettings) getStubSettings()).runReportJobSettings();
   }
 
-  /** Returns the object with the settings used for calls to runReportJob. */
+  /**
+   * Returns the object with the settings used for calls to runReportJob.
+   *
+   * @deprecated This method is deprecated and will be removed in the next major version update.
+   */
+  @Deprecated
   public OperationCallSettings<RunReportJobRequest, RunReportJobResponse, OperationMetadata>
       runReportJobOperationSettings() {
     return ((CloudChannelReportsServiceStubSettings) getStubSettings())
         .runReportJobOperationSettings();
   }
 
-  /** Returns the object with the settings used for calls to fetchReportResults. */
+  /**
+   * Returns the object with the settings used for calls to fetchReportResults.
+   *
+   * @deprecated This method is deprecated and will be removed in the next major version update.
+   */
+  @Deprecated
   public PagedCallSettings<
           FetchReportResultsRequest, FetchReportResultsResponse, FetchReportResultsPagedResponse>
       fetchReportResultsSettings() {
     return ((CloudChannelReportsServiceStubSettings) getStubSettings())
         .fetchReportResultsSettings();
   }
 
-  /** Returns the object with the settings used for calls to listReports. */
+  /**
+   * Returns the object with the settings used for calls to listReports.
+   *
+   * @deprecated This method is deprecated and will be removed in the next major version update.
+   */
+  @Deprecated
   public PagedCallSettings<ListReportsRequest, ListReportsResponse, ListReportsPagedResponse>
       listReportsSettings() {
     return ((CloudChannelReportsServiceStubSettings) getStubSettings()).listReportsSettings();
@@ -222,26 +245,46 @@ public Builder applyToAllUnaryMethods(
       return this;
     }
 
-    /** Returns the builder for the settings used for calls to runReportJob. */
+    /**
+     * Returns the builder for the settings used for calls to runReportJob.
+     *
+     * @deprecated This method is deprecated and will be removed in the next major version update.
+     */
+    @Deprecated
     public UnaryCallSettings.Builder<RunReportJobRequest, Operation> runReportJobSettings() {
       return getStubSettingsBuilder().runReportJobSettings();
     }
 
-    /** Returns the builder for the settings used for calls to runReportJob. */
+    /**
+     * Returns the builder for the settings used for calls to runReportJob.
+     *
+     * @deprecated This method is deprecated and will be removed in the next major version update.
+     */
+    @Deprecated
     public OperationCallSettings.Builder<
             RunReportJobRequest, RunReportJobResponse, OperationMetadata>
         runReportJobOperationSettings() {
       return getStubSettingsBuilder().runReportJobOperationSettings();
     }
 
-    /** Returns the builder for the settings used for calls to fetchReportResults. */
+    /**
+     * Returns the builder for the settings used for calls to fetchReportResults.
+     *
+     * @deprecated This method is deprecated and will be removed in the next major version update.
+     */
+    @Deprecated
     public PagedCallSettings.Builder<
             FetchReportResultsRequest, FetchReportResultsResponse, FetchReportResultsPagedResponse>
         fetchReportResultsSettings() {
       return getStubSettingsBuilder().fetchReportResultsSettings();
     }
 
-    /** Returns the builder for the settings used for calls to listReports. */
+    /**
+     * Returns the builder for the settings used for calls to listReports.
+     *
+     * @deprecated This method is deprecated and will be removed in the next major version update.
+     */
+    @Deprecated
     public PagedCallSettings.Builder<
             ListReportsRequest, ListReportsResponse, ListReportsPagedResponse>
         listReportsSettings() {

diff --git a/...-channel/google-cloud-channel/src/main/java/com/google/cloud/channel/v1/package-info.java b/...-channel/google-cloud-channel/src/main/java/com/google/cloud/channel/v1/package-info.java
@@ -25,6 +25,9 @@
  * retrieve and combine a variety of data in Cloud Channel for multiple products (Google Cloud,
  * Google Voice, and Google Workspace.)
  *
+ * <p>Deprecated: This service is being deprecated. Please use [Export Channel Services data to
+ * BigQuery](https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery) instead.
+ *
  * <p>Sample for CloudChannelReportsServiceClient:
  *
  * <pre>{@code