Class StartBatchOperationRequest

Namespace

Temporalio.Api.WorkflowService.V1

Assembly

Temporalio.dll

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

Inheritance

object

StartBatchOperationRequest

Implements

IMessage<StartBatchOperationRequest>

IEquatable<StartBatchOperationRequest>

IDeepCloneable<StartBatchOperationRequest>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

StartBatchOperationRequest()

public StartBatchOperationRequest()

StartBatchOperationRequest(StartBatchOperationRequest)

public StartBatchOperationRequest(StartBatchOperationRequest other)

Parameters

other StartBatchOperationRequest

Fields

CancellationOperationFieldNumber

Field number for the "cancellation_operation" field.

public const int CancellationOperationFieldNumber = 12

Field Value

int

DeletionOperationFieldNumber

Field number for the "deletion_operation" field.

public const int DeletionOperationFieldNumber = 13

Field Value

int

ExecutionsFieldNumber

Field number for the "executions" field.

public const int ExecutionsFieldNumber = 5

Field Value

int

JobIdFieldNumber

Field number for the "job_id" field.

public const int JobIdFieldNumber = 3

Field Value

int

MaxOperationsPerSecondFieldNumber

Field number for the "max_operations_per_second" field.

public const int MaxOperationsPerSecondFieldNumber = 6

Field Value

int

NamespaceFieldNumber

Field number for the "namespace" field.

public const int NamespaceFieldNumber = 1

Field Value

int

ReasonFieldNumber

Field number for the "reason" field.

public const int ReasonFieldNumber = 4

Field Value

int

ResetOperationFieldNumber

Field number for the "reset_operation" field.

public const int ResetOperationFieldNumber = 14

Field Value

int

SignalOperationFieldNumber

Field number for the "signal_operation" field.

public const int SignalOperationFieldNumber = 11

Field Value

int

TerminationOperationFieldNumber

Field number for the "termination_operation" field.

public const int TerminationOperationFieldNumber = 10

Field Value

int

UnpauseActivitiesOperationFieldNumber

Field number for the "unpause_activities_operation" field.

public const int UnpauseActivitiesOperationFieldNumber = 16

Field Value

int

UpdateWorkflowOptionsOperationFieldNumber

Field number for the "update_workflow_options_operation" field.

public const int UpdateWorkflowOptionsOperationFieldNumber = 15

Field Value

int

VisibilityQueryFieldNumber

Field number for the "visibility_query" field.

public const int VisibilityQueryFieldNumber = 2

Field Value

int

Properties

CancellationOperation

public BatchOperationCancellation CancellationOperation { get; set; }

Property Value

BatchOperationCancellation

DeletionOperation

public BatchOperationDeletion DeletionOperation { get; set; }

Property Value

BatchOperationDeletion

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Executions

Executions to apply the batch operation This field and visibility_query are mutually exclusive

public RepeatedField<WorkflowExecution> Executions { get; }

Property Value

RepeatedField<WorkflowExecution>

JobId

Job ID defines the unique ID for the batch job

public string JobId { get; set; }

Property Value

string

MaxOperationsPerSecond

Limit for the number of operations processed per second within this batch. Its purpose is to reduce the stress on the system caused by batch operations, which helps to prevent system overload and minimize potential delays in executing ongoing tasks for user workers. Note that when no explicit limit is provided, the server will operate according to its limit defined by the dynamic configuration key worker.batcherRPS. This also applies if the value in this field exceeds the server's configured limit.

public float MaxOperationsPerSecond { get; set; }

Property Value

float

Namespace

Namespace that contains the batch operation

public string Namespace { get; set; }

Property Value

string

OperationCase

public StartBatchOperationRequest.OperationOneofCase OperationCase { get; }

Property Value

StartBatchOperationRequest.OperationOneofCase

Parser

public static MessageParser<StartBatchOperationRequest> Parser { get; }

Property Value

MessageParser<StartBatchOperationRequest>

Reason

Reason to perform the batch operation

public string Reason { get; set; }

Property Value

string

ResetOperation

public BatchOperationReset ResetOperation { get; set; }

Property Value

BatchOperationReset

SignalOperation

public BatchOperationSignal SignalOperation { get; set; }

Property Value

BatchOperationSignal

TerminationOperation

public BatchOperationTermination TerminationOperation { get; set; }

Property Value

BatchOperationTermination

UnpauseActivitiesOperation

public BatchOperationUnpauseActivities UnpauseActivitiesOperation { get; set; }

Property Value

BatchOperationUnpauseActivities

UpdateWorkflowOptionsOperation

public BatchOperationUpdateWorkflowExecutionOptions UpdateWorkflowOptionsOperation { get; set; }

Property Value

BatchOperationUpdateWorkflowExecutionOptions

VisibilityQuery

Visibility query defines the the group of workflow to apply the batch operation This field and executions are mutually exclusive

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.

ClearOperation()

public void ClearOperation()

Clone()

Creates a deep clone of this object.

public StartBatchOperationRequest Clone()

Returns

StartBatchOperationRequest

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

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

public bool Equals(StartBatchOperationRequest other)

Parameters

other StartBatchOperationRequest

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

Merges the given message into this one.

public void MergeFrom(StartBatchOperationRequest other)

Parameters

other StartBatchOperationRequest

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.