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
Returns
Task <WriteResult <string >>
AreaCreate(AreaRequest, CancellationToken)
Task<WriteResult<string>> AreaCreate(AreaRequest area, CancellationToken ct)
Parameters
area AreaRequest
Returns
Task <WriteResult <string >>
AreaCreate(AreaRequest)
Task<WriteResult<string>> AreaCreate(AreaRequest area)
Parameters
area AreaRequest
Returns
Task <WriteResult <string >>
AreaDelete(string, CancellationToken)
Task<WriteResult> AreaDelete(string areaId, CancellationToken cancellationToken)
Parameters
areaId string
cancellationToken CancellationToken
Returns
Task <WriteResult >
AreaDelete(string)
Task<WriteResult> AreaDelete(string areaId)
Parameters
areaId string
Returns
Task <WriteResult >
AreaDelete(string, WriteOptions, CancellationToken)
Task<WriteResult> AreaDelete(string areaId, WriteOptions q, CancellationToken cancellationToken = default)
Parameters
areaId string
cancellationToken CancellationToken
Returns
Task <WriteResult >
AreaGet(string, CancellationToken)
Task<QueryResult<Area[]>> AreaGet(string areaId, CancellationToken cancellationToken)
Parameters
areaId string
cancellationToken CancellationToken
Returns
Task <QueryResult <Area []>>
AreaGet(string)
Task<QueryResult<Area[]>> AreaGet(string areaId)
Parameters
areaId string
Returns
Task <QueryResult <Area []>>
AreaGet(string, QueryOptions, CancellationToken)
Task<QueryResult<Area[]>> AreaGet(string areaId, QueryOptions q, CancellationToken cancellationToken = default)
Parameters
areaId string
cancellationToken CancellationToken
Returns
Task <QueryResult <Area []>>
AreaList(CancellationToken)
Task<QueryResult<List<Area>>> AreaList(CancellationToken cancellationToken)
Parameters
cancellationToken CancellationToken
Returns
Task <QueryResult <List <Area >>>
AreaList()
Task<QueryResult<List<Area>>> AreaList()
Returns
Task <QueryResult <List <Area >>>
AreaList(QueryOptions, CancellationToken)
Task<QueryResult<List<Area>>> AreaList(QueryOptions q, CancellationToken cancellationToken = default)
Parameters
cancellationToken CancellationToken
Returns
Task <QueryResult <List <Area >>>
AreaUpdate(AreaRequest, string, CancellationToken)
Task<WriteResult<string>> AreaUpdate(AreaRequest area, string areaId, CancellationToken cancellationToken)
Parameters
area AreaRequest
areaId string
cancellationToken CancellationToken
Returns
Task <WriteResult <string >>
AreaUpdate(AreaRequest, string)
Task<WriteResult<string>> AreaUpdate(AreaRequest area, string areaId)
Parameters
area AreaRequest
areaId string
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
cancellationToken CancellationToken
Returns
Task <WriteResult <string >>
AutopilotGetConfiguration(CancellationToken)
Task<QueryResult<AutopilotConfiguration>> AutopilotGetConfiguration(CancellationToken cancellationToken)
Parameters
cancellationToken CancellationToken
Returns
Task <QueryResult <AutopilotConfiguration >>
AutopilotGetConfiguration()
Task<QueryResult<AutopilotConfiguration>> AutopilotGetConfiguration()
Returns
Task <QueryResult <AutopilotConfiguration >>
AutopilotGetConfiguration(QueryOptions, CancellationToken)
Task<QueryResult<AutopilotConfiguration>> AutopilotGetConfiguration(QueryOptions q, CancellationToken cancellationToken = default)
Parameters
cancellationToken CancellationToken
Returns
Task <QueryResult <AutopilotConfiguration >>
AutopilotGetHealth(CancellationToken)
Task<QueryResult<AutopilotHealth>> AutopilotGetHealth(CancellationToken cancellationToken)
Parameters
cancellationToken CancellationToken
Returns
Task <QueryResult <AutopilotHealth >>
AutopilotGetHealth()
Task<QueryResult<AutopilotHealth>> AutopilotGetHealth()
Returns
Task <QueryResult <AutopilotHealth >>
AutopilotGetHealth(QueryOptions, CancellationToken)
Task<QueryResult<AutopilotHealth>> AutopilotGetHealth(QueryOptions q, CancellationToken cancellationToken = default)
Parameters
cancellationToken CancellationToken
Returns
Task <QueryResult <AutopilotHealth >>
AutopilotGetState(CancellationToken)
Task<QueryResult<AutopilotState>> AutopilotGetState(CancellationToken cancellationToken)
Parameters
cancellationToken CancellationToken
Returns
Task <QueryResult <AutopilotState >>
AutopilotGetState()
Task<QueryResult<AutopilotState>> AutopilotGetState()
Returns
Task <QueryResult <AutopilotState >>
AutopilotGetState(QueryOptions, CancellationToken)
Task<QueryResult<AutopilotState>> AutopilotGetState(QueryOptions q, CancellationToken cancellationToken = default)
Parameters
cancellationToken CancellationToken
Returns
Task <QueryResult <AutopilotState >>
AutopilotSetConfiguration(AutopilotConfiguration, CancellationToken)
Task<WriteResult> AutopilotSetConfiguration(AutopilotConfiguration configuration, CancellationToken cancellationToken)
Parameters
configuration AutopilotConfiguration
cancellationToken CancellationToken
Returns
Task <WriteResult >
AutopilotSetConfiguration(AutopilotConfiguration)
Task<WriteResult> AutopilotSetConfiguration(AutopilotConfiguration configuration)
Parameters
configuration AutopilotConfiguration
Returns
Task <WriteResult >
AutopilotSetConfiguration(AutopilotConfiguration, WriteOptions, CancellationToken)
Task<WriteResult> AutopilotSetConfiguration(AutopilotConfiguration configuration, WriteOptions q, CancellationToken cancellationToken = default)
Parameters
configuration AutopilotConfiguration
cancellationToken CancellationToken
Returns
Task <WriteResult >
GetConsulLicense(string, CancellationToken)
Task<QueryResult<ConsulLicense>> GetConsulLicense(string datacenter = "", CancellationToken ct = default)
Parameters
datacenter string
Returns
Task <QueryResult <ConsulLicense >>
KeyringInstall(string, CancellationToken)
Task<WriteResult> KeyringInstall(string key, CancellationToken ct)
Parameters
key string
Returns
Task <WriteResult >
KeyringInstall(string)
Task<WriteResult> KeyringInstall(string key)
Parameters
key string
Returns
Task <WriteResult >
KeyringInstall(string, WriteOptions, CancellationToken)
Task<WriteResult> KeyringInstall(string key, WriteOptions q, CancellationToken ct = default)
Parameters
key string
Returns
Task <WriteResult >
KeyringList(CancellationToken)
Task<QueryResult<KeyringResponse[]>> KeyringList(CancellationToken ct)
Parameters
Returns
Task <QueryResult <KeyringResponse []>>
KeyringList()
Task<QueryResult<KeyringResponse[]>> KeyringList()
Returns
Task <QueryResult <KeyringResponse []>>
KeyringList(QueryOptions, CancellationToken)
Task<QueryResult<KeyringResponse[]>> KeyringList(QueryOptions q, CancellationToken ct = default)
Parameters
Returns
Task <QueryResult <KeyringResponse []>>
KeyringRemove(string, CancellationToken)
Task<WriteResult> KeyringRemove(string key, CancellationToken ct)
Parameters
key string
Returns
Task <WriteResult >
KeyringRemove(string)
Task<WriteResult> KeyringRemove(string key)
Parameters
key string
Returns
Task <WriteResult >
KeyringRemove(string, WriteOptions, CancellationToken)
Task<WriteResult> KeyringRemove(string key, WriteOptions q, CancellationToken ct = default)
Parameters
key string
Returns
Task <WriteResult >
KeyringUse(string, CancellationToken)
Task<WriteResult> KeyringUse(string key, CancellationToken ct)
Parameters
key string
Returns
Task <WriteResult >
KeyringUse(string)
Task<WriteResult> KeyringUse(string key)
Parameters
key string
Returns
Task <WriteResult >
KeyringUse(string, WriteOptions, CancellationToken)
Task<WriteResult> KeyringUse(string key, WriteOptions q, CancellationToken ct = default)
Parameters
key string
Returns
Task <WriteResult >
OperatorGetUsage(CancellationToken)
Task<QueryResult<OperatorUsageInformation>> OperatorGetUsage(CancellationToken cancellationToken)
Parameters
cancellationToken CancellationToken
Returns
Task <QueryResult <OperatorUsageInformation >>
OperatorGetUsage()
Task<QueryResult<OperatorUsageInformation>> OperatorGetUsage()
Returns
Task <QueryResult <OperatorUsageInformation >>
OperatorGetUsage(QueryOptions, CancellationToken)
Task<QueryResult<OperatorUsageInformation>> OperatorGetUsage(QueryOptions q, CancellationToken cancellationToken = default)
Parameters
cancellationToken CancellationToken
Returns
Task <QueryResult <OperatorUsageInformation >>
RaftGetConfiguration(CancellationToken)
Task<QueryResult<RaftConfiguration>> RaftGetConfiguration(CancellationToken ct)
Parameters
Returns
Task <QueryResult <RaftConfiguration >>
RaftGetConfiguration()
Task<QueryResult<RaftConfiguration>> RaftGetConfiguration()
Returns
Task <QueryResult <RaftConfiguration >>
RaftGetConfiguration(QueryOptions, CancellationToken)
Task<QueryResult<RaftConfiguration>> RaftGetConfiguration(QueryOptions q, CancellationToken ct = default)
Parameters
Returns
Task <QueryResult <RaftConfiguration >>
RaftRemovePeerByAddress(string, CancellationToken)
Task<WriteResult> RaftRemovePeerByAddress(string address, CancellationToken ct)
Parameters
address string
Returns
Task <WriteResult >
RaftRemovePeerByAddress(string)
Task<WriteResult> RaftRemovePeerByAddress(string address)
Parameters
address string
Returns
Task <WriteResult >
RaftRemovePeerByAddress(string, WriteOptions, CancellationToken)
Task<WriteResult> RaftRemovePeerByAddress(string address, WriteOptions q, CancellationToken ct = default)
Parameters
address string
Returns
Task <WriteResult >
RaftTransferLeader(CancellationToken)
Task<WriteResult> RaftTransferLeader(CancellationToken ct)
Parameters
Returns
Task <WriteResult >
RaftTransferLeader()
Task<WriteResult> RaftTransferLeader()
Returns
Task <WriteResult >
RaftTransferLeader(WriteOptions, CancellationToken)
Task<WriteResult> RaftTransferLeader(WriteOptions q, CancellationToken ct)
Parameters
Returns
Task <WriteResult >
RaftTransferLeader(WriteOptions)
Task<WriteResult> RaftTransferLeader(WriteOptions q)
Parameters
Returns
Task <WriteResult >
RaftTransferLeader(string, CancellationToken)
Task<WriteResult> RaftTransferLeader(string id, CancellationToken ct)
Parameters
id string
Returns
Task <WriteResult >
RaftTransferLeader(string)
Task<WriteResult> RaftTransferLeader(string id)
Parameters
id string
Returns
Task <WriteResult >
RaftTransferLeader(string, WriteOptions, CancellationToken)
Task<WriteResult> RaftTransferLeader(string id, WriteOptions q, CancellationToken ct = default)
Parameters
id string
Returns
Task <WriteResult >
SegmentList(QueryOptions, CancellationToken)
Task<QueryResult<string[]>> SegmentList(QueryOptions q, CancellationToken cancellationToken = default)
Parameters
cancellationToken CancellationToken
Returns
Task <QueryResult <string []>>
SegmentList(CancellationToken)
Task<QueryResult<string[]>> SegmentList(CancellationToken cancellationToken)
Parameters
cancellationToken CancellationToken
Returns
Task <QueryResult <string []>>
SegmentList()
Task<QueryResult<string[]>> SegmentList()
Returns
Task <QueryResult <string []>>