Skip to main content

Class PostRequest

Namespace: Consul
Assembly: Consul.dll

Performs a POST to API endpoints in Consul

public class PostRequest : ConsulRequest

Inheritance

objectConsulRequestPostRequest

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, string, WriteOptions)

public PostRequest(ConsulClient client, string url, string body, WriteOptions options = null)

Parameters

client ConsulClient

url string

body string

options WriteOptions

Properties

Options

public WriteOptions Options { get; set; }

Property Value

WriteOptions

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<string>> Execute(CancellationToken ct)

Parameters

ct CancellationToken

Cancellation token for long poll request. If set, OperationCanceledException will be thrown if the request is cancelled before completing

Returns

Task <WriteResult <string >>

The result of the POST, including a string of data

  • Constructors
    • PostRequest(ConsulClient, string, string, WriteOptions)
  • Properties
    • Options
  • Methods
    • ApplyHeaders(HttpRequestMessage, ConsulClientConfiguration)
    • ApplyOptions(ConsulClientConfiguration)
    • Execute(CancellationToken)