public class EntityService.EntityServiceClient : ClientBase<EntityService.EntityServiceClient>
Reference documentation and code samples for the Chronicle v1 API class EntityService.EntityServiceClient.
Client for EntityService
Inheritance
object > ClientBase > ClientBaseEntityServiceEntityServiceClient > EntityService.EntityServiceClientNamespace
Google.Cloud.Chronicle.V1Assembly
Google.Cloud.Chronicle.V1.dll
Constructors
EntityServiceClient()
protected EntityServiceClient()
Protected parameterless constructor to allow creation of test doubles.
EntityServiceClient(CallInvoker)
public EntityServiceClient(CallInvoker callInvoker)
Creates a new client for EntityService that uses a custom CallInvoker
.
Parameter | |
---|---|
Name | Description |
callInvoker |
CallInvoker The callInvoker to use to make remote calls. |
EntityServiceClient(ChannelBase)
public EntityServiceClient(ChannelBase channel)
Creates a new client for EntityService
Parameter | |
---|---|
Name | Description |
channel |
ChannelBase The channel to use to make remote calls. |
EntityServiceClient(ClientBaseConfiguration)
protected EntityServiceClient(ClientBase.ClientBaseConfiguration configuration)
Protected constructor to allow creation of configured clients.
Parameter | |
---|---|
Name | Description |
configuration |
ClientBaseClientBaseConfiguration The client configuration. |
Methods
CreateWatchlist(CreateWatchlistRequest, CallOptions)
public virtual Watchlist CreateWatchlist(CreateWatchlistRequest request, CallOptions options)
Creates a watchlist for the given instance. Note that there can be at most 200 watchlists per instance.
Parameters | |
---|---|
Name | Description |
request |
CreateWatchlistRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Watchlist |
The response received from the server. |
CreateWatchlist(CreateWatchlistRequest, Metadata, DateTime?, CancellationToken)
public virtual Watchlist CreateWatchlist(CreateWatchlistRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Creates a watchlist for the given instance. Note that there can be at most 200 watchlists per instance.
Parameters | |
---|---|
Name | Description |
request |
CreateWatchlistRequest 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 |
Watchlist |
The response received from the server. |
CreateWatchlistAsync(CreateWatchlistRequest, CallOptions)
public virtual AsyncUnaryCall<Watchlist> CreateWatchlistAsync(CreateWatchlistRequest request, CallOptions options)
Creates a watchlist for the given instance. Note that there can be at most 200 watchlists per instance.
Parameters | |
---|---|
Name | Description |
request |
CreateWatchlistRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallWatchlist |
The call object. |
CreateWatchlistAsync(CreateWatchlistRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Watchlist> CreateWatchlistAsync(CreateWatchlistRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Creates a watchlist for the given instance. Note that there can be at most 200 watchlists per instance.
Parameters | |
---|---|
Name | Description |
request |
CreateWatchlistRequest 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 |
AsyncUnaryCallWatchlist |
The call object. |
DeleteWatchlist(DeleteWatchlistRequest, CallOptions)
public virtual Empty DeleteWatchlist(DeleteWatchlistRequest request, CallOptions options)
Deletes the watchlist for the given instance.
Parameters | |
---|---|
Name | Description |
request |
DeleteWatchlistRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Empty |
The response received from the server. |
DeleteWatchlist(DeleteWatchlistRequest, Metadata, DateTime?, CancellationToken)
public virtual Empty DeleteWatchlist(DeleteWatchlistRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Deletes the watchlist for the given instance.
Parameters | |
---|---|
Name | Description |
request |
DeleteWatchlistRequest 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 |
Empty |
The response received from the server. |
DeleteWatchlistAsync(DeleteWatchlistRequest, CallOptions)
public virtual AsyncUnaryCall<Empty> DeleteWatchlistAsync(DeleteWatchlistRequest request, CallOptions options)
Deletes the watchlist for the given instance.
Parameters | |
---|---|
Name | Description |
request |
DeleteWatchlistRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallEmpty |
The call object. |
DeleteWatchlistAsync(DeleteWatchlistRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Empty> DeleteWatchlistAsync(DeleteWatchlistRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Deletes the watchlist for the given instance.
Parameters | |
---|---|
Name | Description |
request |
DeleteWatchlistRequest 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 |
AsyncUnaryCallEmpty |
The call object. |
GetWatchlist(GetWatchlistRequest, CallOptions)
public virtual Watchlist GetWatchlist(GetWatchlistRequest request, CallOptions options)
Gets watchlist details for the given watchlist ID.
Parameters | |
---|---|
Name | Description |
request |
GetWatchlistRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Watchlist |
The response received from the server. |
GetWatchlist(GetWatchlistRequest, Metadata, DateTime?, CancellationToken)
public virtual Watchlist GetWatchlist(GetWatchlistRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Gets watchlist details for the given watchlist ID.
Parameters | |
---|---|
Name | Description |
request |
GetWatchlistRequest 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 |
Watchlist |
The response received from the server. |
GetWatchlistAsync(GetWatchlistRequest, CallOptions)
public virtual AsyncUnaryCall<Watchlist> GetWatchlistAsync(GetWatchlistRequest request, CallOptions options)
Gets watchlist details for the given watchlist ID.
Parameters | |
---|---|
Name | Description |
request |
GetWatchlistRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallWatchlist |
The call object. |
GetWatchlistAsync(GetWatchlistRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Watchlist> GetWatchlistAsync(GetWatchlistRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Gets watchlist details for the given watchlist ID.
Parameters | |
---|---|
Name | Description |
request |
GetWatchlistRequest 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 |
AsyncUnaryCallWatchlist |
The call object. |
ListWatchlists(ListWatchlistsRequest, CallOptions)
public virtual ListWatchlistsResponse ListWatchlists(ListWatchlistsRequest request, CallOptions options)
Lists all watchlists for the given instance.
Parameters | |
---|---|
Name | Description |
request |
ListWatchlistsRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
ListWatchlistsResponse |
The response received from the server. |
ListWatchlists(ListWatchlistsRequest, Metadata, DateTime?, CancellationToken)
public virtual ListWatchlistsResponse ListWatchlists(ListWatchlistsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Lists all watchlists for the given instance.
Parameters | |
---|---|
Name | Description |
request |
ListWatchlistsRequest 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 |
ListWatchlistsResponse |
The response received from the server. |
ListWatchlistsAsync(ListWatchlistsRequest, CallOptions)
public virtual AsyncUnaryCall<ListWatchlistsResponse> ListWatchlistsAsync(ListWatchlistsRequest request, CallOptions options)
Lists all watchlists for the given instance.
Parameters | |
---|---|
Name | Description |
request |
ListWatchlistsRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallListWatchlistsResponse |
The call object. |
ListWatchlistsAsync(ListWatchlistsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListWatchlistsResponse> ListWatchlistsAsync(ListWatchlistsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Lists all watchlists for the given instance.
Parameters | |
---|---|
Name | Description |
request |
ListWatchlistsRequest 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 |
AsyncUnaryCallListWatchlistsResponse |
The call object. |
NewInstance(ClientBaseConfiguration)
protected override EntityService.EntityServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)
Creates a new instance of client from given ClientBaseConfiguration
.
Parameter | |
---|---|
Name | Description |
configuration |
ClientBaseClientBaseConfiguration |
Returns | |
---|---|
Type | Description |
EntityServiceEntityServiceClient |
UpdateWatchlist(UpdateWatchlistRequest, CallOptions)
public virtual Watchlist UpdateWatchlist(UpdateWatchlistRequest request, CallOptions options)
Updates the watchlist for the given instance.
Parameters | |
---|---|
Name | Description |
request |
UpdateWatchlistRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Watchlist |
The response received from the server. |
UpdateWatchlist(UpdateWatchlistRequest, Metadata, DateTime?, CancellationToken)
public virtual Watchlist UpdateWatchlist(UpdateWatchlistRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Updates the watchlist for the given instance.
Parameters | |
---|---|
Name | Description |
request |
UpdateWatchlistRequest 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 |
Watchlist |
The response received from the server. |
UpdateWatchlistAsync(UpdateWatchlistRequest, CallOptions)
public virtual AsyncUnaryCall<Watchlist> UpdateWatchlistAsync(UpdateWatchlistRequest request, CallOptions options)
Updates the watchlist for the given instance.
Parameters | |
---|---|
Name | Description |
request |
UpdateWatchlistRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallWatchlist |
The call object. |
UpdateWatchlistAsync(UpdateWatchlistRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Watchlist> UpdateWatchlistAsync(UpdateWatchlistRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Updates the watchlist for the given instance.
Parameters | |
---|---|
Name | Description |
request |
UpdateWatchlistRequest 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 |
AsyncUnaryCallWatchlist |
The call object. |