Class WorkflowQuery

Namespace

Temporalio.Api.Query.V1

Assembly

Temporalio.dll

See https://docs.temporal.io/docs/concepts/queries/

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

Inheritance

object

WorkflowQuery

Implements

IMessage<WorkflowQuery>

IEquatable<WorkflowQuery>

IDeepCloneable<WorkflowQuery>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

WorkflowQuery()

public WorkflowQuery()

WorkflowQuery(WorkflowQuery)

public WorkflowQuery(WorkflowQuery other)

Parameters

other WorkflowQuery

Fields

HeaderFieldNumber

Field number for the "header" field.

public const int HeaderFieldNumber = 3

Field Value

int

QueryArgsFieldNumber

Field number for the "query_args" field.

public const int QueryArgsFieldNumber = 2

Field Value

int

QueryTypeFieldNumber

Field number for the "query_type" field.

public const int QueryTypeFieldNumber = 1

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Header

Headers that were passed by the caller of the query and copied by temporal server into the workflow task.

public Header Header { get; set; }

Property Value

Header

Parser

public static MessageParser<WorkflowQuery> Parser { get; }

Property Value

MessageParser<WorkflowQuery>

QueryArgs

Serialized arguments that will be provided to the query handler.

public Payloads QueryArgs { get; set; }

Property Value

Payloads

QueryType

The workflow-author-defined identifier of the query. Typically a function name.

public string QueryType { 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 WorkflowQuery Clone()

Returns

WorkflowQuery

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(WorkflowQuery)

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

public bool Equals(WorkflowQuery other)

Parameters

other WorkflowQuery

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(WorkflowQuery)

Merges the given message into this one.

public void MergeFrom(WorkflowQuery other)

Parameters

other WorkflowQuery

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.