Skip to main content

Interface IClusterPeeringEndpoint

Namespace: Consul.Interfaces
Assembly: Consul.dll

The interface for Cluster Peering API Endpoints

public interface IClusterPeeringEndpoint

Methods​

DeletePeering(string, CancellationToken)​

Task<WriteResult> DeletePeering(string name, CancellationToken cancellationToken)

Parameters​

name string

cancellationToken CancellationToken

Returns​

Task <WriteResult >

DeletePeering(string, WriteOptions, CancellationToken)​

Task<WriteResult> DeletePeering(string name, WriteOptions q, CancellationToken cancellationToken = default)

Parameters​

name string

q WriteOptions

cancellationToken CancellationToken

Returns​

Task <WriteResult >

GenerateToken(ClusterPeeringTokenEntry, CancellationToken)​

Task<WriteResult<ClusterPeeringTokenResponse>> GenerateToken(ClusterPeeringTokenEntry tokenEntry, CancellationToken ct)

Parameters​

tokenEntry ClusterPeeringTokenEntry

ct CancellationToken

Returns​

Task <WriteResult <ClusterPeeringTokenResponse >>

GenerateToken(ClusterPeeringTokenEntry)​

Task<WriteResult<ClusterPeeringTokenResponse>> GenerateToken(ClusterPeeringTokenEntry tokenEntry)

Parameters​

tokenEntry ClusterPeeringTokenEntry

Returns​

Task <WriteResult <ClusterPeeringTokenResponse >>

GenerateToken(ClusterPeeringTokenEntry, WriteOptions, CancellationToken)​

Task<WriteResult<ClusterPeeringTokenResponse>> GenerateToken(ClusterPeeringTokenEntry tokenEntry, WriteOptions options, CancellationToken ct = default)

Parameters​

tokenEntry ClusterPeeringTokenEntry

options WriteOptions

ct CancellationToken

Returns​

Task <WriteResult <ClusterPeeringTokenResponse >>

GetPeering(string, CancellationToken)​

Task<QueryResult<ClusterPeeringStatus>> GetPeering(string name, CancellationToken cancellationToken)

Parameters​

name string

cancellationToken CancellationToken

Returns​

Task <QueryResult <ClusterPeeringStatus >>

GetPeering(string, QueryOptions, CancellationToken)​

Task<QueryResult<ClusterPeeringStatus>> GetPeering(string name, QueryOptions q, CancellationToken cancellationToken = default)

Parameters​

name string

q QueryOptions

cancellationToken CancellationToken

Returns​

Task <QueryResult <ClusterPeeringStatus >>

ListPeerings(CancellationToken)​

Task<QueryResult<ClusterPeeringStatus[]>> ListPeerings(CancellationToken cancellationToken)

Parameters​

cancellationToken CancellationToken

Returns​

Task <QueryResult <ClusterPeeringStatus []>>

ListPeerings()​

Task<QueryResult<ClusterPeeringStatus[]>> ListPeerings()

Returns​

Task <QueryResult <ClusterPeeringStatus []>>

ListPeerings(QueryOptions, CancellationToken)​

Task<QueryResult<ClusterPeeringStatus[]>> ListPeerings(QueryOptions q, CancellationToken cancellationToken = default)

Parameters​

q QueryOptions

cancellationToken CancellationToken

Returns​

Task <QueryResult <ClusterPeeringStatus []>>

  • Methods
    • DeletePeering(string, CancellationToken)
    • DeletePeering(string, WriteOptions, CancellationToken)
    • GenerateToken(ClusterPeeringTokenEntry, CancellationToken)
    • GenerateToken(ClusterPeeringTokenEntry)
    • GenerateToken(ClusterPeeringTokenEntry, WriteOptions, CancellationToken)
    • GetPeering(string, CancellationToken)
    • GetPeering(string, QueryOptions, CancellationToken)
    • ListPeerings(CancellationToken)
    • ListPeerings()
    • ListPeerings(QueryOptions, CancellationToken)