Package io.temporal.api.workflowservice.v1

Interface StartBatchOperationRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    StartBatchOperationRequest, StartBatchOperationRequest.Builder
    @Generated(value="protoc",
           comments="annotations:StartBatchOperationRequestOrBuilder.java.pb.meta")
public interface StartBatchOperationRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getNamespace

        java.lang.String getNamespace()
         Namespace that contains the batch operation
        string namespace = 1;
        Returns:
        The namespace.

      • getNamespaceBytes

        com.google.protobuf.ByteString getNamespaceBytes()
         Namespace that contains the batch operation
        string namespace = 1;
        Returns:
        The bytes for namespace.

      • getVisibilityQuery

        java.lang.String getVisibilityQuery()
         Visibility query defines the the group of workflow to apply the batch operation
 This field and `executions` are mutually exclusive
        string visibility_query = 2;
        Returns:
        The visibilityQuery.

      • getVisibilityQueryBytes

        com.google.protobuf.ByteString getVisibilityQueryBytes()
         Visibility query defines the the group of workflow to apply the batch operation
 This field and `executions` are mutually exclusive
        string visibility_query = 2;
        Returns:
        The bytes for visibilityQuery.

      • getJobId

        java.lang.String getJobId()
         Job ID defines the unique ID for the batch job
        string job_id = 3;
        Returns:
        The jobId.

      • getJobIdBytes

        com.google.protobuf.ByteString getJobIdBytes()
         Job ID defines the unique ID for the batch job
        string job_id = 3;
        Returns:
        The bytes for jobId.

      • getReason

        java.lang.String getReason()
         Reason to perform the batch operation
        string reason = 4;
        Returns:
        The reason.

      • getReasonBytes

        com.google.protobuf.ByteString getReasonBytes()
         Reason to perform the batch operation
        string reason = 4;
        Returns:
        The bytes for reason.

      • getExecutionsList

        java.util.List<WorkflowExecution> getExecutionsList()
         Executions to apply the batch operation
 This field and `visibility_query` are mutually exclusive
        repeated .temporal.api.common.v1.WorkflowExecution executions = 5;

      • getExecutions

        WorkflowExecution getExecutions​(int index)
         Executions to apply the batch operation
 This field and `visibility_query` are mutually exclusive
        repeated .temporal.api.common.v1.WorkflowExecution executions = 5;

      • getExecutionsCount

        int getExecutionsCount()
         Executions to apply the batch operation
 This field and `visibility_query` are mutually exclusive
        repeated .temporal.api.common.v1.WorkflowExecution executions = 5;

      • getExecutionsOrBuilderList

        java.util.List<? extends WorkflowExecutionOrBuilder> getExecutionsOrBuilderList()
         Executions to apply the batch operation
 This field and `visibility_query` are mutually exclusive
        repeated .temporal.api.common.v1.WorkflowExecution executions = 5;

      • getExecutionsOrBuilder

        WorkflowExecutionOrBuilder getExecutionsOrBuilder​(int index)
         Executions to apply the batch operation
 This field and `visibility_query` are mutually exclusive
        repeated .temporal.api.common.v1.WorkflowExecution executions = 5;

      • getMaxOperationsPerSecond

        float getMaxOperationsPerSecond()
         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.
        float max_operations_per_second = 6;
        Returns:
        The maxOperationsPerSecond.

      • hasTerminationOperation

        boolean hasTerminationOperation()
        .temporal.api.batch.v1.BatchOperationTermination termination_operation = 10;
        Returns:
        Whether the terminationOperation field is set.

      • getTerminationOperation

        BatchOperationTermination getTerminationOperation()
        .temporal.api.batch.v1.BatchOperationTermination termination_operation = 10;
        Returns:
        The terminationOperation.

      • getTerminationOperationOrBuilder

        BatchOperationTerminationOrBuilder getTerminationOperationOrBuilder()
        .temporal.api.batch.v1.BatchOperationTermination termination_operation = 10;

      • hasSignalOperation

        boolean hasSignalOperation()
        .temporal.api.batch.v1.BatchOperationSignal signal_operation = 11;
        Returns:
        Whether the signalOperation field is set.

      • getSignalOperation

        BatchOperationSignal getSignalOperation()
        .temporal.api.batch.v1.BatchOperationSignal signal_operation = 11;
        Returns:
        The signalOperation.

      • getSignalOperationOrBuilder

        BatchOperationSignalOrBuilder getSignalOperationOrBuilder()
        .temporal.api.batch.v1.BatchOperationSignal signal_operation = 11;

      • hasCancellationOperation

        boolean hasCancellationOperation()
        .temporal.api.batch.v1.BatchOperationCancellation cancellation_operation = 12;
        Returns:
        Whether the cancellationOperation field is set.

      • getCancellationOperation

        BatchOperationCancellation getCancellationOperation()
        .temporal.api.batch.v1.BatchOperationCancellation cancellation_operation = 12;
        Returns:
        The cancellationOperation.

      • getCancellationOperationOrBuilder

        BatchOperationCancellationOrBuilder getCancellationOperationOrBuilder()
        .temporal.api.batch.v1.BatchOperationCancellation cancellation_operation = 12;

      • hasDeletionOperation

        boolean hasDeletionOperation()
        .temporal.api.batch.v1.BatchOperationDeletion deletion_operation = 13;
        Returns:
        Whether the deletionOperation field is set.

      • getDeletionOperation

        BatchOperationDeletion getDeletionOperation()
        .temporal.api.batch.v1.BatchOperationDeletion deletion_operation = 13;
        Returns:
        The deletionOperation.

      • getDeletionOperationOrBuilder

        BatchOperationDeletionOrBuilder getDeletionOperationOrBuilder()
        .temporal.api.batch.v1.BatchOperationDeletion deletion_operation = 13;

      • hasResetOperation

        boolean hasResetOperation()
        .temporal.api.batch.v1.BatchOperationReset reset_operation = 14;
        Returns:
        Whether the resetOperation field is set.

      • getResetOperation

        BatchOperationReset getResetOperation()
        .temporal.api.batch.v1.BatchOperationReset reset_operation = 14;
        Returns:
        The resetOperation.

      • getResetOperationOrBuilder

        BatchOperationResetOrBuilder getResetOperationOrBuilder()
        .temporal.api.batch.v1.BatchOperationReset reset_operation = 14;

      • hasUpdateWorkflowOptionsOperation

        boolean hasUpdateWorkflowOptionsOperation()
        .temporal.api.batch.v1.BatchOperationUpdateWorkflowExecutionOptions update_workflow_options_operation = 15;
        Returns:
        Whether the updateWorkflowOptionsOperation field is set.

      • getUpdateWorkflowOptionsOperation

        BatchOperationUpdateWorkflowExecutionOptions getUpdateWorkflowOptionsOperation()
        .temporal.api.batch.v1.BatchOperationUpdateWorkflowExecutionOptions update_workflow_options_operation = 15;
        Returns:
        The updateWorkflowOptionsOperation.

      • hasUnpauseActivitiesOperation

        boolean hasUnpauseActivitiesOperation()
        .temporal.api.batch.v1.BatchOperationUnpauseActivities unpause_activities_operation = 16;
        Returns:
        Whether the unpauseActivitiesOperation field is set.

      • getUnpauseActivitiesOperation

        BatchOperationUnpauseActivities getUnpauseActivitiesOperation()
        .temporal.api.batch.v1.BatchOperationUnpauseActivities unpause_activities_operation = 16;
        Returns:
        The unpauseActivitiesOperation.

      • getUnpauseActivitiesOperationOrBuilder

        BatchOperationUnpauseActivitiesOrBuilder getUnpauseActivitiesOperationOrBuilder()
        .temporal.api.batch.v1.BatchOperationUnpauseActivities unpause_activities_operation = 16;