Skip to main content

Interface IPreparedQueryEndpoint

Namespace: Consul
Assembly: Consul.dll

The interface for the Prepared Query API Endpoints

public interface IPreparedQueryEndpoint

Methods

Create(PreparedQueryDefinition, CancellationToken)

Task<WriteResult<string>> Create(PreparedQueryDefinition query, CancellationToken ct = default)

Parameters

query PreparedQueryDefinition

ct CancellationToken

Returns

Task <WriteResult <string >>

Create(PreparedQueryDefinition, WriteOptions, CancellationToken)

Task<WriteResult<string>> Create(PreparedQueryDefinition query, WriteOptions q, CancellationToken ct = default)

Parameters

query PreparedQueryDefinition

q WriteOptions

ct CancellationToken

Returns

Task <WriteResult <string >>

Delete(string, CancellationToken)

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

Parameters

queryID string

ct CancellationToken

Returns

Task <WriteResult >

Delete(string, WriteOptions, CancellationToken)

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

Parameters

queryID string

q WriteOptions

ct CancellationToken

Returns

Task <WriteResult >

Execute(string, CancellationToken)

Task<QueryResult<PreparedQueryExecuteResponse>> Execute(string queryIDOrName, CancellationToken ct = default)

Parameters

queryIDOrName string

ct CancellationToken

Returns

Task <QueryResult <PreparedQueryExecuteResponse >>

Execute(string, QueryOptions, CancellationToken)

Task<QueryResult<PreparedQueryExecuteResponse>> Execute(string queryIDOrName, QueryOptions q, CancellationToken ct = default)

Parameters

queryIDOrName string

q QueryOptions

ct CancellationToken

Returns

Task <QueryResult <PreparedQueryExecuteResponse >>

Explain(string, QueryOptions, CancellationToken)

Task<QueryResult<PreparedQueryExplainResponse>> Explain(string queryIDOrName, QueryOptions q, CancellationToken ct = default)

Parameters

queryIDOrName string

q QueryOptions

ct CancellationToken

Returns

Task <QueryResult <PreparedQueryExplainResponse >>

Explain(string, CancellationToken)

Task<QueryResult<PreparedQueryExplainResponse>> Explain(string queryIDOrName, CancellationToken ct = default)

Parameters

queryIDOrName string

ct CancellationToken

Returns

Task <QueryResult <PreparedQueryExplainResponse >>

Get(string, CancellationToken)

Task<QueryResult<PreparedQueryDefinition[]>> Get(string queryID, CancellationToken ct = default)

Parameters

queryID string

ct CancellationToken

Returns

Task <QueryResult <PreparedQueryDefinition []>>

Get(string, QueryOptions, CancellationToken)

Task<QueryResult<PreparedQueryDefinition[]>> Get(string queryID, QueryOptions q, CancellationToken ct = default)

Parameters

queryID string

q QueryOptions

ct CancellationToken

Returns

Task <QueryResult <PreparedQueryDefinition []>>

List(CancellationToken)

Task<QueryResult<PreparedQueryDefinition[]>> List(CancellationToken ct = default)

Parameters

ct CancellationToken

Returns

Task <QueryResult <PreparedQueryDefinition []>>

List(QueryOptions, CancellationToken)

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

Parameters

q QueryOptions

ct CancellationToken

Returns

Task <QueryResult <PreparedQueryDefinition []>>

Update(PreparedQueryDefinition, CancellationToken)

Task<WriteResult> Update(PreparedQueryDefinition query, CancellationToken ct = default)

Parameters

query PreparedQueryDefinition

ct CancellationToken

Returns

Task <WriteResult >

Update(PreparedQueryDefinition, WriteOptions, CancellationToken)

Task<WriteResult> Update(PreparedQueryDefinition query, WriteOptions q, CancellationToken ct = default)

Parameters

query PreparedQueryDefinition

q WriteOptions

ct CancellationToken

Returns

Task <WriteResult >

  • Methods
    • Create(PreparedQueryDefinition, CancellationToken)
    • Create(PreparedQueryDefinition, WriteOptions, CancellationToken)
    • Delete(string, CancellationToken)
    • Delete(string, WriteOptions, CancellationToken)
    • Execute(string, CancellationToken)
    • Execute(string, QueryOptions, CancellationToken)
    • Explain(string, QueryOptions, CancellationToken)
    • Explain(string, CancellationToken)
    • Get(string, CancellationToken)
    • Get(string, QueryOptions, CancellationToken)
    • List(CancellationToken)
    • List(QueryOptions, CancellationToken)
    • Update(PreparedQueryDefinition, CancellationToken)
    • Update(PreparedQueryDefinition, WriteOptions, CancellationToken)