Class PreparedQuery
Namespace: Consul
Assembly: Consul.dll
public class PreparedQuery : IPreparedQueryEndpoint
Inheritance
Implements
Inherited Members
object.Equals(object) , object.Equals(object, object) , object.GetHashCode() , object.GetType() , object.MemberwiseClone() , object.ReferenceEquals(object, object) , object.ToString()
Methods
Create(PreparedQueryDefinition, CancellationToken)
public Task<WriteResult<string>> Create(PreparedQueryDefinition query, CancellationToken ct = default)
Parameters
query PreparedQueryDefinition
Returns
Task <WriteResult <string >>
Create(PreparedQueryDefinition, WriteOptions, CancellationToken)
public Task<WriteResult<string>> Create(PreparedQueryDefinition query, WriteOptions q, CancellationToken ct = default)
Parameters
query PreparedQueryDefinition
Returns
Task <WriteResult <string >>
Delete(string, CancellationToken)
public Task<WriteResult> Delete(string queryID, CancellationToken ct = default)
Parameters
queryID string
Returns
Task <WriteResult >
Delete(string, WriteOptions, CancellationToken)
public Task<WriteResult> Delete(string queryID, WriteOptions q, CancellationToken ct = default)
Parameters
queryID string
Returns
Task <WriteResult >
Execute(string, CancellationToken)
public Task<QueryResult<PreparedQueryExecuteResponse>> Execute(string queryIDOrName, CancellationToken ct = default)
Parameters
queryIDOrName string
Returns
Task <QueryResult <PreparedQueryExecuteResponse >>
Execute(string, QueryOptions, CancellationToken)
public Task<QueryResult<PreparedQueryExecuteResponse>> Execute(string queryIDOrName, QueryOptions q, CancellationToken ct = default)
Parameters
queryIDOrName string
Returns
Task <QueryResult <PreparedQueryExecuteResponse >>
Explain(string, QueryOptions, CancellationToken)
Shows which query a name resolves to, the fully interpolated template (if it's a template), as well as additional info about the execution of a query.
public Task<QueryResult<PreparedQueryExplainResponse>> Explain(string queryIDOrName, QueryOptions q, CancellationToken ct = default)
Parameters
queryIDOrName string
Specifies the UUID of the query to explain. This can also be the name of an existing prepared query, or a name that matches a prefix name for a prepared query template
Query Options
Cancellation Token
Returns
Task <QueryResult <PreparedQueryExplainResponse >>
Returns a single prepared query
Explain(string, CancellationToken)
Shows which query a name resolves to, the fully interpolated template (if it's a template), as well as additional info about the execution of a query.
public Task<QueryResult<PreparedQueryExplainResponse>> Explain(string queryIDOrName, CancellationToken ct = default)
Parameters
queryIDOrName string
Specifies the UUID of the query to explain. This can also be the name of an existing prepared query, or a name that matches a prefix name for a prepared query template
Cancellation Token
Returns
Task <QueryResult <PreparedQueryExplainResponse >>
Returns a single prepared query
Get(string, CancellationToken)
public Task<QueryResult<PreparedQueryDefinition[]>> Get(string queryID, CancellationToken ct = default)
Parameters
queryID string
Returns
Task <QueryResult <PreparedQueryDefinition []>>
Get(string, QueryOptions, CancellationToken)
public Task<QueryResult<PreparedQueryDefinition[]>> Get(string queryID, QueryOptions q, CancellationToken ct = default)
Parameters
queryID string
Returns
Task <QueryResult <PreparedQueryDefinition []>>
List(CancellationToken)
public Task<QueryResult<PreparedQueryDefinition[]>> List(CancellationToken ct = default)
Parameters
Returns
Task <QueryResult <PreparedQueryDefinition []>>
List(QueryOptions, CancellationToken)
public Task<QueryResult<PreparedQueryDefinition[]>> List(QueryOptions q, CancellationToken ct = default)
Parameters
Returns
Task <QueryResult <PreparedQueryDefinition []>>
Update(PreparedQueryDefinition, CancellationToken)
public Task<WriteResult> Update(PreparedQueryDefinition query, CancellationToken ct = default)
Parameters
query PreparedQueryDefinition
Returns
Task <WriteResult >
Update(PreparedQueryDefinition, WriteOptions, CancellationToken)
public Task<WriteResult> Update(PreparedQueryDefinition query, WriteOptions q, CancellationToken ct = default)
Parameters
query PreparedQueryDefinition
Returns
Task <WriteResult >