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 Details

    • getNamespace

      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

      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

      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

      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

      @Deprecated List<WorkflowExecution> getExecutionsList()
      Deprecated.
       Executions to apply the batch operation
 This field and `visibility_query` are mutually exclusive
 DEPRECATED: Use `target_executions` instead.
      repeated .temporal.api.common.v1.WorkflowExecution executions = 5 [deprecated = true];

    • getExecutions

      @Deprecated WorkflowExecution getExecutions(int index)
      Deprecated.
       Executions to apply the batch operation
 This field and `visibility_query` are mutually exclusive
 DEPRECATED: Use `target_executions` instead.
      repeated .temporal.api.common.v1.WorkflowExecution executions = 5 [deprecated = true];

    • getExecutionsCount

      @Deprecated int getExecutionsCount()
      Deprecated.
       Executions to apply the batch operation
 This field and `visibility_query` are mutually exclusive
 DEPRECATED: Use `target_executions` instead.
      repeated .temporal.api.common.v1.WorkflowExecution executions = 5 [deprecated = true];

    • getExecutionsOrBuilderList

      @Deprecated List<? extends WorkflowExecutionOrBuilder> getExecutionsOrBuilderList()
      Deprecated.
       Executions to apply the batch operation
 This field and `visibility_query` are mutually exclusive
 DEPRECATED: Use `target_executions` instead.
      repeated .temporal.api.common.v1.WorkflowExecution executions = 5 [deprecated = true];

    • getExecutionsOrBuilder

      @Deprecated WorkflowExecutionOrBuilder getExecutionsOrBuilder(int index)
      Deprecated.
       Executions to apply the batch operation
 This field and `visibility_query` are mutually exclusive
 DEPRECATED: Use `target_executions` instead.
      repeated .temporal.api.common.v1.WorkflowExecution executions = 5 [deprecated = true];

    • getTargetExecutionsList

      List<Execution> getTargetExecutionsList()
       Target executions to apply the batch operation. This field and `visibility_query`
 are mutually exclusive.
      repeated .temporal.api.common.v1.Execution target_executions = 22;

    • getTargetExecutions

      Execution getTargetExecutions(int index)
       Target executions to apply the batch operation. This field and `visibility_query`
 are mutually exclusive.
      repeated .temporal.api.common.v1.Execution target_executions = 22;

    • getTargetExecutionsCount

      int getTargetExecutionsCount()
       Target executions to apply the batch operation. This field and `visibility_query`
 are mutually exclusive.
      repeated .temporal.api.common.v1.Execution target_executions = 22;

    • getTargetExecutionsOrBuilderList

      List<? extends ExecutionOrBuilder> getTargetExecutionsOrBuilderList()
       Target executions to apply the batch operation. This field and `visibility_query`
 are mutually exclusive.
      repeated .temporal.api.common.v1.Execution target_executions = 22;

    • getTargetExecutionsOrBuilder

      ExecutionOrBuilder getTargetExecutionsOrBuilder(int index)
       Target executions to apply the batch operation. This field and `visibility_query`
 are mutually exclusive.
      repeated .temporal.api.common.v1.Execution target_executions = 22;

    • 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.

    • getUpdateWorkflowOptionsOperationOrBuilder

      BatchOperationUpdateWorkflowExecutionOptionsOrBuilder getUpdateWorkflowOptionsOperationOrBuilder()
      .temporal.api.batch.v1.BatchOperationUpdateWorkflowExecutionOptions update_workflow_options_operation = 15;

    • 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;

    • hasResetActivitiesOperation

      boolean hasResetActivitiesOperation()
      .temporal.api.batch.v1.BatchOperationResetActivities reset_activities_operation = 17;
      Returns:
      Whether the resetActivitiesOperation field is set.

    • getResetActivitiesOperation

      BatchOperationResetActivities getResetActivitiesOperation()
      .temporal.api.batch.v1.BatchOperationResetActivities reset_activities_operation = 17;
      Returns:
      The resetActivitiesOperation.

    • getResetActivitiesOperationOrBuilder

      BatchOperationResetActivitiesOrBuilder getResetActivitiesOperationOrBuilder()
      .temporal.api.batch.v1.BatchOperationResetActivities reset_activities_operation = 17;

    • hasUpdateActivityOptionsOperation

      boolean hasUpdateActivityOptionsOperation()
      .temporal.api.batch.v1.BatchOperationUpdateActivityOptions update_activity_options_operation = 18;
      Returns:
      Whether the updateActivityOptionsOperation field is set.

    • getUpdateActivityOptionsOperation

      BatchOperationUpdateActivityOptions getUpdateActivityOptionsOperation()
      .temporal.api.batch.v1.BatchOperationUpdateActivityOptions update_activity_options_operation = 18;
      Returns:
      The updateActivityOptionsOperation.

    • getUpdateActivityOptionsOperationOrBuilder

      BatchOperationUpdateActivityOptionsOrBuilder getUpdateActivityOptionsOperationOrBuilder()
      .temporal.api.batch.v1.BatchOperationUpdateActivityOptions update_activity_options_operation = 18;

    • hasCancelActivitiesOperation

      boolean hasCancelActivitiesOperation()
      .temporal.api.batch.v1.BatchOperationCancelActivities cancel_activities_operation = 19;
      Returns:
      Whether the cancelActivitiesOperation field is set.

    • getCancelActivitiesOperation

      BatchOperationCancelActivities getCancelActivitiesOperation()
      .temporal.api.batch.v1.BatchOperationCancelActivities cancel_activities_operation = 19;
      Returns:
      The cancelActivitiesOperation.

    • getCancelActivitiesOperationOrBuilder

      BatchOperationCancelActivitiesOrBuilder getCancelActivitiesOperationOrBuilder()
      .temporal.api.batch.v1.BatchOperationCancelActivities cancel_activities_operation = 19;

    • hasTerminateActivitiesOperation

      boolean hasTerminateActivitiesOperation()
      .temporal.api.batch.v1.BatchOperationTerminateActivities terminate_activities_operation = 20;
      Returns:
      Whether the terminateActivitiesOperation field is set.

    • getTerminateActivitiesOperation

      BatchOperationTerminateActivities getTerminateActivitiesOperation()
      .temporal.api.batch.v1.BatchOperationTerminateActivities terminate_activities_operation = 20;
      Returns:
      The terminateActivitiesOperation.

    • getTerminateActivitiesOperationOrBuilder

      BatchOperationTerminateActivitiesOrBuilder getTerminateActivitiesOperationOrBuilder()
      .temporal.api.batch.v1.BatchOperationTerminateActivities terminate_activities_operation = 20;

    • hasDeleteActivitiesOperation

      boolean hasDeleteActivitiesOperation()
      .temporal.api.batch.v1.BatchOperationDeleteActivities delete_activities_operation = 21;
      Returns:
      Whether the deleteActivitiesOperation field is set.

    • getDeleteActivitiesOperation

      BatchOperationDeleteActivities getDeleteActivitiesOperation()
      .temporal.api.batch.v1.BatchOperationDeleteActivities delete_activities_operation = 21;
      Returns:
      The deleteActivitiesOperation.

    • getDeleteActivitiesOperationOrBuilder

      BatchOperationDeleteActivitiesOrBuilder getDeleteActivitiesOperationOrBuilder()
      .temporal.api.batch.v1.BatchOperationDeleteActivities delete_activities_operation = 21;

    • getOperationCase

      StartBatchOperationRequest.OperationCase getOperationCase()