Class GetRequest
Namespace: Consul
Assembly: Consul.dll
Performs a GET to API endpoints in Consul
public class GetRequest : ConsulRequest
Inheritance
object ← ConsulRequest ← GetRequest
Inherited Members
ConsulRequest.ApplyOptions(ConsulClientConfiguration) , ConsulRequest.ApplyHeaders(HttpRequestMessage, ConsulClientConfiguration) , ConsulRequest.BuildConsulUri(string, Dictionary<string, string>) , ConsulRequest.Deserialize<TOut>(Stream) , ConsulRequest.Serialize(object) , object.Equals(object) , object.Equals(object, object) , object.GetHashCode() , object.GetType() , object.MemberwiseClone() , object.ReferenceEquals(object, object) , object.ToString()
Constructors
GetRequest(ConsulClient, string, QueryOptions)
public GetRequest(ConsulClient client, string url, QueryOptions options = null)
Parameters
client ConsulClient
url string
options QueryOptions
Properties
Options
public QueryOptions Options { get; set; }
Property Value
Methods
ApplyHeaders(HttpRequestMessage, ConsulClientConfiguration)
protected override void ApplyHeaders(HttpRequestMessage message, ConsulClientConfiguration clientConfig)
Parameters
message HttpRequestMessage
clientConfig ConsulClientConfiguration
ApplyOptions(ConsulClientConfiguration)
protected override void ApplyOptions(ConsulClientConfiguration clientConfig)
Parameters
clientConfig ConsulClientConfiguration
Execute(CancellationToken)
Execute the GET request to the API
public Task<QueryResult<string>> Execute(CancellationToken ct)
Parameters
Cancellation token for long poll request. If set, OperationCanceledException will be thrown if the request is cancelled before completing
Returns
Task <QueryResult <string >>
The results of the GET, including a string of returned data