Cloud Channel v1 API - Class CloudChannelReportsServiceClientImpl (2.1.0)

public sealed class CloudChannelReportsServiceClientImpl : CloudChannelReportsServiceClient

Reference documentation and code samples for the Cloud Channel v1 API class CloudChannelReportsServiceClientImpl.

CloudChannelReportsService client wrapper implementation, for convenient use.

Inheritance

Object > CloudChannelReportsServiceClient > CloudChannelReportsServiceClientImpl

Namespace

Google.Cloud.Channel.V1

Assembly

Google.Cloud.Channel.V1.dll

Remarks

CloudChannelReportsService lets Google Cloud resellers and distributors retrieve and combine a variety of data in Cloud Channel for multiple products (Google Cloud Platform (GCP), Google Voice, and Google Workspace.)

Constructors

CloudChannelReportsServiceClientImpl(CloudChannelReportsService.CloudChannelReportsServiceClient, CloudChannelReportsServiceSettings, ILogger)

public CloudChannelReportsServiceClientImpl(CloudChannelReportsService.CloudChannelReportsServiceClient grpcClient, CloudChannelReportsServiceSettings settings, ILogger logger)

Constructs a client wrapper for the CloudChannelReportsService service, with the specified gRPC client and settings.

Parameters
NameDescription
grpcClientCloudChannelReportsService.CloudChannelReportsServiceClient

The underlying gRPC client.

settingsCloudChannelReportsServiceSettings

The base CloudChannelReportsServiceSettings used within this client.

loggerILogger

Optional ILogger to use within this client.

Properties

GrpcClient

public override CloudChannelReportsService.CloudChannelReportsServiceClient GrpcClient { get; }

The underlying gRPC CloudChannelReportsService client

Property Value
TypeDescription
CloudChannelReportsService.CloudChannelReportsServiceClient
Overrides

RunReportJobOperationsClient

public override OperationsClient RunReportJobOperationsClient { get; }

The long-running operations client for RunReportJob.

Property Value
TypeDescription
OperationsClient
Overrides

Methods

FetchReportResults(FetchReportResultsRequest, CallSettings)

public override PagedEnumerable<FetchReportResultsResponse, Row> FetchReportResults(FetchReportResultsRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestFetchReportResultsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<FetchReportResultsResponse, Row>

A pageable sequence of Row resources.

Overrides

FetchReportResultsAsync(FetchReportResultsRequest, CallSettings)

public override PagedAsyncEnumerable<FetchReportResultsResponse, Row> FetchReportResultsAsync(FetchReportResultsRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestFetchReportResultsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<FetchReportResultsResponse, Row>

A pageable asynchronous sequence of Row resources.

Overrides

ListReports(ListReportsRequest, CallSettings)

public override PagedEnumerable<ListReportsResponse, Report> ListReports(ListReportsRequest request, CallSettings callSettings = null)

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.

Parameters
NameDescription
requestListReportsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListReportsResponse, Report>

A pageable sequence of Report resources.

Overrides

ListReportsAsync(ListReportsRequest, CallSettings)

public override PagedAsyncEnumerable<ListReportsResponse, Report> ListReportsAsync(ListReportsRequest request, CallSettings callSettings = null)

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.

Parameters
NameDescription
requestListReportsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListReportsResponse, Report>

A pageable asynchronous sequence of Report resources.

Overrides

RunReportJob(RunReportJobRequest, CallSettings)

public override Operation<RunReportJobResponse, OperationMetadata> RunReportJob(RunReportJobRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestRunReportJobRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<RunReportJobResponse, OperationMetadata>

The RPC response.

Overrides

RunReportJobAsync(RunReportJobRequest, CallSettings)

public override async Task<Operation<RunReportJobResponse, OperationMetadata>> RunReportJobAsync(RunReportJobRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestRunReportJobRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<RunReportJobResponse, OperationMetadata>>

A Task containing the RPC response.

Overrides