Skip to main content

Interface IKVEndpoint

Namespace: Consul
Assembly: Consul.dll

The interface for the Key Value Store API Endpoints

public interface IKVEndpoint

Methods​

Acquire(KVPair, CancellationToken)​

Task<WriteResult<bool>> Acquire(KVPair p, CancellationToken ct = default)

Parameters​

p KVPair

ct CancellationToken

Returns​

Task <WriteResult <bool >>

Acquire(KVPair, WriteOptions, CancellationToken)​

Task<WriteResult<bool>> Acquire(KVPair p, WriteOptions q, CancellationToken ct = default)

Parameters​

p KVPair

q WriteOptions

ct CancellationToken

Returns​

Task <WriteResult <bool >>

CAS(KVPair, CancellationToken)​

Task<WriteResult<bool>> CAS(KVPair p, CancellationToken ct = default)

Parameters​

p KVPair

ct CancellationToken

Returns​

Task <WriteResult <bool >>

CAS(KVPair, WriteOptions, CancellationToken)​

Task<WriteResult<bool>> CAS(KVPair p, WriteOptions q, CancellationToken ct = default)

Parameters​

p KVPair

q WriteOptions

ct CancellationToken

Returns​

Task <WriteResult <bool >>

Delete(string, CancellationToken)​

Task<WriteResult<bool>> Delete(string key, CancellationToken ct = default)

Parameters​

key string

ct CancellationToken

Returns​

Task <WriteResult <bool >>

Delete(string, WriteOptions, CancellationToken)​

Task<WriteResult<bool>> Delete(string key, WriteOptions q, CancellationToken ct = default)

Parameters​

key string

q WriteOptions

ct CancellationToken

Returns​

Task <WriteResult <bool >>

DeleteCAS(KVPair, CancellationToken)​

Task<WriteResult<bool>> DeleteCAS(KVPair p, CancellationToken ct = default)

Parameters​

p KVPair

ct CancellationToken

Returns​

Task <WriteResult <bool >>

DeleteCAS(KVPair, WriteOptions, CancellationToken)​

Task<WriteResult<bool>> DeleteCAS(KVPair p, WriteOptions q, CancellationToken ct = default)

Parameters​

p KVPair

q WriteOptions

ct CancellationToken

Returns​

Task <WriteResult <bool >>

DeleteTree(string, CancellationToken)​

Task<WriteResult<bool>> DeleteTree(string prefix, CancellationToken ct = default)

Parameters​

prefix string

ct CancellationToken

Returns​

Task <WriteResult <bool >>

DeleteTree(string, WriteOptions, CancellationToken)​

Task<WriteResult<bool>> DeleteTree(string prefix, WriteOptions q, CancellationToken ct = default)

Parameters​

prefix string

q WriteOptions

ct CancellationToken

Returns​

Task <WriteResult <bool >>

Get(string, CancellationToken)​

Task<QueryResult<KVPair>> Get(string key, CancellationToken ct = default)

Parameters​

key string

ct CancellationToken

Returns​

Task <QueryResult <KVPair >>

Get(string, QueryOptions, CancellationToken)​

Task<QueryResult<KVPair>> Get(string key, QueryOptions q, CancellationToken ct = default)

Parameters​

key string

q QueryOptions

ct CancellationToken

Returns​

Task <QueryResult <KVPair >>

Keys(string, CancellationToken)​

Task<QueryResult<string[]>> Keys(string prefix, CancellationToken ct = default)

Parameters​

prefix string

ct CancellationToken

Returns​

Task <QueryResult <string []>>

Keys(string, string, CancellationToken)​

Task<QueryResult<string[]>> Keys(string prefix, string separator, CancellationToken ct = default)

Parameters​

prefix string

separator string

ct CancellationToken

Returns​

Task <QueryResult <string []>>

Keys(string, string, QueryOptions, CancellationToken)​

Task<QueryResult<string[]>> Keys(string prefix, string separator, QueryOptions q, CancellationToken ct = default)

Parameters​

prefix string

separator string

q QueryOptions

ct CancellationToken

Returns​

Task <QueryResult <string []>>

List(string, CancellationToken)​

Task<QueryResult<KVPair[]>> List(string prefix, CancellationToken ct = default)

Parameters​

prefix string

ct CancellationToken

Returns​

Task <QueryResult <KVPair []>>

List(string, QueryOptions, CancellationToken)​

Task<QueryResult<KVPair[]>> List(string prefix, QueryOptions q, CancellationToken ct = default)

Parameters​

prefix string

q QueryOptions

ct CancellationToken

Returns​

Task <QueryResult <KVPair []>>

Put(KVPair, CancellationToken)​

Task<WriteResult<bool>> Put(KVPair p, CancellationToken ct = default)

Parameters​

p KVPair

ct CancellationToken

Returns​

Task <WriteResult <bool >>

Put(KVPair, WriteOptions, CancellationToken)​

Task<WriteResult<bool>> Put(KVPair p, WriteOptions q, CancellationToken ct = default)

Parameters​

p KVPair

q WriteOptions

ct CancellationToken

Returns​

Task <WriteResult <bool >>

Release(KVPair, CancellationToken)​

Task<WriteResult<bool>> Release(KVPair p, CancellationToken ct = default)

Parameters​

p KVPair

ct CancellationToken

Returns​

Task <WriteResult <bool >>

Release(KVPair, WriteOptions, CancellationToken)​

Task<WriteResult<bool>> Release(KVPair p, WriteOptions q, CancellationToken ct = default)

Parameters​

p KVPair

q WriteOptions

ct CancellationToken

Returns​

Task <WriteResult <bool >>

Txn(List<KVTxnOp>, CancellationToken)​

Task<WriteResult<KVTxnResponse>> Txn(List<KVTxnOp> txn, CancellationToken ct = default)

Parameters​

txn List <KVTxnOp >

ct CancellationToken

Returns​

Task <WriteResult <KVTxnResponse >>

Txn(List<KVTxnOp>, WriteOptions, CancellationToken)​

Task<WriteResult<KVTxnResponse>> Txn(List<KVTxnOp> txn, WriteOptions q, CancellationToken ct = default)

Parameters​

txn List <KVTxnOp >

q WriteOptions

ct CancellationToken

Returns​

Task <WriteResult <KVTxnResponse >>

  • Methods
    • Acquire(KVPair, CancellationToken)
    • Acquire(KVPair, WriteOptions, CancellationToken)
    • CAS(KVPair, CancellationToken)
    • CAS(KVPair, WriteOptions, CancellationToken)
    • Delete(string, CancellationToken)
    • Delete(string, WriteOptions, CancellationToken)
    • DeleteCAS(KVPair, CancellationToken)
    • DeleteCAS(KVPair, WriteOptions, CancellationToken)
    • DeleteTree(string, CancellationToken)
    • DeleteTree(string, WriteOptions, CancellationToken)
    • Get(string, CancellationToken)
    • Get(string, QueryOptions, CancellationToken)
    • Keys(string, CancellationToken)
    • Keys(string, string, CancellationToken)
    • Keys(string, string, QueryOptions, CancellationToken)
    • List(string, CancellationToken)
    • List(string, QueryOptions, CancellationToken)
    • Put(KVPair, CancellationToken)
    • Put(KVPair, WriteOptions, CancellationToken)
    • Release(KVPair, CancellationToken)
    • Release(KVPair, WriteOptions, CancellationToken)
    • Txn(List<KVTxnOp>, CancellationToken)
    • Txn(List<KVTxnOp>, WriteOptions, CancellationToken)