Class CloudChannelReportsServiceClient (2.22.0)

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

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

CloudChannelReportsServiceClient(CloudChannelReportsServiceClient const &)

Copy and move support

Parameter
Name	Description
	`CloudChannelReportsServiceClient const &`

CloudChannelReportsServiceClient(CloudChannelReportsServiceClient &&)

Copy and move support

Parameter
Name	Description
	`CloudChannelReportsServiceClient &&`

CloudChannelReportsServiceClient(std::shared_ptr< CloudChannelReportsServiceConnection >, Options)

Parameters
Name	Description
`connection`	`std::shared_ptr< CloudChannelReportsServiceConnection >`
`opts`	`Options`

Operators

operator=(CloudChannelReportsServiceClient const &)

Copy and move support

Parameter
Name	Description
	`CloudChannelReportsServiceClient const &`

Returns
Type	Description
`CloudChannelReportsServiceClient &`

operator=(CloudChannelReportsServiceClient &&)

Copy and move support

Parameter
Name	Description
	`CloudChannelReportsServiceClient &&`

Returns
Type	Description
`CloudChannelReportsServiceClient &`

Functions

RunReportJob(google::cloud::channel::v1::RunReportJobRequest const &, Options)

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.

To get the results of report generation, call CloudChannelReportsService.FetchReportResults with the RunReportJobResponse.report_job.

Deprecated: Please use Export Channel Services data to BigQuery instead.

Parameters
Name	Description
`request`	`google::cloud::channel::v1::RunReportJobRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.RunReportJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::channel::v1::RunReportJobResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.channel.v1.RunReportJobResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

FetchReportResults(std::string const &, Options)

Retrieves data generated by CloudChannelReportsService.RunReportJob.

Deprecated: Please use Export Channel Services data to BigQuery instead.

Parameters
Name	Description
`report_job`	`std::string const &` Required. The report job created by CloudChannelReportsService.RunReportJob. Report_job uses the format: accounts/{account_id}/reportJobs/{report_job_id}
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::channel::v1::Row >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.channel.v1.Row, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

FetchReportResults(google::cloud::channel::v1::FetchReportResultsRequest, Options)

Retrieves data generated by CloudChannelReportsService.RunReportJob.

Deprecated: Please use Export Channel Services data to BigQuery instead.

Parameters
Name	Description
`request`	`google::cloud::channel::v1::FetchReportResultsRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.FetchReportResultsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::channel::v1::Row >

ListReports(std::string const &, Options)

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

Parameters
Name	Description
`parent`	`std::string const &` Required. The resource name of the partner account to list available reports for. Parent uses the format: accounts/{account_id}
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::channel::v1::Report >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.channel.v1.Report, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListReports(google::cloud::channel::v1::ListReportsRequest, Options)

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

Parameters
Name	Description
`request`	`google::cloud::channel::v1::ListReportsRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.ListReportsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::channel::v1::Report >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.channel.v1.Report, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.