Skip to content

Commit 8675fa6

Browse files
docs: [cloudchannel] A comment for service CloudChannelReportsService 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>
1 parent 1e65292 commit 8675fa6

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+423
-96
lines changed

java-channel/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ Java is a registered trademark of Oracle and/or its affiliates.
195195
[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java11.html
196196
[stability-image]: https://img.shields.io/badge/stability-stable-green
197197
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-channel.svg
198-
[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-channel/3.34.0
198+
[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-channel/3.36.0
199199
[authentication]: https://github.com/googleapis/google-cloud-java#authentication
200200
[auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes
201201
[predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles

java-channel/google-cloud-channel/src/main/java/com/google/cloud/channel/v1/CloudChannelReportsServiceClient.java

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,9 @@
4343
* retrieve and combine a variety of data in Cloud Channel for multiple products (Google Cloud,
4444
* Google Voice, and Google Workspace.)
4545
*
46+
* <p>Deprecated: This service is being deprecated. Please use [Export Channel Services data to
47+
* BigQuery](https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery) instead.
48+
*
4649
* <p>This class provides the ability to make remote calls to the backing service through method
4750
* calls that map to API methods. Sample code to get started:
4851
*
@@ -139,7 +142,10 @@
139142
* }</pre>
140143
*
141144
* <p>Please refer to the GitHub repository's samples for more quickstart code snippets.
145+
*
146+
* @deprecated This class is deprecated and will be removed in the next major version update.
142147
*/
148+
@Deprecated
143149
@Generated("by gapic-generator-java")
144150
public class CloudChannelReportsServiceClient implements BackgroundResource {
145151
private final CloudChannelReportsServiceSettings settings;
@@ -245,6 +251,9 @@ public final OperationsClient getHttpJsonOperationsClient() {
245251
* with the
246252
* [RunReportJobResponse.report_job][google.cloud.channel.v1.RunReportJobResponse.report_job].
247253
*
254+
* <p>Deprecated: Please use [Export Channel Services data to
255+
* BigQuery](https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery) instead.
256+
*
248257
* <p>Sample code:
249258
*
250259
* <pre>{@code
@@ -269,7 +278,9 @@ public final OperationsClient getHttpJsonOperationsClient() {
269278
*
270279
* @param request The request object containing all of the parameters for the API call.
271280
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
281+
* @deprecated This method is deprecated and will be removed in the next major version update.
272282
*/
283+
@Deprecated
273284
public final OperationFuture<RunReportJobResponse, OperationMetadata> runReportJobAsync(
274285
RunReportJobRequest request) {
275286
return runReportJobOperationCallable().futureCall(request);
@@ -303,6 +314,9 @@ public final OperationFuture<RunReportJobResponse, OperationMetadata> runReportJ
303314
* with the
304315
* [RunReportJobResponse.report_job][google.cloud.channel.v1.RunReportJobResponse.report_job].
305316
*
317+
* <p>Deprecated: Please use [Export Channel Services data to
318+
* BigQuery](https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery) instead.
319+
*
306320
* <p>Sample code:
307321
*
308322
* <pre>{@code
@@ -326,7 +340,10 @@ public final OperationFuture<RunReportJobResponse, OperationMetadata> runReportJ
326340
* RunReportJobResponse response = future.get();
327341
* }
328342
* }</pre>
343+
*
344+
* @deprecated This method is deprecated and will be removed in the next major version update.
329345
*/
346+
@Deprecated
330347
public final OperationCallable<RunReportJobRequest, RunReportJobResponse, OperationMetadata>
331348
runReportJobOperationCallable() {
332349
return stub.runReportJobOperationCallable();
@@ -360,6 +377,9 @@ public final OperationFuture<RunReportJobResponse, OperationMetadata> runReportJ
360377
* with the
361378
* [RunReportJobResponse.report_job][google.cloud.channel.v1.RunReportJobResponse.report_job].
362379
*
380+
* <p>Deprecated: Please use [Export Channel Services data to
381+
* BigQuery](https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery) instead.
382+
*
363383
* <p>Sample code:
364384
*
365385
* <pre>{@code
@@ -383,7 +403,10 @@ public final OperationFuture<RunReportJobResponse, OperationMetadata> runReportJ
383403
* Operation response = future.get();
384404
* }
385405
* }</pre>
406+
*
407+
* @deprecated This method is deprecated and will be removed in the next major version update.
386408
*/
409+
@Deprecated
387410
public final UnaryCallable<RunReportJobRequest, Operation> runReportJobCallable() {
388411
return stub.runReportJobCallable();
389412
}
@@ -393,6 +416,9 @@ public final UnaryCallable<RunReportJobRequest, Operation> runReportJobCallable(
393416
* Retrieves data generated by
394417
* [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob].
395418
*
419+
* <p>Deprecated: Please use [Export Channel Services data to
420+
* BigQuery](https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery) instead.
421+
*
396422
* <p>Sample code:
397423
*
398424
* <pre>{@code
@@ -415,7 +441,9 @@ public final UnaryCallable<RunReportJobRequest, Operation> runReportJobCallable(
415441
* [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob].
416442
* Report_job uses the format: accounts/{account_id}/reportJobs/{report_job_id}
417443
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
444+
* @deprecated This method is deprecated and will be removed in the next major version update.
418445
*/
446+
@Deprecated
419447
public final FetchReportResultsPagedResponse fetchReportResults(ReportJobName reportJob) {
420448
FetchReportResultsRequest request =
421449
FetchReportResultsRequest.newBuilder()
@@ -429,6 +457,9 @@ public final FetchReportResultsPagedResponse fetchReportResults(ReportJobName re
429457
* Retrieves data generated by
430458
* [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob].
431459
*
460+
* <p>Deprecated: Please use [Export Channel Services data to
461+
* BigQuery](https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery) instead.
462+
*
432463
* <p>Sample code:
433464
*
434465
* <pre>{@code
@@ -451,7 +482,9 @@ public final FetchReportResultsPagedResponse fetchReportResults(ReportJobName re
451482
* [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob].
452483
* Report_job uses the format: accounts/{account_id}/reportJobs/{report_job_id}
453484
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
485+
* @deprecated This method is deprecated and will be removed in the next major version update.
454486
*/
487+
@Deprecated
455488
public final FetchReportResultsPagedResponse fetchReportResults(String reportJob) {
456489
FetchReportResultsRequest request =
457490
FetchReportResultsRequest.newBuilder().setReportJob(reportJob).build();
@@ -463,6 +496,9 @@ public final FetchReportResultsPagedResponse fetchReportResults(String reportJob
463496
* Retrieves data generated by
464497
* [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob].
465498
*
499+
* <p>Deprecated: Please use [Export Channel Services data to
500+
* BigQuery](https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery) instead.
501+
*
466502
* <p>Sample code:
467503
*
468504
* <pre>{@code
@@ -489,7 +525,9 @@ public final FetchReportResultsPagedResponse fetchReportResults(String reportJob
489525
*
490526
* @param request The request object containing all of the parameters for the API call.
491527
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
528+
* @deprecated This method is deprecated and will be removed in the next major version update.
492529
*/
530+
@Deprecated
493531
public final FetchReportResultsPagedResponse fetchReportResults(
494532
FetchReportResultsRequest request) {
495533
return fetchReportResultsPagedCallable().call(request);
@@ -500,6 +538,9 @@ public final FetchReportResultsPagedResponse fetchReportResults(
500538
* Retrieves data generated by
501539
* [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob].
502540
*
541+
* <p>Deprecated: Please use [Export Channel Services data to
542+
* BigQuery](https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery) instead.
543+
*
503544
* <p>Sample code:
504545
*
505546
* <pre>{@code
@@ -525,7 +566,10 @@ public final FetchReportResultsPagedResponse fetchReportResults(
525566
* }
526567
* }
527568
* }</pre>
569+
*
570+
* @deprecated This method is deprecated and will be removed in the next major version update.
528571
*/
572+
@Deprecated
529573
public final UnaryCallable<FetchReportResultsRequest, FetchReportResultsPagedResponse>
530574
fetchReportResultsPagedCallable() {
531575
return stub.fetchReportResultsPagedCallable();
@@ -536,6 +580,9 @@ public final FetchReportResultsPagedResponse fetchReportResults(
536580
* Retrieves data generated by
537581
* [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob].
538582
*
583+
* <p>Deprecated: Please use [Export Channel Services data to
584+
* BigQuery](https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery) instead.
585+
*
539586
* <p>Sample code:
540587
*
541588
* <pre>{@code
@@ -568,7 +615,10 @@ public final FetchReportResultsPagedResponse fetchReportResults(
568615
* }
569616
* }
570617
* }</pre>
618+
*
619+
* @deprecated This method is deprecated and will be removed in the next major version update.
571620
*/
621+
@Deprecated
572622
public final UnaryCallable<FetchReportResultsRequest, FetchReportResultsResponse>
573623
fetchReportResultsCallable() {
574624
return stub.fetchReportResultsCallable();
@@ -579,6 +629,9 @@ public final FetchReportResultsPagedResponse fetchReportResults(
579629
* Lists the reports that RunReportJob can run. These reports include an ID, a description, and
580630
* the list of columns that will be in the result.
581631
*
632+
* <p>Deprecated: Please use [Export Channel Services data to
633+
* BigQuery](https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery) instead.
634+
*
582635
* <p>Sample code:
583636
*
584637
* <pre>{@code
@@ -599,7 +652,9 @@ public final FetchReportResultsPagedResponse fetchReportResults(
599652
* @param parent Required. The resource name of the partner account to list available reports for.
600653
* Parent uses the format: accounts/{account_id}
601654
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
655+
* @deprecated This method is deprecated and will be removed in the next major version update.
602656
*/
657+
@Deprecated
603658
public final ListReportsPagedResponse listReports(String parent) {
604659
ListReportsRequest request = ListReportsRequest.newBuilder().setParent(parent).build();
605660
return listReports(request);
@@ -610,6 +665,9 @@ public final ListReportsPagedResponse listReports(String parent) {
610665
* Lists the reports that RunReportJob can run. These reports include an ID, a description, and
611666
* the list of columns that will be in the result.
612667
*
668+
* <p>Deprecated: Please use [Export Channel Services data to
669+
* BigQuery](https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery) instead.
670+
*
613671
* <p>Sample code:
614672
*
615673
* <pre>{@code
@@ -635,7 +693,9 @@ public final ListReportsPagedResponse listReports(String parent) {
635693
*
636694
* @param request The request object containing all of the parameters for the API call.
637695
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
696+
* @deprecated This method is deprecated and will be removed in the next major version update.
638697
*/
698+
@Deprecated
639699
public final ListReportsPagedResponse listReports(ListReportsRequest request) {
640700
return listReportsPagedCallable().call(request);
641701
}
@@ -645,6 +705,9 @@ public final ListReportsPagedResponse listReports(ListReportsRequest request) {
645705
* Lists the reports that RunReportJob can run. These reports include an ID, a description, and
646706
* the list of columns that will be in the result.
647707
*
708+
* <p>Deprecated: Please use [Export Channel Services data to
709+
* BigQuery](https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery) instead.
710+
*
648711
* <p>Sample code:
649712
*
650713
* <pre>{@code
@@ -670,7 +733,10 @@ public final ListReportsPagedResponse listReports(ListReportsRequest request) {
670733
* }
671734
* }
672735
* }</pre>
736+
*
737+
* @deprecated This method is deprecated and will be removed in the next major version update.
673738
*/
739+
@Deprecated
674740
public final UnaryCallable<ListReportsRequest, ListReportsPagedResponse>
675741
listReportsPagedCallable() {
676742
return stub.listReportsPagedCallable();
@@ -681,6 +747,9 @@ public final ListReportsPagedResponse listReports(ListReportsRequest request) {
681747
* Lists the reports that RunReportJob can run. These reports include an ID, a description, and
682748
* the list of columns that will be in the result.
683749
*
750+
* <p>Deprecated: Please use [Export Channel Services data to
751+
* BigQuery](https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery) instead.
752+
*
684753
* <p>Sample code:
685754
*
686755
* <pre>{@code
@@ -713,7 +782,10 @@ public final ListReportsPagedResponse listReports(ListReportsRequest request) {
713782
* }
714783
* }
715784
* }</pre>
785+
*
786+
* @deprecated This method is deprecated and will be removed in the next major version update.
716787
*/
788+
@Deprecated
717789
public final UnaryCallable<ListReportsRequest, ListReportsResponse> listReportsCallable() {
718790
return stub.listReportsCallable();
719791
}

java-channel/google-cloud-channel/src/main/java/com/google/cloud/channel/v1/CloudChannelReportsServiceSettings.java

Lines changed: 51 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -75,32 +75,55 @@
7575
* CloudChannelReportsServiceSettings cloudChannelReportsServiceSettings =
7676
* cloudChannelReportsServiceSettingsBuilder.build();
7777
* }</pre>
78+
*
79+
* @deprecated This class is deprecated and will be removed in the next major version update.
7880
*/
81+
@Deprecated
7982
@Generated("by gapic-generator-java")
8083
public class CloudChannelReportsServiceSettings
8184
extends ClientSettings<CloudChannelReportsServiceSettings> {
8285

83-
/** Returns the object with the settings used for calls to runReportJob. */
86+
/**
87+
* Returns the object with the settings used for calls to runReportJob.
88+
*
89+
* @deprecated This method is deprecated and will be removed in the next major version update.
90+
*/
91+
@Deprecated
8492
public UnaryCallSettings<RunReportJobRequest, Operation> runReportJobSettings() {
8593
return ((CloudChannelReportsServiceStubSettings) getStubSettings()).runReportJobSettings();
8694
}
8795

88-
/** Returns the object with the settings used for calls to runReportJob. */
96+
/**
97+
* Returns the object with the settings used for calls to runReportJob.
98+
*
99+
* @deprecated This method is deprecated and will be removed in the next major version update.
100+
*/
101+
@Deprecated
89102
public OperationCallSettings<RunReportJobRequest, RunReportJobResponse, OperationMetadata>
90103
runReportJobOperationSettings() {
91104
return ((CloudChannelReportsServiceStubSettings) getStubSettings())
92105
.runReportJobOperationSettings();
93106
}
94107

95-
/** Returns the object with the settings used for calls to fetchReportResults. */
108+
/**
109+
* Returns the object with the settings used for calls to fetchReportResults.
110+
*
111+
* @deprecated This method is deprecated and will be removed in the next major version update.
112+
*/
113+
@Deprecated
96114
public PagedCallSettings<
97115
FetchReportResultsRequest, FetchReportResultsResponse, FetchReportResultsPagedResponse>
98116
fetchReportResultsSettings() {
99117
return ((CloudChannelReportsServiceStubSettings) getStubSettings())
100118
.fetchReportResultsSettings();
101119
}
102120

103-
/** Returns the object with the settings used for calls to listReports. */
121+
/**
122+
* Returns the object with the settings used for calls to listReports.
123+
*
124+
* @deprecated This method is deprecated and will be removed in the next major version update.
125+
*/
126+
@Deprecated
104127
public PagedCallSettings<ListReportsRequest, ListReportsResponse, ListReportsPagedResponse>
105128
listReportsSettings() {
106129
return ((CloudChannelReportsServiceStubSettings) getStubSettings()).listReportsSettings();
@@ -222,26 +245,46 @@ public Builder applyToAllUnaryMethods(
222245
return this;
223246
}
224247

225-
/** Returns the builder for the settings used for calls to runReportJob. */
248+
/**
249+
* Returns the builder for the settings used for calls to runReportJob.
250+
*
251+
* @deprecated This method is deprecated and will be removed in the next major version update.
252+
*/
253+
@Deprecated
226254
public UnaryCallSettings.Builder<RunReportJobRequest, Operation> runReportJobSettings() {
227255
return getStubSettingsBuilder().runReportJobSettings();
228256
}
229257

230-
/** Returns the builder for the settings used for calls to runReportJob. */
258+
/**
259+
* Returns the builder for the settings used for calls to runReportJob.
260+
*
261+
* @deprecated This method is deprecated and will be removed in the next major version update.
262+
*/
263+
@Deprecated
231264
public OperationCallSettings.Builder<
232265
RunReportJobRequest, RunReportJobResponse, OperationMetadata>
233266
runReportJobOperationSettings() {
234267
return getStubSettingsBuilder().runReportJobOperationSettings();
235268
}
236269

237-
/** Returns the builder for the settings used for calls to fetchReportResults. */
270+
/**
271+
* Returns the builder for the settings used for calls to fetchReportResults.
272+
*
273+
* @deprecated This method is deprecated and will be removed in the next major version update.
274+
*/
275+
@Deprecated
238276
public PagedCallSettings.Builder<
239277
FetchReportResultsRequest, FetchReportResultsResponse, FetchReportResultsPagedResponse>
240278
fetchReportResultsSettings() {
241279
return getStubSettingsBuilder().fetchReportResultsSettings();
242280
}
243281

244-
/** Returns the builder for the settings used for calls to listReports. */
282+
/**
283+
* Returns the builder for the settings used for calls to listReports.
284+
*
285+
* @deprecated This method is deprecated and will be removed in the next major version update.
286+
*/
287+
@Deprecated
245288
public PagedCallSettings.Builder<
246289
ListReportsRequest, ListReportsResponse, ListReportsPagedResponse>
247290
listReportsSettings() {

java-channel/google-cloud-channel/src/main/java/com/google/cloud/channel/v1/package-info.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,9 @@
2525
* retrieve and combine a variety of data in Cloud Channel for multiple products (Google Cloud,
2626
* Google Voice, and Google Workspace.)
2727
*
28+
* <p>Deprecated: This service is being deprecated. Please use [Export Channel Services data to
29+
* BigQuery](https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery) instead.
30+
*
2831
* <p>Sample for CloudChannelReportsServiceClient:
2932
*
3033
* <pre>{@code

0 commit comments

Comments
 (0)