Chronicle v1 API - Class ReferenceListService.ReferenceListServiceClient (1.0.0-beta02)

public class ReferenceListService.ReferenceListServiceClient : ClientBase<ReferenceListService.ReferenceListServiceClient>

Reference documentation and code samples for the Chronicle v1 API class ReferenceListService.ReferenceListServiceClient.

Client for ReferenceListService

Inheritance

object > ClientBase > ClientBaseReferenceListServiceReferenceListServiceClient > ReferenceListService.ReferenceListServiceClient

Namespace

Google.Cloud.Chronicle.V1

Assembly

Google.Cloud.Chronicle.V1.dll

Constructors

ReferenceListServiceClient()

protected ReferenceListServiceClient()

Protected parameterless constructor to allow creation of test doubles.

ReferenceListServiceClient(CallInvoker)

public ReferenceListServiceClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

ReferenceListServiceClient(ChannelBase)

public ReferenceListServiceClient(ChannelBase channel)

Creates a new client for ReferenceListService

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

ReferenceListServiceClient(ClientBaseConfiguration)

protected ReferenceListServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateReferenceList(CreateReferenceListRequest, CallOptions)

public virtual ReferenceList CreateReferenceList(CreateReferenceListRequest request, CallOptions options)

Creates a new reference list.

Parameters
Name Description
request CreateReferenceListRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ReferenceList

The response received from the server.

CreateReferenceList(CreateReferenceListRequest, Metadata, DateTime?, CancellationToken)

public virtual ReferenceList CreateReferenceList(CreateReferenceListRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new reference list.

Parameters
Name Description
request CreateReferenceListRequest

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
ReferenceList

The response received from the server.

CreateReferenceListAsync(CreateReferenceListRequest, CallOptions)

public virtual AsyncUnaryCall<ReferenceList> CreateReferenceListAsync(CreateReferenceListRequest request, CallOptions options)

Creates a new reference list.

Parameters
Name Description
request CreateReferenceListRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallReferenceList

The call object.

CreateReferenceListAsync(CreateReferenceListRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ReferenceList> CreateReferenceListAsync(CreateReferenceListRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new reference list.

Parameters
Name Description
request CreateReferenceListRequest

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
AsyncUnaryCallReferenceList

The call object.

GetReferenceList(GetReferenceListRequest, CallOptions)

public virtual ReferenceList GetReferenceList(GetReferenceListRequest request, CallOptions options)

Gets a single reference list.

Parameters
Name Description
request GetReferenceListRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ReferenceList

The response received from the server.

GetReferenceList(GetReferenceListRequest, Metadata, DateTime?, CancellationToken)

public virtual ReferenceList GetReferenceList(GetReferenceListRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a single reference list.

Parameters
Name Description
request GetReferenceListRequest

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
ReferenceList

The response received from the server.

GetReferenceListAsync(GetReferenceListRequest, CallOptions)

public virtual AsyncUnaryCall<ReferenceList> GetReferenceListAsync(GetReferenceListRequest request, CallOptions options)

Gets a single reference list.

Parameters
Name Description
request GetReferenceListRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallReferenceList

The call object.

GetReferenceListAsync(GetReferenceListRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ReferenceList> GetReferenceListAsync(GetReferenceListRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a single reference list.

Parameters
Name Description
request GetReferenceListRequest

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
AsyncUnaryCallReferenceList

The call object.

ListReferenceLists(ListReferenceListsRequest, CallOptions)

public virtual ListReferenceListsResponse ListReferenceLists(ListReferenceListsRequest request, CallOptions options)

Lists a collection of reference lists.

Parameters
Name Description
request ListReferenceListsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListReferenceListsResponse

The response received from the server.

ListReferenceLists(ListReferenceListsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListReferenceListsResponse ListReferenceLists(ListReferenceListsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists a collection of reference lists.

Parameters
Name Description
request ListReferenceListsRequest

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
ListReferenceListsResponse

The response received from the server.

ListReferenceListsAsync(ListReferenceListsRequest, CallOptions)

public virtual AsyncUnaryCall<ListReferenceListsResponse> ListReferenceListsAsync(ListReferenceListsRequest request, CallOptions options)

Lists a collection of reference lists.

Parameters
Name Description
request ListReferenceListsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListReferenceListsResponse

The call object.

ListReferenceListsAsync(ListReferenceListsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListReferenceListsResponse> ListReferenceListsAsync(ListReferenceListsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists a collection of reference lists.

Parameters
Name Description
request ListReferenceListsRequest

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
AsyncUnaryCallListReferenceListsResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override ReferenceListService.ReferenceListServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
ReferenceListServiceReferenceListServiceClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Chronicle.V1.ReferenceListService.ReferenceListServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UpdateReferenceList(UpdateReferenceListRequest, CallOptions)

public virtual ReferenceList UpdateReferenceList(UpdateReferenceListRequest request, CallOptions options)

Updates an existing reference list.

Parameters
Name Description
request UpdateReferenceListRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ReferenceList

The response received from the server.

UpdateReferenceList(UpdateReferenceListRequest, Metadata, DateTime?, CancellationToken)

public virtual ReferenceList UpdateReferenceList(UpdateReferenceListRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates an existing reference list.

Parameters
Name Description
request UpdateReferenceListRequest

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
ReferenceList

The response received from the server.

UpdateReferenceListAsync(UpdateReferenceListRequest, CallOptions)

public virtual AsyncUnaryCall<ReferenceList> UpdateReferenceListAsync(UpdateReferenceListRequest request, CallOptions options)

Updates an existing reference list.

Parameters
Name Description
request UpdateReferenceListRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallReferenceList

The call object.

UpdateReferenceListAsync(UpdateReferenceListRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ReferenceList> UpdateReferenceListAsync(UpdateReferenceListRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates an existing reference list.

Parameters
Name Description
request UpdateReferenceListRequest

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
AsyncUnaryCallReferenceList

The call object.