Package io.camunda.zeebe.gateway.protocol

Interface GatewayOuterClass.CreateProcessInstanceRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
GatewayOuterClass.CreateProcessInstanceRequest, GatewayOuterClass.CreateProcessInstanceRequest.Builder
Enclosing class:
GatewayOuterClass
public static interface GatewayOuterClass.CreateProcessInstanceRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getProcessDefinitionKey

      long getProcessDefinitionKey()
       the unique key identifying the process definition (e.g. returned from a process
 in the DeployProcessResponse message)
      int64 processDefinitionKey = 1;
      Returns:
      The processDefinitionKey.

    • getBpmnProcessId

      String getBpmnProcessId()
       the BPMN process ID of the process definition
      string bpmnProcessId = 2;
      Returns:
      The bpmnProcessId.

    • getBpmnProcessIdBytes

      com.google.protobuf.ByteString getBpmnProcessIdBytes()
       the BPMN process ID of the process definition
      string bpmnProcessId = 2;
      Returns:
      The bytes for bpmnProcessId.

    • getVersion

      int getVersion()
       the version of the process; set to -1 to use the latest version
      int32 version = 3;
      Returns:
      The version.

    • getVariables

      String getVariables()
       JSON document that will instantiate the variables for the root variable scope of the
 process instance; it must be a JSON object, as variables will be mapped in a
 key-value fashion. e.g. { "a": 1, "b": 2 } will create two variables, named "a" and
 "b" respectively, with their associated values. [{ "a": 1, "b": 2 }] would not be a
 valid argument, as the root of the JSON document is an array and not an object.
      string variables = 4;
      Returns:
      The variables.

    • getVariablesBytes

      com.google.protobuf.ByteString getVariablesBytes()
       JSON document that will instantiate the variables for the root variable scope of the
 process instance; it must be a JSON object, as variables will be mapped in a
 key-value fashion. e.g. { "a": 1, "b": 2 } will create two variables, named "a" and
 "b" respectively, with their associated values. [{ "a": 1, "b": 2 }] would not be a
 valid argument, as the root of the JSON document is an array and not an object.
      string variables = 4;
      Returns:
      The bytes for variables.

    • getStartInstructionsList

      List<GatewayOuterClass.ProcessInstanceCreationStartInstruction> getStartInstructionsList()
       List of start instructions. If empty (default) the process instance
 will start at the start event. If non-empty the process instance will apply start
 instructions after it has been created
      repeated .gateway_protocol.ProcessInstanceCreationStartInstruction startInstructions = 5;

    • getStartInstructions

      GatewayOuterClass.ProcessInstanceCreationStartInstruction getStartInstructions(int index)
       List of start instructions. If empty (default) the process instance
 will start at the start event. If non-empty the process instance will apply start
 instructions after it has been created
      repeated .gateway_protocol.ProcessInstanceCreationStartInstruction startInstructions = 5;

    • getStartInstructionsCount

      int getStartInstructionsCount()
       List of start instructions. If empty (default) the process instance
 will start at the start event. If non-empty the process instance will apply start
 instructions after it has been created
      repeated .gateway_protocol.ProcessInstanceCreationStartInstruction startInstructions = 5;

    • getStartInstructionsOrBuilderList

      List<? extends GatewayOuterClass.ProcessInstanceCreationStartInstructionOrBuilder> getStartInstructionsOrBuilderList()
       List of start instructions. If empty (default) the process instance
 will start at the start event. If non-empty the process instance will apply start
 instructions after it has been created
      repeated .gateway_protocol.ProcessInstanceCreationStartInstruction startInstructions = 5;

    • getStartInstructionsOrBuilder

      GatewayOuterClass.ProcessInstanceCreationStartInstructionOrBuilder getStartInstructionsOrBuilder(int index)
       List of start instructions. If empty (default) the process instance
 will start at the start event. If non-empty the process instance will apply start
 instructions after it has been created
      repeated .gateway_protocol.ProcessInstanceCreationStartInstruction startInstructions = 5;

    • getTenantId

      String getTenantId()
       the tenant id of the process definition
      string tenantId = 6;
      Returns:
      The tenantId.

    • getTenantIdBytes

      com.google.protobuf.ByteString getTenantIdBytes()
       the tenant id of the process definition
      string tenantId = 6;
      Returns:
      The bytes for tenantId.