Cloud Channel v1 API - Class CloudChannelReportsService.CloudChannelReportsServiceClient (2.4.0)

Stay organized with collections Save and categorize content based on your preferences.
public class CloudChannelReportsServiceClient : ClientBase<CloudChannelReportsService.CloudChannelReportsServiceClient>

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

Client for CloudChannelReportsService

Inheritance

Object > ClientBase > ClientBase<CloudChannelReportsService.CloudChannelReportsServiceClient> > CloudChannelReportsService.CloudChannelReportsServiceClient

Namespace

Google.Cloud.Channel.V1

Assembly

Google.Cloud.Channel.V1.dll

Constructors

CloudChannelReportsServiceClient()

protected CloudChannelReportsServiceClient()

Protected parameterless constructor to allow creation of test doubles.

CloudChannelReportsServiceClient(CallInvoker)

public CloudChannelReportsServiceClient(CallInvoker callInvoker)

Creates a new client for CloudChannelReportsService that uses a custom CallInvoker.

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

CloudChannelReportsServiceClient(ChannelBase)

public CloudChannelReportsServiceClient(ChannelBase channel)

Creates a new client for CloudChannelReportsService

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

CloudChannelReportsServiceClient(ClientBase.ClientBaseConfiguration)

protected CloudChannelReportsServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration

The client configuration.

Methods

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
TypeDescription
Operations.OperationsClient

A new Operations client for the same target as this client.

FetchReportResults(FetchReportResultsRequest, CallOptions)

public virtual FetchReportResultsResponse FetchReportResults(FetchReportResultsRequest request, CallOptions options)

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

Parameters
NameDescription
requestFetchReportResultsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
FetchReportResultsResponse

The response received from the server.

FetchReportResults(FetchReportResultsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual FetchReportResultsResponse FetchReportResults(FetchReportResultsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
NameDescription
requestFetchReportResultsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
FetchReportResultsResponse

The response received from the server.

FetchReportResultsAsync(FetchReportResultsRequest, CallOptions)

public virtual AsyncUnaryCall<FetchReportResultsResponse> FetchReportResultsAsync(FetchReportResultsRequest request, CallOptions options)

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

Parameters
NameDescription
requestFetchReportResultsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<FetchReportResultsResponse>

The call object.

FetchReportResultsAsync(FetchReportResultsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<FetchReportResultsResponse> FetchReportResultsAsync(FetchReportResultsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
NameDescription
requestFetchReportResultsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<FetchReportResultsResponse>

The call object.

ListReports(ListReportsRequest, CallOptions)

public virtual ListReportsResponse ListReports(ListReportsRequest request, CallOptions 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.

Parameters
NameDescription
requestListReportsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListReportsResponse

The response received from the server.

ListReports(ListReportsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListReportsResponse ListReports(ListReportsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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 to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListReportsResponse

The response received from the server.

ListReportsAsync(ListReportsRequest, CallOptions)

public virtual AsyncUnaryCall<ListReportsResponse> ListReportsAsync(ListReportsRequest request, CallOptions 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.

Parameters
NameDescription
requestListReportsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListReportsResponse>

The call object.

ListReportsAsync(ListReportsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListReportsResponse> ListReportsAsync(ListReportsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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 to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListReportsResponse>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override CloudChannelReportsService.CloudChannelReportsServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration
Returns
TypeDescription
CloudChannelReportsService.CloudChannelReportsServiceClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Channel.V1.CloudChannelReportsService.CloudChannelReportsServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

RunReportJob(RunReportJobRequest, CallOptions)

public virtual Operation RunReportJob(RunReportJobRequest request, CallOptions 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][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 to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

RunReportJob(RunReportJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation RunReportJob(RunReportJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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 to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

RunReportJobAsync(RunReportJobRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> RunReportJobAsync(RunReportJobRequest request, CallOptions 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][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 to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

RunReportJobAsync(RunReportJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> RunReportJobAsync(RunReportJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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 to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.