Package io.temporal.api.workflowservice.v1

Class StartBatchOperationRequest

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, StartBatchOperationRequestOrBuilder, java.io.Serializable
    @Generated(value="protoc",
           comments="annotations:StartBatchOperationRequest.java.pb.meta")
public final class StartBatchOperationRequest
extends com.google.protobuf.GeneratedMessageV3
implements StartBatchOperationRequestOrBuilder
    Protobuf type temporal.api.workflowservice.v1.StartBatchOperationRequest
    See Also:
    Serialized Form

    • Field Detail

      • VISIBILITY_QUERY_FIELD_NUMBER

        public static final int VISIBILITY_QUERY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EXECUTIONS_FIELD_NUMBER

        public static final int EXECUTIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MAX_OPERATIONS_PER_SECOND_FIELD_NUMBER

        public static final int MAX_OPERATIONS_PER_SECOND_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TERMINATION_OPERATION_FIELD_NUMBER

        public static final int TERMINATION_OPERATION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SIGNAL_OPERATION_FIELD_NUMBER

        public static final int SIGNAL_OPERATION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CANCELLATION_OPERATION_FIELD_NUMBER

        public static final int CANCELLATION_OPERATION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DELETION_OPERATION_FIELD_NUMBER

        public static final int DELETION_OPERATION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RESET_OPERATION_FIELD_NUMBER

        public static final int RESET_OPERATION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • UPDATE_WORKFLOW_OPTIONS_OPERATION_FIELD_NUMBER

        public static final int UPDATE_WORKFLOW_OPTIONS_OPERATION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • UNPAUSE_ACTIVITIES_OPERATION_FIELD_NUMBER

        public static final int UNPAUSE_ACTIVITIES_OPERATION_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • 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

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

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

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

      • 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

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

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

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

      • hasUpdateWorkflowOptionsOperation

        public boolean hasUpdateWorkflowOptionsOperation()
        .temporal.api.batch.v1.BatchOperationUpdateWorkflowExecutionOptions update_workflow_options_operation = 15;
        Specified by:
        hasUpdateWorkflowOptionsOperation in interface StartBatchOperationRequestOrBuilder
        Returns:
        Whether the updateWorkflowOptionsOperation field is set.

      • hasUnpauseActivitiesOperation

        public boolean hasUnpauseActivitiesOperation()
        .temporal.api.batch.v1.BatchOperationUnpauseActivities unpause_activities_operation = 16;
        Specified by:
        hasUnpauseActivitiesOperation in interface StartBatchOperationRequestOrBuilder
        Returns:
        Whether the unpauseActivitiesOperation field is set.

      • isInitialized

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

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static StartBatchOperationRequest parseFrom​(java.nio.ByteBuffer data)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static StartBatchOperationRequest parseFrom​(java.nio.ByteBuffer data,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static StartBatchOperationRequest parseFrom​(com.google.protobuf.ByteString data)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static StartBatchOperationRequest parseFrom​(com.google.protobuf.ByteString data,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static StartBatchOperationRequest parseFrom​(byte[] data)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static StartBatchOperationRequest parseFrom​(byte[] data,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static StartBatchOperationRequest parseFrom​(java.io.InputStream input)
                                            throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static StartBatchOperationRequest parseFrom​(java.io.InputStream input,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static StartBatchOperationRequest parseDelimitedFrom​(java.io.InputStream input)
                                                     throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static StartBatchOperationRequest parseDelimitedFrom​(java.io.InputStream input,
                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                     throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static StartBatchOperationRequest parseFrom​(com.google.protobuf.CodedInputStream input)
                                            throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static StartBatchOperationRequest parseFrom​(com.google.protobuf.CodedInputStream input,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected StartBatchOperationRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<StartBatchOperationRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

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