Package io.zeebe.gateway.protocol

Interface GatewayOuterClass.CreateWorkflowInstanceRequestOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getBpmnProcessId()
      the BPMN process ID of the workflow definition
      com.google.protobuf.ByteString getBpmnProcessIdBytes()
      the BPMN process ID of the workflow definition
      String getVariables()
      JSON document that will instantiate the variables for the root variable scope of the workflow 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 workflow 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
      long getWorkflowKey()
      the unique key identifying the workflow definition (e.g.

      • 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

      • getWorkflowKey

        long getWorkflowKey()
         the unique key identifying the workflow definition (e.g. returned from a workflow
 in the DeployWorkflowResponse message)
        int64 workflowKey = 1;
        Returns:
        The workflowKey.

      • getBpmnProcessId

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

      • getBpmnProcessIdBytes

        com.google.protobuf.ByteString getBpmnProcessIdBytes()
         the BPMN process ID of the workflow 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
 workflow 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
 workflow 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.