Class WorkflowRuleSpec

Namespace

Temporalio.Api.Rules.V1

Assembly

Temporalio.dll

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

Inheritance

object

WorkflowRuleSpec

Implements

IMessage<WorkflowRuleSpec>

IEquatable<WorkflowRuleSpec>

IDeepCloneable<WorkflowRuleSpec>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

WorkflowRuleSpec()

public WorkflowRuleSpec()

WorkflowRuleSpec(WorkflowRuleSpec)

public WorkflowRuleSpec(WorkflowRuleSpec other)

Parameters

other WorkflowRuleSpec

Fields

ActionsFieldNumber

Field number for the "actions" field.

public const int ActionsFieldNumber = 4

Field Value

int

ActivityStartFieldNumber

Field number for the "activity_start" field.

public const int ActivityStartFieldNumber = 2

Field Value

int

ExpirationTimeFieldNumber

Field number for the "expiration_time" field.

public const int ExpirationTimeFieldNumber = 5

Field Value

int

IdFieldNumber

Field number for the "id" field.

public const int IdFieldNumber = 1

Field Value

int

VisibilityQueryFieldNumber

Field number for the "visibility_query" field.

public const int VisibilityQueryFieldNumber = 3

Field Value

int

Properties

Actions

WorkflowRuleAction to be taken when the rule is triggered and predicate is matched.

public RepeatedField<WorkflowRuleAction> Actions { get; }

Property Value

RepeatedField<WorkflowRuleAction>

ActivityStart

public WorkflowRuleSpec.Types.ActivityStartingTrigger ActivityStart { get; set; }

Property Value

WorkflowRuleSpec.Types.ActivityStartingTrigger

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

ExpirationTime

Expiration time of the rule. After this time, the rule will be deleted. Can be empty if the rule should never expire.

public Timestamp ExpirationTime { get; set; }

Property Value

Timestamp

Id

The id of the new workflow rule. Must be unique within the namespace. Can be set by the user, and can have business meaning.

public string Id { get; set; }

Property Value

string

Parser

public static MessageParser<WorkflowRuleSpec> Parser { get; }

Property Value

MessageParser<WorkflowRuleSpec>

TriggerCase

public WorkflowRuleSpec.TriggerOneofCase TriggerCase { get; }

Property Value

WorkflowRuleSpec.TriggerOneofCase

VisibilityQuery

Restricted Visibility query. This query is used to filter workflows in this namespace to which this rule should apply. It is applied to any running workflow each time a triggering event occurs, before the trigger predicate is evaluated. The following workflow attributes are supported:

• WorkflowType
• WorkflowId
• StartTime
• ExecutionStatus

public string VisibilityQuery { 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.

ClearTrigger()

public void ClearTrigger()

Clone()

Creates a deep clone of this object.

public WorkflowRuleSpec Clone()

Returns

WorkflowRuleSpec

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

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

public bool Equals(WorkflowRuleSpec other)

Parameters

other WorkflowRuleSpec

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

Merges the given message into this one.

public void MergeFrom(WorkflowRuleSpec other)

Parameters

other WorkflowRuleSpec

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.