Class StartBatchOperationRequest
- Namespace
- Temporalio.Api.WorkflowService.V1
- Assembly
- Temporalio.dll
public sealed class StartBatchOperationRequest : IMessage<StartBatchOperationRequest>, IEquatable<StartBatchOperationRequest>, IDeepCloneable<StartBatchOperationRequest>, IBufferMessage, IMessage
- Inheritance
-
StartBatchOperationRequest
- Implements
- Inherited Members
Constructors
StartBatchOperationRequest()
public StartBatchOperationRequest()
StartBatchOperationRequest(StartBatchOperationRequest)
public StartBatchOperationRequest(StartBatchOperationRequest other)
Parameters
Fields
CancellationOperationFieldNumber
Field number for the "cancellation_operation" field.
public const int CancellationOperationFieldNumber = 12
Field Value
DeletionOperationFieldNumber
Field number for the "deletion_operation" field.
public const int DeletionOperationFieldNumber = 13
Field Value
ExecutionsFieldNumber
Field number for the "executions" field.
public const int ExecutionsFieldNumber = 5
Field Value
JobIdFieldNumber
Field number for the "job_id" field.
public const int JobIdFieldNumber = 3
Field Value
NamespaceFieldNumber
Field number for the "namespace" field.
public const int NamespaceFieldNumber = 1
Field Value
ReasonFieldNumber
Field number for the "reason" field.
public const int ReasonFieldNumber = 4
Field Value
ResetOperationFieldNumber
Field number for the "reset_operation" field.
public const int ResetOperationFieldNumber = 14
Field Value
SignalOperationFieldNumber
Field number for the "signal_operation" field.
public const int SignalOperationFieldNumber = 11
Field Value
TerminationOperationFieldNumber
Field number for the "termination_operation" field.
public const int TerminationOperationFieldNumber = 10
Field Value
VisibilityQueryFieldNumber
Field number for the "visibility_query" field.
public const int VisibilityQueryFieldNumber = 2
Field Value
Properties
CancellationOperation
public BatchOperationCancellation CancellationOperation { get; set; }
Property Value
DeletionOperation
public BatchOperationDeletion DeletionOperation { get; set; }
Property Value
Descriptor
public static MessageDescriptor Descriptor { get; }
Property Value
Executions
Executions to apply the batch operation This field and VisibilityQuery are mutually exclusive
public RepeatedField<WorkflowExecution> Executions { get; }
Property Value
JobId
Job ID defines the unique ID for the batch job
public string JobId { get; set; }
Property Value
Namespace
Namespace that contains the batch operation
public string Namespace { get; set; }
Property Value
OperationCase
public StartBatchOperationRequest.OperationOneofCase OperationCase { get; }
Property Value
Parser
public static MessageParser<StartBatchOperationRequest> Parser { get; }
Property Value
Reason
Reason to perform the batch operation
public string Reason { get; set; }
Property Value
ResetOperation
public BatchOperationReset ResetOperation { get; set; }
Property Value
SignalOperation
public BatchOperationSignal SignalOperation { get; set; }
Property Value
TerminationOperation
public BatchOperationTermination TerminationOperation { get; set; }
Property Value
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
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
Equals(StartBatchOperationRequest)
Indicates whether the current object is equal to another object of the same type.
public bool Equals(StartBatchOperationRequest other)
Parameters
other
StartBatchOperationRequestAn object to compare with this object.
Returns
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
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
CodedOutputStreamCoded output stream to write the data to. Must not be null.