Skip to main content

Class PreparedQueryDefinition

Namespace: Consul
Assembly: Consul.dll

PrepatedQueryDefinition defines a complete prepared query.

public class PreparedQueryDefinition

Inheritance

objectPreparedQueryDefinition

Inherited Members

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

Properties

DNS

DNS has options that control how the results of this query are served over DNS.

[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public QueryDNSOptions DNS { get; set; }

Property Value

QueryDNSOptions

ID

ID is this UUID-based ID for the query, always generated by Consul.

public string ID { get; set; }

Property Value

string

Name

Name is an optional friendly name for the query supplied by the user. NOTE - if this feature is used then it will reduce the security of any read ACL associated with this query/service since this name can be used to locate nodes with supplying any ACL.

public string Name { get; set; }

Property Value

string

Service

Service defines a service query (leaving things open for other types later).

[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public ServiceQuery Service { get; set; }

Property Value

ServiceQuery

Session

Session is an optional session to tie this query's lifetime to. If this is omitted then the query will not expire.

[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public string Session { get; set; }

Property Value

string

Template

[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public QueryTemplate Template { get; set; }

Property Value

QueryTemplate

Token

Token is the ACL token used when the query was created, and it is used when a query is subsequently executed. This token, or a token with management privileges, must be used to change the query later.

[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public string Token { get; set; }

Property Value

string

  • Properties
    • DNS
    • ID
    • Name
    • Service
    • Session
    • Template
    • Token