Class BatchOperationUpdateWorkflowExecutionOptions

Namespace

Temporalio.Api.Batch.V1

Assembly

Temporalio.dll

BatchOperationUpdateWorkflowExecutionOptions sends UpdateWorkflowExecutionOptions requests to batch workflows. Keep the parameters in sync with temporal.api.workflowservice.v1.UpdateWorkflowExecutionOptionsRequest.

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

Inheritance

object

BatchOperationUpdateWorkflowExecutionOptions

Implements

IMessage<BatchOperationUpdateWorkflowExecutionOptions>

IEquatable<BatchOperationUpdateWorkflowExecutionOptions>

IDeepCloneable<BatchOperationUpdateWorkflowExecutionOptions>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

BatchOperationUpdateWorkflowExecutionOptions()

public BatchOperationUpdateWorkflowExecutionOptions()

BatchOperationUpdateWorkflowExecutionOptions(BatchOperationUpdateWorkflowExecutionOptions)

public BatchOperationUpdateWorkflowExecutionOptions(BatchOperationUpdateWorkflowExecutionOptions other)

Parameters

other BatchOperationUpdateWorkflowExecutionOptions

Fields

IdentityFieldNumber

Field number for the "identity" field.

public const int IdentityFieldNumber = 1

Field Value

int

UpdateMaskFieldNumber

Field number for the "update_mask" field.

public const int UpdateMaskFieldNumber = 3

Field Value

int

WorkflowExecutionOptionsFieldNumber

Field number for the "workflow_execution_options" field.

public const int WorkflowExecutionOptionsFieldNumber = 2

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Identity

The identity of the worker/client.

public string Identity { get; set; }

Property Value

string

Parser

public static MessageParser<BatchOperationUpdateWorkflowExecutionOptions> Parser { get; }

Property Value

MessageParser<BatchOperationUpdateWorkflowExecutionOptions>

UpdateMask

Controls which fields from workflow_execution_options will be applied. To unset a field, set it to null and use the update mask to indicate that it should be mutated.

public FieldMask UpdateMask { get; set; }

Property Value

FieldMask

WorkflowExecutionOptions

Workflow Execution options. Partial updates are accepted and controlled by update_mask.

public WorkflowExecutionOptions WorkflowExecutionOptions { get; set; }

Property Value

WorkflowExecutionOptions

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

Returns

BatchOperationUpdateWorkflowExecutionOptions

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

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

public bool Equals(BatchOperationUpdateWorkflowExecutionOptions other)

Parameters

other BatchOperationUpdateWorkflowExecutionOptions

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

Merges the given message into this one.

public void MergeFrom(BatchOperationUpdateWorkflowExecutionOptions other)

Parameters

other BatchOperationUpdateWorkflowExecutionOptions

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.