Class PostRequest<TIn, TOut>
Namespace: Consul
Assembly: Consul.dll
Performs a POST to API endpoints in Consul, sending and returning generic types
public class PostRequest<TIn, TOut> : ConsulRequest
Type Parameters
TIn
A generic type to be serialised and sent with the POST
TOut
A generic type to be deserialised and returned
Inheritance
object ← ConsulRequest ← PostRequest<TIn, TOut>
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
PostRequest(ConsulClient, string, TIn, WriteOptions)
public PostRequest(ConsulClient client, string url, TIn body, WriteOptions options = null)
Parameters
client ConsulClient
url string
body TIn
options WriteOptions
Properties
Options
public WriteOptions 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 POST request to the API
public Task<WriteResult<TOut>> 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 <WriteResult <TOut>>
The result of the POST, including a deserialised generic type object