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
googleapis · Dec 21, 2023 · f3c9569 · f3c9569
1 parent 0e35fc2
commit f3c9569
Showing 1 changed file with 47 additions and 0 deletions.
diff --git a/google/cloud/channel/v1/reports_service.proto b/google/cloud/channel/v1/reports_service.proto
@@ -36,7 +36,13 @@ option java_package = "com.google.cloud.channel.v1";
 // CloudChannelReportsService lets Google Cloud resellers and
 // distributors retrieve and combine a variety of data in Cloud Channel for
 // multiple products (Google Cloud, Google Voice, and Google Workspace.)
+//
+// 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.
 service CloudChannelReportsService {
+  option deprecated = true;
   option (google.api.default_host) = "cloudchannel.googleapis.com";
   option (google.api.oauth_scopes) =
       "https://www.googleapis.com/auth/apps.reports.usage.readonly";
@@ -66,7 +72,12 @@ service CloudChannelReportsService {
   // [CloudChannelReportsService.FetchReportResults][google.cloud.channel.v1.CloudChannelReportsService.FetchReportResults]
   // with the
   // [RunReportJobResponse.report_job][google.cloud.channel.v1.RunReportJobResponse.report_job].
+  //
+  // Deprecated: Please use [Export Channel Services data to
+  // BigQuery](https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery)
+  // instead.
   rpc RunReportJob(RunReportJobRequest) returns (google.longrunning.Operation) {
+    option deprecated = true;
     option (google.api.http) = {
       post: "/v1/{name=accounts/*/reports/*}:run"
       body: "*"
@@ -79,8 +90,13 @@ service CloudChannelReportsService {
 
   // Retrieves data generated by
   // [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob].
+  //
+  // Deprecated: Please use [Export Channel Services data to
+  // BigQuery](https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery)
+  // instead.
   rpc FetchReportResults(FetchReportResultsRequest)
       returns (FetchReportResultsResponse) {
+    option deprecated = true;
     option (google.api.http) = {
       post: "/v1/{report_job=accounts/*/reportJobs/*}:fetchReportResults"
       body: "*"
@@ -90,7 +106,12 @@ service CloudChannelReportsService {
 
   // 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.
+  //
+  // Deprecated: Please use [Export Channel Services data to
+  // BigQuery](https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery)
+  // instead.
   rpc ListReports(ListReportsRequest) returns (ListReportsResponse) {
+    option deprecated = true;
     option (google.api.http) = {
       get: "/v1/{parent=accounts/*}/reports"
     };
@@ -101,6 +122,8 @@ service CloudChannelReportsService {
 // Request message for
 // [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob].
 message RunReportJobRequest {
+  option deprecated = true;
+
   // Required. The report's resource name. Specifies the account and report used
   // to generate report data. The report_id identifier is a UID (for example,
   // `613bf59q`).
@@ -138,6 +161,8 @@ message RunReportJobRequest {
 // Response message for
 // [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob].
 message RunReportJobResponse {
+  option deprecated = true;
+
   // Pass `report_job.name` to
   // [FetchReportResultsRequest.report_job][google.cloud.channel.v1.FetchReportResultsRequest.report_job]
   // to retrieve the report's results.
@@ -152,6 +177,8 @@ message RunReportJobResponse {
 // Request message for
 // [CloudChannelReportsService.FetchReportResults][google.cloud.channel.v1.CloudChannelReportsService.FetchReportResults].
 message FetchReportResultsRequest {
+  option deprecated = true;
+
   // Required. The report job created by
   // [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob].
   // Report_job uses the format:
@@ -188,6 +215,8 @@ message FetchReportResultsRequest {
 // [CloudChannelReportsService.FetchReportResults][google.cloud.channel.v1.CloudChannelReportsService.FetchReportResults].
 // Contains a tabular representation of the report results.
 message FetchReportResultsResponse {
+  option deprecated = true;
+
   // The metadata for the report results (display name, columns, row count, and
   // date ranges).
   ReportResultsMetadata report_metadata = 1;
@@ -205,6 +234,8 @@ message FetchReportResultsResponse {
 // Request message for
 // [CloudChannelReportsService.ListReports][google.cloud.channel.v1.CloudChannelReportsService.ListReports].
 message ListReportsRequest {
+  option deprecated = true;
+
   // Required. The resource name of the partner account to list available
   // reports for. Parent uses the format: accounts/{account_id}
   string parent = 1 [(google.api.field_behavior) = REQUIRED];
@@ -232,6 +263,8 @@ message ListReportsRequest {
 // Response message for
 // [CloudChannelReportsService.ListReports][google.cloud.channel.v1.CloudChannelReportsService.ListReports].
 message ListReportsResponse {
+  option deprecated = true;
+
   // The reports available to the partner.
   repeated Report reports = 1;
 
@@ -245,6 +278,7 @@ message ListReportsResponse {
 // [FetchReportResultsRequest.report_job][google.cloud.channel.v1.FetchReportResultsRequest.report_job]
 // and the status of the operation.
 message ReportJob {
+  option deprecated = true;
   option (google.api.resource) = {
     type: "cloudchannel.googleapis.com/ReportJob"
     pattern: "accounts/{account}/reportJobs/{report_job}"
@@ -264,6 +298,8 @@ message ReportJob {
 // and
 // [CloudChannelReportsService.FetchReportResults][google.cloud.channel.v1.CloudChannelReportsService.FetchReportResults].
 message ReportResultsMetadata {
+  option deprecated = true;
+
   // Details of the completed report.
   Report report = 1;
 
@@ -285,6 +321,8 @@ message ReportResultsMetadata {
 // The definition of a report column. Specifies the data properties
 // in the corresponding position of the report rows.
 message Column {
+  option deprecated = true;
+
   // Available data types for columns. Corresponds to the fields in the
   // ReportValue `oneof` field.
   enum DataType {
@@ -326,6 +364,8 @@ message Column {
 
 // A representation of usage or invoice date ranges.
 message DateRange {
+  option deprecated = true;
+
   // The earliest usage date time (inclusive).
   //
   // If you use time groupings (daily, weekly, etc), each group uses
@@ -357,6 +397,8 @@ message DateRange {
 
 // A row of report values.
 message Row {
+  option deprecated = true;
+
   // The list of values in the row.
   repeated ReportValue values = 1;
 
@@ -367,6 +409,8 @@ message Row {
 
 // A single report value.
 message ReportValue {
+  option deprecated = true;
+
   // A single report value.
   oneof value {
     // A value of type `string`.
@@ -394,6 +438,8 @@ message ReportValue {
 
 // Status of a report generation process.
 message ReportStatus {
+  option deprecated = true;
+
   // Available states of report generation.
   enum State {
     // Not used.
@@ -426,6 +472,7 @@ message ReportStatus {
 // For example, "Google Cloud Daily Spend", "Google Workspace License Activity",
 // etc.
 message Report {
+  option deprecated = true;
   option (google.api.resource) = {
     type: "cloudchannel.googleapis.com/Report"
     pattern: "accounts/{account}/reports/{report}"