Package io.zeebe.gateway.protocol

Interface GatewayOuterClass.ActivateJobsRequestOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      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
      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
      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
      List<String> 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
      int getMaxJobsToActivate()
      the maximum jobs to activate by this request
      long getRequestTimeout()
      The request will be completed when at least one job is activated or after the requestTimeout (in ms).
      long getTimeout()
      a job returned after this call will not be activated by another call until the timeout (in ms) has been reached
      String getType()
      the job type, as defined in the BPMN process (e.g.
      com.google.protobuf.ByteString getTypeBytes()
      the job type, as defined in the BPMN process (e.g.
      String getWorker()
      the name of the worker activating the jobs, mostly used for logging purposes
      com.google.protobuf.ByteString getWorkerBytes()
      the name of the worker activating the jobs, mostly used for logging purposes

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getType

        String getType()
         the job type, as defined in the BPMN process (e.g. <zeebe:taskDefinition
 type="payment-service" />)
        string type = 1;
        Returns:
        The type.

      • getTypeBytes

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

      • getWorker

        String getWorker()
         the name of the worker activating the jobs, mostly used for logging purposes
        string worker = 2;
        Returns:
        The worker.

      • getWorkerBytes

        com.google.protobuf.ByteString getWorkerBytes()
         the name of the worker activating the jobs, mostly used for logging purposes
        string worker = 2;
        Returns:
        The bytes for worker.

      • getTimeout

        long getTimeout()
         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:
        The timeout.

      • getMaxJobsToActivate

        int getMaxJobsToActivate()
         the maximum jobs to activate by this request
        int32 maxJobsToActivate = 4;
        Returns:
        The maxJobsToActivate.

      • getFetchVariableList

        List<String> 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;
        Returns:
        A list containing the fetchVariable.

      • getFetchVariableCount

        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;
        Returns:
        The count of fetchVariable.

      • getFetchVariable

        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;
        Parameters:
        index - The index of the element to return.
        Returns:
        The fetchVariable at the given index.

      • getFetchVariableBytes

        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;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the fetchVariable at the given index.

      • getRequestTimeout

        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;
        Returns:
        The requestTimeout.