Chronicle v1 API - Class DashboardQueryService.DashboardQueryServiceClient (1.0.0-beta05)

public class DashboardQueryService.DashboardQueryServiceClient : ClientBase<DashboardQueryService.DashboardQueryServiceClient>

Reference documentation and code samples for the Chronicle v1 API class DashboardQueryService.DashboardQueryServiceClient.

Client for DashboardQueryService

Inheritance

object > ClientBase > ClientBaseDashboardQueryServiceDashboardQueryServiceClient > DashboardQueryService.DashboardQueryServiceClient

Namespace

Google.Cloud.Chronicle.V1

Assembly

Google.Cloud.Chronicle.V1.dll

Constructors

DashboardQueryServiceClient()

protected DashboardQueryServiceClient()

Protected parameterless constructor to allow creation of test doubles.

DashboardQueryServiceClient(CallInvoker)

public DashboardQueryServiceClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

DashboardQueryServiceClient(ChannelBase)

public DashboardQueryServiceClient(ChannelBase channel)

Creates a new client for DashboardQueryService

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

DashboardQueryServiceClient(ClientBaseConfiguration)

protected DashboardQueryServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

ExecuteDashboardQuery(ExecuteDashboardQueryRequest, CallOptions)

public virtual ExecuteDashboardQueryResponse ExecuteDashboardQuery(ExecuteDashboardQueryRequest request, CallOptions options)

Execute a query and return the data.

Parameters
Name Description
request ExecuteDashboardQueryRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ExecuteDashboardQueryResponse

The response received from the server.

ExecuteDashboardQuery(ExecuteDashboardQueryRequest, Metadata, DateTime?, CancellationToken)

public virtual ExecuteDashboardQueryResponse ExecuteDashboardQuery(ExecuteDashboardQueryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Execute a query and return the data.

Parameters
Name Description
request ExecuteDashboardQueryRequest

The request to send to the server.

headers Metadata

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

deadline System.DateTime

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
ExecuteDashboardQueryResponse

The response received from the server.

ExecuteDashboardQueryAsync(ExecuteDashboardQueryRequest, CallOptions)

public virtual AsyncUnaryCall<ExecuteDashboardQueryResponse> ExecuteDashboardQueryAsync(ExecuteDashboardQueryRequest request, CallOptions options)

Execute a query and return the data.

Parameters
Name Description
request ExecuteDashboardQueryRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallExecuteDashboardQueryResponse

The call object.

ExecuteDashboardQueryAsync(ExecuteDashboardQueryRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ExecuteDashboardQueryResponse> ExecuteDashboardQueryAsync(ExecuteDashboardQueryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Execute a query and return the data.

Parameters
Name Description
request ExecuteDashboardQueryRequest

The request to send to the server.

headers Metadata

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

deadline System.DateTime

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallExecuteDashboardQueryResponse

The call object.

GetDashboardQuery(GetDashboardQueryRequest, CallOptions)

public virtual DashboardQuery GetDashboardQuery(GetDashboardQueryRequest request, CallOptions options)

Get a dashboard query.

Parameters
Name Description
request GetDashboardQueryRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
DashboardQuery

The response received from the server.

GetDashboardQuery(GetDashboardQueryRequest, Metadata, DateTime?, CancellationToken)

public virtual DashboardQuery GetDashboardQuery(GetDashboardQueryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Get a dashboard query.

Parameters
Name Description
request GetDashboardQueryRequest

The request to send to the server.

headers Metadata

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

deadline System.DateTime

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
DashboardQuery

The response received from the server.

GetDashboardQueryAsync(GetDashboardQueryRequest, CallOptions)

public virtual AsyncUnaryCall<DashboardQuery> GetDashboardQueryAsync(GetDashboardQueryRequest request, CallOptions options)

Get a dashboard query.

Parameters
Name Description
request GetDashboardQueryRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallDashboardQuery

The call object.

GetDashboardQueryAsync(GetDashboardQueryRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<DashboardQuery> GetDashboardQueryAsync(GetDashboardQueryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Get a dashboard query.

Parameters
Name Description
request GetDashboardQueryRequest

The request to send to the server.

headers Metadata

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

deadline System.DateTime

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallDashboardQuery

The call object.

NewInstance(ClientBaseConfiguration)

protected override DashboardQueryService.DashboardQueryServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
DashboardQueryServiceDashboardQueryServiceClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Chronicle.V1.DashboardQueryService.DashboardQueryServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)