Skip to main content

Class Configuration

Namespace: Consul
Assembly: Consul.dll 

public class Configuration : IConfigurationEndpoint

Inheritance​

object ← Configuration

Implements​

IConfigurationEndpoint

Inherited Members​

object.Equals(object) , object.Equals(object, object) , object.GetHashCode() , object.GetType() , object.MemberwiseClone() , object.ReferenceEquals(object, object) , object.ToString()

Methods​

ApplyConfig<TConfig>(WriteOptions, TConfig, CancellationToken)​

This creates or updates the given config entry.

public Task<WriteResult> ApplyConfig<TConfig>(WriteOptions q, TConfig configurationEntry, CancellationToken ct = default) where TConfig : IConfigurationEntry

Parameters​

q WriteOptions

Write Options

configurationEntry TConfig

The configuration entry

ct CancellationToken

The cancellation token

Returns​

Task <WriteResult >

An empty write result

Type Parameters​

TConfig

ApplyConfig<TConfig>(TConfig, CancellationToken)​

This creates or updates the given config entry.

public Task<WriteResult> ApplyConfig<TConfig>(TConfig configurationEntry, CancellationToken ct) where TConfig : IConfigurationEntry

Parameters​

configurationEntry TConfig

The configuration entry

ct CancellationToken

The cancellation token

Returns​

Task <WriteResult >

An empty write result

Type Parameters​

TConfig

ApplyConfig<TConfig>(TConfig)​

public Task<WriteResult> ApplyConfig<TConfig>(TConfig configurationEntry) where TConfig : IConfigurationEntry

Parameters​

configurationEntry TConfig

Returns​

Task <WriteResult >

Type Parameters​

TConfig

DeleteConfig(string, string, WriteOptions, CancellationToken)​

This Deletes the given config entry.

public Task<WriteResult> DeleteConfig(string kind, string name, WriteOptions q, CancellationToken ct = default)

Parameters​

kind string

The kind of config entry

name string

The name of config entry

q WriteOptions

Write Options

ct CancellationToken

Cancellation Token

Returns​

Task <WriteResult >

A Write Result

DeleteConfig(string, string, CancellationToken)​

This Deletes the given config entry.

public Task<WriteResult> DeleteConfig(string kind, string name, CancellationToken ct)

Parameters​

kind string

The kind of config entry

name string

The name of config entry

ct CancellationToken

Cancellation Token

Returns​

Task <WriteResult >

A config entry

DeleteConfig(string, string)​

public Task<WriteResult> DeleteConfig(string kind, string name)

Parameters​

kind string

name string

Returns​

Task <WriteResult >

GetConfig<TConfig>(string, string, QueryOptions, CancellationToken)​

This Retrieves the given config entry.

public Task<QueryResult<TConfig>> GetConfig<TConfig>(string kind, string name, QueryOptions q, CancellationToken ct = default) where TConfig : IConfigurationEntry

Parameters​

kind string

The kind of config entry

name string

The name of config entry

q QueryOptions

Query Options

ct CancellationToken

Cancellation Token

Returns​

Task <QueryResult <TConfig>>

A config entry

Type Parameters​

TConfig

GetConfig<TConfig>(string, string, CancellationToken)​

This Retrieves the given config entry.

public Task<QueryResult<TConfig>> GetConfig<TConfig>(string kind, string name, CancellationToken ct) where TConfig : IConfigurationEntry

Parameters​

kind string

The kind of config entry

name string

The name of config entry

ct CancellationToken

Cancellation Token

Returns​

Task <QueryResult <TConfig>>

A config entry

Type Parameters​

TConfig

GetConfig<TConfig>(string, string)​

public Task<QueryResult<TConfig>> GetConfig<TConfig>(string kind, string name) where TConfig : IConfigurationEntry

Parameters​

kind string

name string

Returns​

Task <QueryResult <TConfig>>

Type Parameters​

TConfig

ListConfig<TConfig>(string, QueryOptions, CancellationToken)​

This Retrieves the list of config for an entry kind.

public Task<QueryResult<List<TConfig>>> ListConfig<TConfig>(string kind, QueryOptions q, CancellationToken ct = default) where TConfig : IConfigurationEntry

Parameters​

kind string

The kind of config entry

q QueryOptions

Query Options

ct CancellationToken

Cancellation Token

Returns​

Task <QueryResult <List <TConfig>>>

A config entry

Type Parameters​

TConfig

ListConfig<TConfig>(string, CancellationToken)​

This Retrieves the list of config for an entry kind.

public Task<QueryResult<List<TConfig>>> ListConfig<TConfig>(string kind, CancellationToken ct) where TConfig : IConfigurationEntry

Parameters​

kind string

The kind of config entry

ct CancellationToken

Cancellation Token

Returns​

Task <QueryResult <List <TConfig>>>

A list of config entries

Type Parameters​

TConfig

ListConfig<TConfig>(string)​

public Task<QueryResult<List<TConfig>>> ListConfig<TConfig>(string kind) where TConfig : IConfigurationEntry

Parameters​

kind string

Returns​

Task <QueryResult <List <TConfig>>>

Type Parameters​

TConfig

  • Methods
    • ApplyConfig<TConfig>(WriteOptions, TConfig, CancellationToken)
    • ApplyConfig<TConfig>(TConfig, CancellationToken)
    • ApplyConfig<TConfig>(TConfig)
    • DeleteConfig(string, string, WriteOptions, CancellationToken)
    • DeleteConfig(string, string, CancellationToken)
    • DeleteConfig(string, string)
    • GetConfig<TConfig>(string, string, QueryOptions, CancellationToken)
    • GetConfig<TConfig>(string, string, CancellationToken)
    • GetConfig<TConfig>(string, string)
    • ListConfig<TConfig>(string, QueryOptions, CancellationToken)
    • ListConfig<TConfig>(string, CancellationToken)
    • ListConfig<TConfig>(string)