Package io.camunda.zeebe.gateway.protocol

Interface GatewayOuterClass.ModifyProcessInstanceRequest.VariableInstructionOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getScopeId()
    the id of the element in which scope the variables should be created; leave empty to create the variables in the global scope of the process instance
    com.google.protobuf.ByteString
    getScopeIdBytes()
    the id of the element in which scope the variables should be created; leave empty to create the variables in the global scope of the process instance
    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.
    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.

    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

    • 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 = 1;
      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 = 1;
      Returns:
      The bytes for variables.

    • getScopeId

      String getScopeId()
       the id of the element in which scope the variables should be created;
 leave empty to create the variables in the global scope of the process instance
      string scopeId = 2;
      Returns:
      The scopeId.

    • getScopeIdBytes

      com.google.protobuf.ByteString getScopeIdBytes()
       the id of the element in which scope the variables should be created;
 leave empty to create the variables in the global scope of the process instance
      string scopeId = 2;
      Returns:
      The bytes for scopeId.