Package com.google.cloud.channel.v1

Interface CloudChannelReportsServiceGrpc.AsyncService

All Known Implementing Classes:

CloudChannelReportsServiceGrpc.CloudChannelReportsServiceImplBase

Enclosing class:

CloudChannelReportsServiceGrpc

public static interface CloudChannelReportsServiceGrpc.AsyncService

 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.)
 

Method Summary

Modifier and Type	Method	Description
default void	fetchReportResults(FetchReportResultsRequest request, io.grpc.stub.StreamObserver<FetchReportResultsResponse> responseObserver)	Retrieves data generated by [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob].
default void	listReports(ListReportsRequest request, io.grpc.stub.StreamObserver<ListReportsResponse> responseObserver)	Lists the reports that RunReportJob can run.
default void	runReportJob(RunReportJobRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)	Begins generation of data for a given report.

Method Detail

runReportJob

default void runReportJob(RunReportJobRequest request,
                          io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)

 Begins generation of data for a given report. The report
 identifier is a UID (for example, `613bf59q`).
 Possible error codes:
 * PERMISSION_DENIED: The user doesn't have access to this report.
 * INVALID_ARGUMENT: Required request parameters are missing
   or invalid.
 * NOT_FOUND: The report identifier was not found.
 * INTERNAL: Any non-user error related to a technical issue
   in the backend. Contact Cloud Channel support.
 * UNKNOWN: Any non-user error related to a technical issue
   in the backend. Contact Cloud Channel support.
 Return value:
 The ID of a long-running operation.
 To get the results of the operation, call the GetOperation method of
 CloudChannelOperationsService. The Operation metadata contains an
 instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
 To get the results of report generation, call
 [CloudChannelReportsService.FetchReportResults][google.cloud.channel.v1.CloudChannelReportsService.FetchReportResults]
 with the
 [RunReportJobResponse.report_job][google.cloud.channel.v1.RunReportJobResponse.report_job].
 

fetchReportResults

default void fetchReportResults(FetchReportResultsRequest request,
                                io.grpc.stub.StreamObserver<FetchReportResultsResponse> responseObserver)

 Retrieves data generated by
 [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob].
 

listReports

default void listReports(ListReportsRequest request,
                         io.grpc.stub.StreamObserver<ListReportsResponse> responseObserver)

 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.