Chronicle v1 API - Class InstanceService.InstanceServiceClient (1.0.0-beta02) 

public class InstanceService.InstanceServiceClient : ClientBase<InstanceService.InstanceServiceClient>

Reference documentation and code samples for the Chronicle v1 API class InstanceService.InstanceServiceClient.

Client for InstanceService

Inheritance

object > ClientBase > ClientBaseInstanceServiceInstanceServiceClient > InstanceService.InstanceServiceClient

Namespace

Google.Cloud.Chronicle.V1

Assembly

Google.Cloud.Chronicle.V1.dll

Constructors

InstanceServiceClient()

protected InstanceServiceClient()

Protected parameterless constructor to allow creation of test doubles.

InstanceServiceClient(CallInvoker)

public InstanceServiceClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

InstanceServiceClient(ChannelBase)

public InstanceServiceClient(ChannelBase channel)

Creates a new client for InstanceService

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

InstanceServiceClient(ClientBaseConfiguration)

protected InstanceServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

GetInstance(GetInstanceRequest, CallOptions)

public virtual Instance GetInstance(GetInstanceRequest request, CallOptions options)

Gets a Instance.

Parameters
Name Description
request GetInstanceRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Instance

The response received from the server.

GetInstance(GetInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual Instance GetInstance(GetInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a Instance.

Parameters
Name Description
request GetInstanceRequest

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
Instance

The response received from the server.

GetInstanceAsync(GetInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Instance> GetInstanceAsync(GetInstanceRequest request, CallOptions options)

Gets a Instance.

Parameters
Name Description
request GetInstanceRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallInstance

The call object.

GetInstanceAsync(GetInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Instance> GetInstanceAsync(GetInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a Instance.

Parameters
Name Description
request GetInstanceRequest

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
AsyncUnaryCallInstance

The call object.

NewInstance(ClientBaseConfiguration)

protected override InstanceService.InstanceServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
InstanceServiceInstanceServiceClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Chronicle.V1.InstanceService.InstanceServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)