Class CreateWorkflowRuleRequest

Namespace

Temporalio.Api.WorkflowService.V1

Assembly

Temporalio.dll

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

Inheritance

object

CreateWorkflowRuleRequest

Implements

IMessage<CreateWorkflowRuleRequest>

IEquatable<CreateWorkflowRuleRequest>

IDeepCloneable<CreateWorkflowRuleRequest>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

CreateWorkflowRuleRequest()

public CreateWorkflowRuleRequest()

CreateWorkflowRuleRequest(CreateWorkflowRuleRequest)

public CreateWorkflowRuleRequest(CreateWorkflowRuleRequest other)

Parameters

other CreateWorkflowRuleRequest

Fields

DescriptionFieldNumber

Field number for the "description" field.

public const int DescriptionFieldNumber = 6

Field Value

int

ForceScanFieldNumber

Field number for the "force_scan" field.

public const int ForceScanFieldNumber = 3

Field Value

int

IdentityFieldNumber

Field number for the "identity" field.

public const int IdentityFieldNumber = 5

Field Value

int

NamespaceFieldNumber

Field number for the "namespace" field.

public const int NamespaceFieldNumber = 1

Field Value

int

RequestIdFieldNumber

Field number for the "request_id" field.

public const int RequestIdFieldNumber = 4

Field Value

int

SpecFieldNumber

Field number for the "spec" field.

public const int SpecFieldNumber = 2

Field Value

int

Properties

Description

Rule description.Will be stored with the rule.

public string Description { get; set; }

Property Value

string

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

ForceScan

If true, the rule will be applied to the currently running workflows via batch job. If not set , the rule will only be applied when triggering condition is satisfied. visibility_query in the rule will be used to select the workflows to apply the rule to.

public bool ForceScan { get; set; }

Property Value

bool

Identity

Identity of the actor who created the rule. Will be stored with the rule.

public string Identity { get; set; }

Property Value

string

Namespace

public string Namespace { get; set; }

Property Value

string

Parser

public static MessageParser<CreateWorkflowRuleRequest> Parser { get; }

Property Value

MessageParser<CreateWorkflowRuleRequest>

RequestId

Used to de-dupe requests. Typically should be UUID.

public string RequestId { get; set; }

Property Value

string

Spec

The rule specification .

public WorkflowRuleSpec Spec { get; set; }

Property Value

WorkflowRuleSpec

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

Returns

CreateWorkflowRuleRequest

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

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

public bool Equals(CreateWorkflowRuleRequest other)

Parameters

other CreateWorkflowRuleRequest

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

Merges the given message into this one.

public void MergeFrom(CreateWorkflowRuleRequest other)

Parameters

other CreateWorkflowRuleRequest

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.