Package io.zeebe.gateway.protocol

Class GatewayOuterClass.ActivateJobsRequest.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<GatewayOuterClass.ActivateJobsRequest.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<GatewayOuterClass.ActivateJobsRequest.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • isInitialized

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

      • getTypeBytes

        public com.google.protobuf.ByteString getTypeBytes()
         the job type, as defined in the BPMN process (e.g. <zeebe:taskDefinition
 type="payment-service" />)
        string type = 1;
        Specified by:
        getTypeBytes in interface GatewayOuterClass.ActivateJobsRequestOrBuilder
        Returns:
        The bytes for type.

      • setType

        public GatewayOuterClass.ActivateJobsRequest.Builder setType​(String value)
         the job type, as defined in the BPMN process (e.g. <zeebe:taskDefinition
 type="payment-service" />)
        string type = 1;
        Parameters:
        value - The type to set.
        Returns:
        This builder for chaining.

      • clearType

        public GatewayOuterClass.ActivateJobsRequest.Builder clearType()
         the job type, as defined in the BPMN process (e.g. <zeebe:taskDefinition
 type="payment-service" />)
        string type = 1;
        Returns:
        This builder for chaining.

      • setTypeBytes

        public GatewayOuterClass.ActivateJobsRequest.Builder setTypeBytes​(com.google.protobuf.ByteString value)
         the job type, as defined in the BPMN process (e.g. <zeebe:taskDefinition
 type="payment-service" />)
        string type = 1;
        Parameters:
        value - The bytes for type to set.
        Returns:
        This builder for chaining.

      • setWorker

        public GatewayOuterClass.ActivateJobsRequest.Builder setWorker​(String value)
         the name of the worker activating the jobs, mostly used for logging purposes
        string worker = 2;
        Parameters:
        value - The worker to set.
        Returns:
        This builder for chaining.

      • setWorkerBytes

        public GatewayOuterClass.ActivateJobsRequest.Builder setWorkerBytes​(com.google.protobuf.ByteString value)
         the name of the worker activating the jobs, mostly used for logging purposes
        string worker = 2;
        Parameters:
        value - The bytes for worker to set.
        Returns:
        This builder for chaining.

      • setTimeout

        public GatewayOuterClass.ActivateJobsRequest.Builder setTimeout​(long value)
         a job returned after this call will not be activated by another call until the
 timeout (in ms) has been reached
        int64 timeout = 3;
        Parameters:
        value - The timeout to set.
        Returns:
        This builder for chaining.

      • clearTimeout

        public GatewayOuterClass.ActivateJobsRequest.Builder clearTimeout()
         a job returned after this call will not be activated by another call until the
 timeout (in ms) has been reached
        int64 timeout = 3;
        Returns:
        This builder for chaining.

      • setMaxJobsToActivate

        public GatewayOuterClass.ActivateJobsRequest.Builder setMaxJobsToActivate​(int value)
         the maximum jobs to activate by this request
        int32 maxJobsToActivate = 4;
        Parameters:
        value - The maxJobsToActivate to set.
        Returns:
        This builder for chaining.

      • getFetchVariableList

        public com.google.protobuf.ProtocolStringList getFetchVariableList()
         a list of variables to fetch as the job variables; if empty, all visible variables at
 the time of activation for the scope of the job will be returned
        repeated string fetchVariable = 5;
        Specified by:
        getFetchVariableList in interface GatewayOuterClass.ActivateJobsRequestOrBuilder
        Returns:
        A list containing the fetchVariable.

      • getFetchVariableCount

        public int getFetchVariableCount()
         a list of variables to fetch as the job variables; if empty, all visible variables at
 the time of activation for the scope of the job will be returned
        repeated string fetchVariable = 5;
        Specified by:
        getFetchVariableCount in interface GatewayOuterClass.ActivateJobsRequestOrBuilder
        Returns:
        The count of fetchVariable.

      • getFetchVariable

        public String getFetchVariable​(int index)
         a list of variables to fetch as the job variables; if empty, all visible variables at
 the time of activation for the scope of the job will be returned
        repeated string fetchVariable = 5;
        Specified by:
        getFetchVariable in interface GatewayOuterClass.ActivateJobsRequestOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The fetchVariable at the given index.

      • getFetchVariableBytes

        public com.google.protobuf.ByteString getFetchVariableBytes​(int index)
         a list of variables to fetch as the job variables; if empty, all visible variables at
 the time of activation for the scope of the job will be returned
        repeated string fetchVariable = 5;
        Specified by:
        getFetchVariableBytes in interface GatewayOuterClass.ActivateJobsRequestOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the fetchVariable at the given index.

      • setFetchVariable

        public GatewayOuterClass.ActivateJobsRequest.Builder setFetchVariable​(int index,
                                                                      String value)
         a list of variables to fetch as the job variables; if empty, all visible variables at
 the time of activation for the scope of the job will be returned
        repeated string fetchVariable = 5;
        Parameters:
        index - The index to set the value at.
        value - The fetchVariable to set.
        Returns:
        This builder for chaining.

      • addFetchVariable

        public GatewayOuterClass.ActivateJobsRequest.Builder addFetchVariable​(String value)
         a list of variables to fetch as the job variables; if empty, all visible variables at
 the time of activation for the scope of the job will be returned
        repeated string fetchVariable = 5;
        Parameters:
        value - The fetchVariable to add.
        Returns:
        This builder for chaining.

      • addAllFetchVariable

        public GatewayOuterClass.ActivateJobsRequest.Builder addAllFetchVariable​(Iterable<String> values)
         a list of variables to fetch as the job variables; if empty, all visible variables at
 the time of activation for the scope of the job will be returned
        repeated string fetchVariable = 5;
        Parameters:
        values - The fetchVariable to add.
        Returns:
        This builder for chaining.

      • clearFetchVariable

        public GatewayOuterClass.ActivateJobsRequest.Builder clearFetchVariable()
         a list of variables to fetch as the job variables; if empty, all visible variables at
 the time of activation for the scope of the job will be returned
        repeated string fetchVariable = 5;
        Returns:
        This builder for chaining.

      • addFetchVariableBytes

        public GatewayOuterClass.ActivateJobsRequest.Builder addFetchVariableBytes​(com.google.protobuf.ByteString value)
         a list of variables to fetch as the job variables; if empty, all visible variables at
 the time of activation for the scope of the job will be returned
        repeated string fetchVariable = 5;
        Parameters:
        value - The bytes of the fetchVariable to add.
        Returns:
        This builder for chaining.

      • getRequestTimeout

        public long getRequestTimeout()
         The request will be completed when at least one job is activated or after the requestTimeout (in ms).
 if the requestTimeout = 0, a default timeout is used.
 if the requestTimeout < 0, long polling is disabled and the request is completed immediately, even when no job is activated.
        int64 requestTimeout = 6;
        Specified by:
        getRequestTimeout in interface GatewayOuterClass.ActivateJobsRequestOrBuilder
        Returns:
        The requestTimeout.

      • setRequestTimeout

        public GatewayOuterClass.ActivateJobsRequest.Builder setRequestTimeout​(long value)
         The request will be completed when at least one job is activated or after the requestTimeout (in ms).
 if the requestTimeout = 0, a default timeout is used.
 if the requestTimeout < 0, long polling is disabled and the request is completed immediately, even when no job is activated.
        int64 requestTimeout = 6;
        Parameters:
        value - The requestTimeout to set.
        Returns:
        This builder for chaining.

      • clearRequestTimeout

        public GatewayOuterClass.ActivateJobsRequest.Builder clearRequestTimeout()
         The request will be completed when at least one job is activated or after the requestTimeout (in ms).
 if the requestTimeout = 0, a default timeout is used.
 if the requestTimeout < 0, long polling is disabled and the request is completed immediately, even when no job is activated.
        int64 requestTimeout = 6;
        Returns:
        This builder for chaining.