Package io.temporal.api.workflowservice.v1

Class StartBatchOperationRequest.Builder

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<StartBatchOperationRequest.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<StartBatchOperationRequest.Builder>

      • getDefaultInstanceForType

        public StartBatchOperationRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public StartBatchOperationRequest build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public StartBatchOperationRequest buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • setRepeatedField

        public StartBatchOperationRequest.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                           int index,
                                                           java.lang.Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<StartBatchOperationRequest.Builder>

      • addRepeatedField

        public StartBatchOperationRequest.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                           java.lang.Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<StartBatchOperationRequest.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<StartBatchOperationRequest.Builder>

      • mergeFrom

        public StartBatchOperationRequest.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws java.io.IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<StartBatchOperationRequest.Builder>
        Throws:
        java.io.IOException

      • getNamespaceBytes

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

      • setNamespace

        public StartBatchOperationRequest.Builder setNamespace​(java.lang.String value)
         Namespace that contains the batch operation
        string namespace = 1;
        Parameters:
        value - The namespace to set.
        Returns:
        This builder for chaining.

      • clearNamespace

        public StartBatchOperationRequest.Builder clearNamespace()
         Namespace that contains the batch operation
        string namespace = 1;
        Returns:
        This builder for chaining.

      • setNamespaceBytes

        public StartBatchOperationRequest.Builder setNamespaceBytes​(com.google.protobuf.ByteString value)
         Namespace that contains the batch operation
        string namespace = 1;
        Parameters:
        value - The bytes for namespace to set.
        Returns:
        This builder for chaining.

      • getVisibilityQuery

        public 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;
        Specified by:
        getVisibilityQuery in interface StartBatchOperationRequestOrBuilder
        Returns:
        The visibilityQuery.

      • getVisibilityQueryBytes

        public 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;
        Specified by:
        getVisibilityQueryBytes in interface StartBatchOperationRequestOrBuilder
        Returns:
        The bytes for visibilityQuery.

      • setVisibilityQuery

        public StartBatchOperationRequest.Builder setVisibilityQuery​(java.lang.String value)
         Visibility query defines the the group of workflow to apply the batch operation
 This field and `executions` are mutually exclusive
        string visibility_query = 2;
        Parameters:
        value - The visibilityQuery to set.
        Returns:
        This builder for chaining.

      • clearVisibilityQuery

        public StartBatchOperationRequest.Builder clearVisibilityQuery()
         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:
        This builder for chaining.

      • setVisibilityQueryBytes

        public StartBatchOperationRequest.Builder setVisibilityQueryBytes​(com.google.protobuf.ByteString value)
         Visibility query defines the the group of workflow to apply the batch operation
 This field and `executions` are mutually exclusive
        string visibility_query = 2;
        Parameters:
        value - The bytes for visibilityQuery to set.
        Returns:
        This builder for chaining.

      • getJobIdBytes

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

      • setJobId

        public StartBatchOperationRequest.Builder setJobId​(java.lang.String value)
         Job ID defines the unique ID for the batch job
        string job_id = 3;
        Parameters:
        value - The jobId to set.
        Returns:
        This builder for chaining.

      • clearJobId

        public StartBatchOperationRequest.Builder clearJobId()
         Job ID defines the unique ID for the batch job
        string job_id = 3;
        Returns:
        This builder for chaining.

      • setJobIdBytes

        public StartBatchOperationRequest.Builder setJobIdBytes​(com.google.protobuf.ByteString value)
         Job ID defines the unique ID for the batch job
        string job_id = 3;
        Parameters:
        value - The bytes for jobId to set.
        Returns:
        This builder for chaining.

      • setReason

        public StartBatchOperationRequest.Builder setReason​(java.lang.String value)
         Reason to perform the batch operation
        string reason = 4;
        Parameters:
        value - The reason to set.
        Returns:
        This builder for chaining.

      • setReasonBytes

        public StartBatchOperationRequest.Builder setReasonBytes​(com.google.protobuf.ByteString value)
         Reason to perform the batch operation
        string reason = 4;
        Parameters:
        value - The bytes for reason to set.
        Returns:
        This builder for chaining.

      • getExecutionsCount

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

      • setExecutions

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

      • setExecutions

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

      • addExecutions

        public StartBatchOperationRequest.Builder addExecutions​(WorkflowExecution value)
         Executions to apply the batch operation
 This field and `visibility_query` are mutually exclusive
        repeated .temporal.api.common.v1.WorkflowExecution executions = 5;

      • addExecutions

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

      • addExecutions

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

      • addAllExecutions

        public StartBatchOperationRequest.Builder addAllExecutions​(java.lang.Iterable<? extends WorkflowExecution> values)
         Executions to apply the batch operation
 This field and `visibility_query` are mutually exclusive
        repeated .temporal.api.common.v1.WorkflowExecution executions = 5;

      • clearExecutions

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

      • removeExecutions

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

      • getExecutionsBuilder

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

      • addExecutionsBuilder

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

      • addExecutionsBuilder

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

      • getExecutionsBuilderList

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

      • getMaxOperationsPerSecond

        public 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;
        Specified by:
        getMaxOperationsPerSecond in interface StartBatchOperationRequestOrBuilder
        Returns:
        The maxOperationsPerSecond.

      • setMaxOperationsPerSecond

        public StartBatchOperationRequest.Builder setMaxOperationsPerSecond​(float value)
         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;
        Parameters:
        value - The maxOperationsPerSecond to set.
        Returns:
        This builder for chaining.

      • clearMaxOperationsPerSecond

        public StartBatchOperationRequest.Builder clearMaxOperationsPerSecond()
         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:
        This builder for chaining.

      • hasTerminationOperation

        public boolean hasTerminationOperation()
        .temporal.api.batch.v1.BatchOperationTermination termination_operation = 10;
        Specified by:
        hasTerminationOperation in interface StartBatchOperationRequestOrBuilder
        Returns:
        Whether the terminationOperation field is set.

      • clearTerminationOperation

        public StartBatchOperationRequest.Builder clearTerminationOperation()
        .temporal.api.batch.v1.BatchOperationTermination termination_operation = 10;

      • getTerminationOperationBuilder

        public BatchOperationTermination.Builder getTerminationOperationBuilder()
        .temporal.api.batch.v1.BatchOperationTermination termination_operation = 10;

      • getSignalOperationBuilder

        public BatchOperationSignal.Builder getSignalOperationBuilder()
        .temporal.api.batch.v1.BatchOperationSignal signal_operation = 11;

      • hasCancellationOperation

        public boolean hasCancellationOperation()
        .temporal.api.batch.v1.BatchOperationCancellation cancellation_operation = 12;
        Specified by:
        hasCancellationOperation in interface StartBatchOperationRequestOrBuilder
        Returns:
        Whether the cancellationOperation field is set.

      • clearCancellationOperation

        public StartBatchOperationRequest.Builder clearCancellationOperation()
        .temporal.api.batch.v1.BatchOperationCancellation cancellation_operation = 12;

      • getCancellationOperationBuilder

        public BatchOperationCancellation.Builder getCancellationOperationBuilder()
        .temporal.api.batch.v1.BatchOperationCancellation cancellation_operation = 12;

      • getDeletionOperationBuilder

        public BatchOperationDeletion.Builder getDeletionOperationBuilder()
        .temporal.api.batch.v1.BatchOperationDeletion deletion_operation = 13;

      • getResetOperationBuilder

        public BatchOperationReset.Builder getResetOperationBuilder()
        .temporal.api.batch.v1.BatchOperationReset reset_operation = 14;

      • setUnknownFields

        public final StartBatchOperationRequest.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<StartBatchOperationRequest.Builder>

      • mergeUnknownFields

        public final StartBatchOperationRequest.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<StartBatchOperationRequest.Builder>