Skip to main content

Class PutRequest<TIn>

Namespace: Consul
Assembly: Consul.dll

Performs a PUT to API endpoints in Consul, sending a generic type

public class PutRequest<TIn> : ConsulRequest

Type Parameters

TIn

A generic type to be serialised and sent

Inheritance

objectConsulRequestPutRequest<TIn>

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

PutRequest(ConsulClient, string, TIn, WriteOptions)

public PutRequest(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

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 PUT request to the API

public Task<WriteResult> 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 >

The result of the PUT

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