Class WorkflowQueryResult

Namespace

Temporalio.Api.Query.V1

Assembly

Temporalio.dll

Answer to a WorkflowQuery

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

Inheritance

object

WorkflowQueryResult

Implements

IMessage<WorkflowQueryResult>

IEquatable<WorkflowQueryResult>

IDeepCloneable<WorkflowQueryResult>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

WorkflowQueryResult()

public WorkflowQueryResult()

WorkflowQueryResult(WorkflowQueryResult)

public WorkflowQueryResult(WorkflowQueryResult other)

Parameters

other WorkflowQueryResult

Fields

AnswerFieldNumber

Field number for the "answer" field.

public const int AnswerFieldNumber = 2

Field Value

int

ErrorMessageFieldNumber

Field number for the "error_message" field.

public const int ErrorMessageFieldNumber = 3

Field Value

int

FailureFieldNumber

Field number for the "failure" field.

public const int FailureFieldNumber = 4

Field Value

int

ResultTypeFieldNumber

Field number for the "result_type" field.

public const int ResultTypeFieldNumber = 1

Field Value

int

Properties

Answer

Set when the query succeeds with the results. Mutually exclusive with error_message and failure.

public Payloads Answer { get; set; }

Property Value

Payloads

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

ErrorMessage

Mutually exclusive with answer. Set when the query fails. See also the newer failure field.

public string ErrorMessage { get; set; }

Property Value

string

Failure

The full reason for this query failure. This field is newer than error_message and can be encoded by the SDK's failure converter to support E2E encryption of messages and stack traces. Mutually exclusive with answer. Set when the query fails.

public Failure Failure { get; set; }

Property Value

Failure

Parser

public static MessageParser<WorkflowQueryResult> Parser { get; }

Property Value

MessageParser<WorkflowQueryResult>

ResultType

Did the query succeed or fail?

public QueryResultType ResultType { get; set; }

Property Value

QueryResultType

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 WorkflowQueryResult Clone()

Returns

WorkflowQueryResult

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

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

public bool Equals(WorkflowQueryResult other)

Parameters

other WorkflowQueryResult

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

Merges the given message into this one.

public void MergeFrom(WorkflowQueryResult other)

Parameters

other WorkflowQueryResult

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.