Class RequestHeaderAnnotation

Namespace

Temporalio.Api.Protometa.V1

Assembly

Temporalio.dll

RequestHeaderAnnotation allows specifying that field values from a request should be propagated as outbound headers.

The value field supports template interpolation where field paths enclosed in braces will be replaced with the actual field values from the request. For example: value: "{workflow_execution.workflow_id}" value: "workflow-{workflow_execution.workflow_id}" value: "{namespace}/{workflow_execution.workflow_id}"

public sealed class RequestHeaderAnnotation : IMessage<RequestHeaderAnnotation>, IEquatable<RequestHeaderAnnotation>, IDeepCloneable<RequestHeaderAnnotation>, IBufferMessage, IMessage

Inheritance

object

RequestHeaderAnnotation

Implements

IMessage<RequestHeaderAnnotation>

IEquatable<RequestHeaderAnnotation>

IDeepCloneable<RequestHeaderAnnotation>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

RequestHeaderAnnotation()

public RequestHeaderAnnotation()

RequestHeaderAnnotation(RequestHeaderAnnotation)

public RequestHeaderAnnotation(RequestHeaderAnnotation other)

Parameters

other RequestHeaderAnnotation

Fields

HeaderFieldNumber

Field number for the "header" field.

public const int HeaderFieldNumber = 1

Field Value

int

ValueFieldNumber

Field number for the "value" field.

public const int ValueFieldNumber = 2

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Header

The name of the header to set (e.g., "temporal-resource-id")

public string Header { get; set; }

Property Value

string

Parser

public static MessageParser<RequestHeaderAnnotation> Parser { get; }

Property Value

MessageParser<RequestHeaderAnnotation>

Value

A template string that may contain field paths in braces. Field paths use dot notation to traverse nested messages. Example: "{workflow_execution.workflow_id}"

public string Value { get; set; }

Property Value

string

Methods

CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

public int CalculateSize()

Returns

int

The number of bytes required to write this message to a coded output stream.

Clone()

Creates a deep clone of this object.

public RequestHeaderAnnotation Clone()

Returns

RequestHeaderAnnotation

A deep clone of this object.

Equals(object)

Determines whether the specified object is equal to the current object.

public override bool Equals(object other)

Parameters

other object

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

Equals(RequestHeaderAnnotation)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(RequestHeaderAnnotation other)

Parameters

other RequestHeaderAnnotation

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

MergeFrom(CodedInputStream)

Merges the data from the specified coded input stream with the current message.

public void MergeFrom(CodedInputStream input)

Parameters

input CodedInputStream

Remarks

See the user guide for precise merge semantics.

MergeFrom(RequestHeaderAnnotation)

Merges the given message into this one.

public void MergeFrom(RequestHeaderAnnotation other)

Parameters

other RequestHeaderAnnotation

Remarks

See the user guide for precise merge semantics.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

WriteTo(CodedOutputStream)

Writes the data to the given coded output stream.

public void WriteTo(CodedOutputStream output)

Parameters

output CodedOutputStream

Coded output stream to write the data to. Must not be null.