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 Summary

    Modifier and Type
    Method
    Description
    String
    getBpmnProcessId()
    the BPMN process ID of the process definition
    com.google.protobuf.ByteString
    getBpmnProcessIdBytes()
    the BPMN process ID of the process definition
    long
    getProcessDefinitionKey()
    the unique key identifying the process definition (e.g.
    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.
    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.
    int
    getVersion()
    the version of the process; set to -1 to use the latest version

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