Skip to main content

Interface IOperatorEndpoint

Namespace: Consul
Assembly: Consul.dll

The interface for the Operator API Endpoints

public interface IOperatorEndpoint

Methods

AreaCreate(AreaRequest, WriteOptions, CancellationToken)

Task<WriteResult<string>> AreaCreate(AreaRequest area, WriteOptions q, CancellationToken ct = default)

Parameters

area AreaRequest

q WriteOptions

ct CancellationToken

Returns

Task <WriteResult <string >>

AreaCreate(AreaRequest, CancellationToken)

Task<WriteResult<string>> AreaCreate(AreaRequest area, CancellationToken ct = default)

Parameters

area AreaRequest

ct CancellationToken

Returns

Task <WriteResult <string >>

AreaDelete(string, CancellationToken)

Task<WriteResult> AreaDelete(string areaId, CancellationToken cancellationToken = default)

Parameters

areaId string

cancellationToken CancellationToken

Returns

Task <WriteResult >

AreaDelete(string, WriteOptions, CancellationToken)

Task<WriteResult> AreaDelete(string areaId, WriteOptions q, CancellationToken cancellationToken = default)

Parameters

areaId string

q WriteOptions

cancellationToken CancellationToken

Returns

Task <WriteResult >

AreaGet(string, CancellationToken)

Task<QueryResult<Area[]>> AreaGet(string areaId, CancellationToken cancellationToken = default)

Parameters

areaId string

cancellationToken CancellationToken

Returns

Task <QueryResult <Area []>>

AreaGet(string, QueryOptions, CancellationToken)

Task<QueryResult<Area[]>> AreaGet(string areaId, QueryOptions q, CancellationToken cancellationToken = default)

Parameters

areaId string

q QueryOptions

cancellationToken CancellationToken

Returns

Task <QueryResult <Area []>>

AreaList(CancellationToken)

Task<QueryResult<List<Area>>> AreaList(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task <QueryResult <List <Area >>>

AreaList(QueryOptions, CancellationToken)

Task<QueryResult<List<Area>>> AreaList(QueryOptions q, CancellationToken cancellationToken = default)

Parameters

q QueryOptions

cancellationToken CancellationToken

Returns

Task <QueryResult <List <Area >>>

AreaUpdate(AreaRequest, string, CancellationToken)

Task<WriteResult<string>> AreaUpdate(AreaRequest area, string areaId, CancellationToken cancellationToken = default)

Parameters

area AreaRequest

areaId string

cancellationToken CancellationToken

Returns

Task <WriteResult <string >>

AreaUpdate(AreaRequest, string, WriteOptions, CancellationToken)

Task<WriteResult<string>> AreaUpdate(AreaRequest area, string areaId, WriteOptions q, CancellationToken cancellationToken = default)

Parameters

area AreaRequest

areaId string

q WriteOptions

cancellationToken CancellationToken

Returns

Task <WriteResult <string >>

GetConsulLicense(string, CancellationToken)

Task<QueryResult<ConsulLicense>> GetConsulLicense(string datacenter = "", CancellationToken ct = default)

Parameters

datacenter string

ct CancellationToken

Returns

Task <QueryResult <ConsulLicense >>

KeyringInstall(string, CancellationToken)

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

Parameters

key string

ct CancellationToken

Returns

Task <WriteResult >

KeyringInstall(string, WriteOptions, CancellationToken)

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

Parameters

key string

q WriteOptions

ct CancellationToken

Returns

Task <WriteResult >

KeyringList(CancellationToken)

Task<QueryResult<KeyringResponse[]>> KeyringList(CancellationToken ct = default)

Parameters

ct CancellationToken

Returns

Task <QueryResult <KeyringResponse []>>

KeyringList(QueryOptions, CancellationToken)

Task<QueryResult<KeyringResponse[]>> KeyringList(QueryOptions q, CancellationToken ct = default)

Parameters

q QueryOptions

ct CancellationToken

Returns

Task <QueryResult <KeyringResponse []>>

KeyringRemove(string, CancellationToken)

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

Parameters

key string

ct CancellationToken

Returns

Task <WriteResult >

KeyringRemove(string, WriteOptions, CancellationToken)

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

Parameters

key string

q WriteOptions

ct CancellationToken

Returns

Task <WriteResult >

KeyringUse(string, CancellationToken)

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

Parameters

key string

ct CancellationToken

Returns

Task <WriteResult >

KeyringUse(string, WriteOptions, CancellationToken)

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

Parameters

key string

q WriteOptions

ct CancellationToken

Returns

Task <WriteResult >

RaftGetConfiguration(CancellationToken)

Task<QueryResult<RaftConfiguration>> RaftGetConfiguration(CancellationToken ct = default)

Parameters

ct CancellationToken

Returns

Task <QueryResult <RaftConfiguration >>

RaftGetConfiguration(QueryOptions, CancellationToken)

Task<QueryResult<RaftConfiguration>> RaftGetConfiguration(QueryOptions q, CancellationToken ct = default)

Parameters

q QueryOptions

ct CancellationToken

Returns

Task <QueryResult <RaftConfiguration >>

RaftRemovePeerByAddress(string, CancellationToken)

Task<WriteResult> RaftRemovePeerByAddress(string address, CancellationToken ct = default)

Parameters

address string

ct CancellationToken

Returns

Task <WriteResult >

RaftRemovePeerByAddress(string, WriteOptions, CancellationToken)

Task<WriteResult> RaftRemovePeerByAddress(string address, WriteOptions q, CancellationToken ct = default)

Parameters

address string

q WriteOptions

ct CancellationToken

Returns

Task <WriteResult >

SegmentList(QueryOptions, CancellationToken)

Task<QueryResult<string[]>> SegmentList(QueryOptions q, CancellationToken cancellationToken = default)

Parameters

q QueryOptions

cancellationToken CancellationToken

Returns

Task <QueryResult <string []>>

SegmentList(CancellationToken)

Task<QueryResult<string[]>> SegmentList(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task <QueryResult <string []>>

  • Methods
    • AreaCreate(AreaRequest, WriteOptions, CancellationToken)
    • AreaCreate(AreaRequest, CancellationToken)
    • AreaDelete(string, CancellationToken)
    • AreaDelete(string, WriteOptions, CancellationToken)
    • AreaGet(string, CancellationToken)
    • AreaGet(string, QueryOptions, CancellationToken)
    • AreaList(CancellationToken)
    • AreaList(QueryOptions, CancellationToken)
    • AreaUpdate(AreaRequest, string, CancellationToken)
    • AreaUpdate(AreaRequest, string, WriteOptions, CancellationToken)
    • GetConsulLicense(string, CancellationToken)
    • KeyringInstall(string, CancellationToken)
    • KeyringInstall(string, WriteOptions, CancellationToken)
    • KeyringList(CancellationToken)
    • KeyringList(QueryOptions, CancellationToken)
    • KeyringRemove(string, CancellationToken)
    • KeyringRemove(string, WriteOptions, CancellationToken)
    • KeyringUse(string, CancellationToken)
    • KeyringUse(string, WriteOptions, CancellationToken)
    • RaftGetConfiguration(CancellationToken)
    • RaftGetConfiguration(QueryOptions, CancellationToken)
    • RaftRemovePeerByAddress(string, CancellationToken)
    • RaftRemovePeerByAddress(string, WriteOptions, CancellationToken)
    • SegmentList(QueryOptions, CancellationToken)
    • SegmentList(CancellationToken)