Package io.camunda.zeebe.gateway.protocol

Interface GatewayOuterClass.SetVariablesRequestOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    getElementInstanceKey()
    the unique identifier of a particular element; can be the process instance key (as obtained during instance creation), or a given element, such as a service task (see elementInstanceKey on the job message)
    boolean
    getLocal()
    if true, the variables will be merged strictly into the local scope (as indicated by elementInstanceKey); this means the variables is not propagated to upper scopes.
    long
    getOperationReference()
    a reference key chosen by the user and will be part of all records resulted from this operation
    String
    getVariables()
    a JSON serialized document describing variables as key value pairs; the root of the document must be an object
    com.google.protobuf.ByteString
    getVariablesBytes()
    a JSON serialized document describing variables as key value pairs; the root of the document must be an object
    boolean
    hasOperationReference()
    a reference key chosen by the user and will be part of all records resulted from this operation

    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

    • getElementInstanceKey

      long getElementInstanceKey()
       the unique identifier of a particular element; can be the process instance key (as
 obtained during instance creation), or a given element, such as a service task (see
 elementInstanceKey on the job message)
      int64 elementInstanceKey = 1;
      Returns:
      The elementInstanceKey.

    • getVariables

      String getVariables()
       a JSON serialized document describing variables as key value pairs; the root of the document
 must be an object
      string variables = 2;
      Returns:
      The variables.

    • getVariablesBytes

      com.google.protobuf.ByteString getVariablesBytes()
       a JSON serialized document describing variables as key value pairs; the root of the document
 must be an object
      string variables = 2;
      Returns:
      The bytes for variables.

    • getLocal

      boolean getLocal()
       if true, the variables will be merged strictly into the local scope (as indicated by
 elementInstanceKey); this means the variables is not propagated to upper scopes.
 for example, let's say we have two scopes, '1' and '2', with each having effective variables as:
 1 => `{ "foo" : 2 }`, and 2 => `{ "bar" : 1 }`. if we send an update request with
 elementInstanceKey = 2, variables `{ "foo" : 5 }`, and local is true, then scope 1 will
 be unchanged, and scope 2 will now be `{ "bar" : 1, "foo" 5 }`. if local was false, however,
 then scope 1 would be `{ "foo": 5 }`, and scope 2 would be `{ "bar" : 1 }`.
      bool local = 3;
      Returns:
      The local.

    • hasOperationReference

      boolean hasOperationReference()
       a reference key chosen by the user and will be part of all records resulted from this operation
      optional uint64 operationReference = 4;
      Returns:
      Whether the operationReference field is set.

    • getOperationReference

      long getOperationReference()
       a reference key chosen by the user and will be part of all records resulted from this operation
      optional uint64 operationReference = 4;
      Returns:
      The operationReference.