Class GatewayOuterClass.ActivateJobsRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.camunda.zeebe.gateway.protocol.GatewayOuterClass.ActivateJobsRequest
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, GatewayOuterClass.ActivateJobsRequestOrBuilder, Serializable
Enclosing class:
GatewayOuterClass

public static final class GatewayOuterClass.ActivateJobsRequest extends com.google.protobuf.GeneratedMessageV3 implements GatewayOuterClass.ActivateJobsRequestOrBuilder
Protobuf type gateway_protocol.ActivateJobsRequest
See Also:
  • Field Details

    • TYPE_FIELD_NUMBER

      public static final int TYPE_FIELD_NUMBER
      See Also:
    • WORKER_FIELD_NUMBER

      public static final int WORKER_FIELD_NUMBER
      See Also:
    • TIMEOUT_FIELD_NUMBER

      public static final int TIMEOUT_FIELD_NUMBER
      See Also:
    • MAXJOBSTOACTIVATE_FIELD_NUMBER

      public static final int MAXJOBSTOACTIVATE_FIELD_NUMBER
      See Also:
    • FETCHVARIABLE_FIELD_NUMBER

      public static final int FETCHVARIABLE_FIELD_NUMBER
      See Also:
    • REQUESTTIMEOUT_FIELD_NUMBER

      public static final int REQUESTTIMEOUT_FIELD_NUMBER
      See Also:
    • TENANTIDS_FIELD_NUMBER

      public static final int TENANTIDS_FIELD_NUMBER
      See Also:
  • Method Details

    • newInstance

      protected 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
    • getType

      public String getType()
       the job type, as defined in the BPMN process (e.g. <zeebe:taskDefinition
       type="payment-service" />)
       
      string type = 1;
      Specified by:
      getType in interface GatewayOuterClass.ActivateJobsRequestOrBuilder
      Returns:
      The type.
    • 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.
    • getWorker

      public String getWorker()
       the name of the worker activating the jobs, mostly used for logging purposes
       
      string worker = 2;
      Specified by:
      getWorker in interface GatewayOuterClass.ActivateJobsRequestOrBuilder
      Returns:
      The worker.
    • getWorkerBytes

      public com.google.protobuf.ByteString getWorkerBytes()
       the name of the worker activating the jobs, mostly used for logging purposes
       
      string worker = 2;
      Specified by:
      getWorkerBytes in interface GatewayOuterClass.ActivateJobsRequestOrBuilder
      Returns:
      The bytes for worker.
    • getTimeout

      public 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;
      Specified by:
      getTimeout in interface GatewayOuterClass.ActivateJobsRequestOrBuilder
      Returns:
      The timeout.
    • getMaxJobsToActivate

      public int getMaxJobsToActivate()
       the maximum jobs to activate by this request
       
      int32 maxJobsToActivate = 4;
      Specified by:
      getMaxJobsToActivate in interface GatewayOuterClass.ActivateJobsRequestOrBuilder
      Returns:
      The maxJobsToActivate.
    • 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.
    • 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.
    • getTenantIdsList

      public com.google.protobuf.ProtocolStringList getTenantIdsList()
       a list of IDs of tenants for which to activate jobs
       
      repeated string tenantIds = 7;
      Specified by:
      getTenantIdsList in interface GatewayOuterClass.ActivateJobsRequestOrBuilder
      Returns:
      A list containing the tenantIds.
    • getTenantIdsCount

      public int getTenantIdsCount()
       a list of IDs of tenants for which to activate jobs
       
      repeated string tenantIds = 7;
      Specified by:
      getTenantIdsCount in interface GatewayOuterClass.ActivateJobsRequestOrBuilder
      Returns:
      The count of tenantIds.
    • getTenantIds

      public String getTenantIds(int index)
       a list of IDs of tenants for which to activate jobs
       
      repeated string tenantIds = 7;
      Specified by:
      getTenantIds in interface GatewayOuterClass.ActivateJobsRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The tenantIds at the given index.
    • getTenantIdsBytes

      public com.google.protobuf.ByteString getTenantIdsBytes(int index)
       a list of IDs of tenants for which to activate jobs
       
      repeated string tenantIds = 7;
      Specified by:
      getTenantIdsBytes in interface GatewayOuterClass.ActivateJobsRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the tenantIds at the given index.
    • 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 IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      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(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 GatewayOuterClass.ActivateJobsRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static GatewayOuterClass.ActivateJobsRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static GatewayOuterClass.ActivateJobsRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static GatewayOuterClass.ActivateJobsRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static GatewayOuterClass.ActivateJobsRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

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

      public static GatewayOuterClass.ActivateJobsRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static GatewayOuterClass.ActivateJobsRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static GatewayOuterClass.ActivateJobsRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static GatewayOuterClass.ActivateJobsRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static GatewayOuterClass.ActivateJobsRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static GatewayOuterClass.ActivateJobsRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • newBuilderForType

      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite
    • newBuilder

    • newBuilder

    • toBuilder

      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected GatewayOuterClass.ActivateJobsRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3
    • getDefaultInstance

      public static GatewayOuterClass.ActivateJobsRequest getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<GatewayOuterClass.ActivateJobsRequest> parser()
    • getParserForType

      public com.google.protobuf.Parser<GatewayOuterClass.ActivateJobsRequest> 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 GatewayOuterClass.ActivateJobsRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder