Class KV.KVClient
Client for KV
Inheritance
Namespace: Etcdserverpb
Assembly: cs.temp.dll.dll
Syntax
public class KVClient : grpc.ClientBase<KV.KVClient>
Constructors
KVClient()
Protected parameterless constructor to allow creation of test doubles.
Declaration
protected KVClient()
KVClient(ClientBaseConfiguration)
Protected constructor to allow creation of configured clients.
Declaration
protected KVClient(ClientBaseConfiguration configuration)
Parameters
Type | Name | Description |
---|---|---|
ClientBaseConfiguration | configuration | The client configuration. |
KVClient(grpc.CallInvoker)
Creates a new client for KV that uses a custom CallInvoker
.
Declaration
public KVClient(grpc.CallInvoker callInvoker)
Parameters
Type | Name | Description |
---|---|---|
grpc.CallInvoker | callInvoker | The callInvoker to use to make remote calls. |
KVClient(grpc.Channel)
Creates a new client for KV
Declaration
public KVClient(grpc.Channel channel)
Parameters
Type | Name | Description |
---|---|---|
grpc.Channel | channel | The channel to use to make remote calls. |
Methods
Compact(CompactionRequest, grpc.CallOptions)
Compact compacts the event history in the etcd key-value store. The key-value store should be periodically compacted or the event history will continue to grow indefinitely.
Declaration
public virtual CompactionResponse Compact(CompactionRequest request, grpc.CallOptions options)
Parameters
Type | Name | Description |
---|---|---|
CompactionRequest | request | The request to send to the server. |
grpc.CallOptions | options | The options for the call. |
Returns
Type | Description |
---|---|
CompactionResponse | The response received from the server. |
Compact(CompactionRequest, grpc.Metadata, Nullable<DateTime>, CancellationToken)
Compact compacts the event history in the etcd key-value store. The key-value store should be periodically compacted or the event history will continue to grow indefinitely.
Declaration
public virtual CompactionResponse Compact(CompactionRequest request, grpc.Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
CompactionRequest | request | The request to send to the server. |
grpc.Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
System.Nullable<DateTime> | deadline | 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 |
---|---|
CompactionResponse | The response received from the server. |
CompactAsync(CompactionRequest, grpc.CallOptions)
Compact compacts the event history in the etcd key-value store. The key-value store should be periodically compacted or the event history will continue to grow indefinitely.
Declaration
public virtual grpc.AsyncUnaryCall<CompactionResponse> CompactAsync(CompactionRequest request, grpc.CallOptions options)
Parameters
Type | Name | Description |
---|---|---|
CompactionRequest | request | The request to send to the server. |
grpc.CallOptions | options | The options for the call. |
Returns
Type | Description |
---|---|
grpc.AsyncUnaryCall<CompactionResponse> | The call object. |
CompactAsync(CompactionRequest, grpc.Metadata, Nullable<DateTime>, CancellationToken)
Compact compacts the event history in the etcd key-value store. The key-value store should be periodically compacted or the event history will continue to grow indefinitely.
Declaration
public virtual grpc.AsyncUnaryCall<CompactionResponse> CompactAsync(CompactionRequest request, grpc.Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
CompactionRequest | request | The request to send to the server. |
grpc.Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
System.Nullable<DateTime> | deadline | 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 |
---|---|
grpc.AsyncUnaryCall<CompactionResponse> | The call object. |
DeleteRange(DeleteRangeRequest, grpc.CallOptions)
DeleteRange deletes the given range from the key-value store. A delete request increments the revision of the key-value store and generates a delete event in the event history for every deleted key.
Declaration
public virtual DeleteRangeResponse DeleteRange(DeleteRangeRequest request, grpc.CallOptions options)
Parameters
Type | Name | Description |
---|---|---|
DeleteRangeRequest | request | The request to send to the server. |
grpc.CallOptions | options | The options for the call. |
Returns
Type | Description |
---|---|
DeleteRangeResponse | The response received from the server. |
DeleteRange(DeleteRangeRequest, grpc.Metadata, Nullable<DateTime>, CancellationToken)
DeleteRange deletes the given range from the key-value store. A delete request increments the revision of the key-value store and generates a delete event in the event history for every deleted key.
Declaration
public virtual DeleteRangeResponse DeleteRange(DeleteRangeRequest request, grpc.Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
DeleteRangeRequest | request | The request to send to the server. |
grpc.Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
System.Nullable<DateTime> | deadline | 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 |
---|---|
DeleteRangeResponse | The response received from the server. |
DeleteRangeAsync(DeleteRangeRequest, grpc.CallOptions)
DeleteRange deletes the given range from the key-value store. A delete request increments the revision of the key-value store and generates a delete event in the event history for every deleted key.
Declaration
public virtual grpc.AsyncUnaryCall<DeleteRangeResponse> DeleteRangeAsync(DeleteRangeRequest request, grpc.CallOptions options)
Parameters
Type | Name | Description |
---|---|---|
DeleteRangeRequest | request | The request to send to the server. |
grpc.CallOptions | options | The options for the call. |
Returns
Type | Description |
---|---|
grpc.AsyncUnaryCall<DeleteRangeResponse> | The call object. |
DeleteRangeAsync(DeleteRangeRequest, grpc.Metadata, Nullable<DateTime>, CancellationToken)
DeleteRange deletes the given range from the key-value store. A delete request increments the revision of the key-value store and generates a delete event in the event history for every deleted key.
Declaration
public virtual grpc.AsyncUnaryCall<DeleteRangeResponse> DeleteRangeAsync(DeleteRangeRequest request, grpc.Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
DeleteRangeRequest | request | The request to send to the server. |
grpc.Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
System.Nullable<DateTime> | deadline | 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 |
---|---|
grpc.AsyncUnaryCall<DeleteRangeResponse> | The call object. |
NewInstance(ClientBaseConfiguration)
Creates a new instance of client from given ClientBaseConfiguration
.
Declaration
protected override KV.KVClient NewInstance(ClientBaseConfiguration configuration)
Parameters
Type | Name | Description |
---|---|---|
ClientBaseConfiguration | configuration |
Returns
Type | Description |
---|---|
KV.KVClient |
Put(PutRequest, grpc.CallOptions)
Put puts the given key into the key-value store. A put request increments the revision of the key-value store and generates one event in the event history.
Declaration
public virtual PutResponse Put(PutRequest request, grpc.CallOptions options)
Parameters
Type | Name | Description |
---|---|---|
PutRequest | request | The request to send to the server. |
grpc.CallOptions | options | The options for the call. |
Returns
Type | Description |
---|---|
PutResponse | The response received from the server. |
Put(PutRequest, grpc.Metadata, Nullable<DateTime>, CancellationToken)
Put puts the given key into the key-value store. A put request increments the revision of the key-value store and generates one event in the event history.
Declaration
public virtual PutResponse Put(PutRequest request, grpc.Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
PutRequest | request | The request to send to the server. |
grpc.Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
System.Nullable<DateTime> | deadline | 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 |
---|---|
PutResponse | The response received from the server. |
PutAsync(PutRequest, grpc.CallOptions)
Put puts the given key into the key-value store. A put request increments the revision of the key-value store and generates one event in the event history.
Declaration
public virtual grpc.AsyncUnaryCall<PutResponse> PutAsync(PutRequest request, grpc.CallOptions options)
Parameters
Type | Name | Description |
---|---|---|
PutRequest | request | The request to send to the server. |
grpc.CallOptions | options | The options for the call. |
Returns
Type | Description |
---|---|
grpc.AsyncUnaryCall<PutResponse> | The call object. |
PutAsync(PutRequest, grpc.Metadata, Nullable<DateTime>, CancellationToken)
Put puts the given key into the key-value store. A put request increments the revision of the key-value store and generates one event in the event history.
Declaration
public virtual grpc.AsyncUnaryCall<PutResponse> PutAsync(PutRequest request, grpc.Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
PutRequest | request | The request to send to the server. |
grpc.Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
System.Nullable<DateTime> | deadline | 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 |
---|---|
grpc.AsyncUnaryCall<PutResponse> | The call object. |
Range(RangeRequest, grpc.CallOptions)
Range gets the keys in the range from the key-value store.
Declaration
public virtual RangeResponse Range(RangeRequest request, grpc.CallOptions options)
Parameters
Type | Name | Description |
---|---|---|
RangeRequest | request | The request to send to the server. |
grpc.CallOptions | options | The options for the call. |
Returns
Type | Description |
---|---|
RangeResponse | The response received from the server. |
Range(RangeRequest, grpc.Metadata, Nullable<DateTime>, CancellationToken)
Range gets the keys in the range from the key-value store.
Declaration
public virtual RangeResponse Range(RangeRequest request, grpc.Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
RangeRequest | request | The request to send to the server. |
grpc.Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
System.Nullable<DateTime> | deadline | 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 |
---|---|
RangeResponse | The response received from the server. |
RangeAsync(RangeRequest, grpc.CallOptions)
Range gets the keys in the range from the key-value store.
Declaration
public virtual grpc.AsyncUnaryCall<RangeResponse> RangeAsync(RangeRequest request, grpc.CallOptions options)
Parameters
Type | Name | Description |
---|---|---|
RangeRequest | request | The request to send to the server. |
grpc.CallOptions | options | The options for the call. |
Returns
Type | Description |
---|---|
grpc.AsyncUnaryCall<RangeResponse> | The call object. |
RangeAsync(RangeRequest, grpc.Metadata, Nullable<DateTime>, CancellationToken)
Range gets the keys in the range from the key-value store.
Declaration
public virtual grpc.AsyncUnaryCall<RangeResponse> RangeAsync(RangeRequest request, grpc.Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
RangeRequest | request | The request to send to the server. |
grpc.Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
System.Nullable<DateTime> | deadline | 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 |
---|---|
grpc.AsyncUnaryCall<RangeResponse> | The call object. |
Txn(TxnRequest, grpc.CallOptions)
Txn processes multiple requests in a single transaction. A txn request increments the revision of the key-value store and generates events with the same revision for every completed request. It is not allowed to modify the same key several times within one txn.
Declaration
public virtual TxnResponse Txn(TxnRequest request, grpc.CallOptions options)
Parameters
Type | Name | Description |
---|---|---|
TxnRequest | request | The request to send to the server. |
grpc.CallOptions | options | The options for the call. |
Returns
Type | Description |
---|---|
TxnResponse | The response received from the server. |
Txn(TxnRequest, grpc.Metadata, Nullable<DateTime>, CancellationToken)
Txn processes multiple requests in a single transaction. A txn request increments the revision of the key-value store and generates events with the same revision for every completed request. It is not allowed to modify the same key several times within one txn.
Declaration
public virtual TxnResponse Txn(TxnRequest request, grpc.Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
TxnRequest | request | The request to send to the server. |
grpc.Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
System.Nullable<DateTime> | deadline | 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 |
---|---|
TxnResponse | The response received from the server. |
TxnAsync(TxnRequest, grpc.CallOptions)
Txn processes multiple requests in a single transaction. A txn request increments the revision of the key-value store and generates events with the same revision for every completed request. It is not allowed to modify the same key several times within one txn.
Declaration
public virtual grpc.AsyncUnaryCall<TxnResponse> TxnAsync(TxnRequest request, grpc.CallOptions options)
Parameters
Type | Name | Description |
---|---|---|
TxnRequest | request | The request to send to the server. |
grpc.CallOptions | options | The options for the call. |
Returns
Type | Description |
---|---|
grpc.AsyncUnaryCall<TxnResponse> | The call object. |
TxnAsync(TxnRequest, grpc.Metadata, Nullable<DateTime>, CancellationToken)
Txn processes multiple requests in a single transaction. A txn request increments the revision of the key-value store and generates events with the same revision for every completed request. It is not allowed to modify the same key several times within one txn.
Declaration
public virtual grpc.AsyncUnaryCall<TxnResponse> TxnAsync(TxnRequest request, grpc.Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
TxnRequest | request | The request to send to the server. |
grpc.Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
System.Nullable<DateTime> | deadline | 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 |
---|---|
grpc.AsyncUnaryCall<TxnResponse> | The call object. |