Package io.zeebe.gateway.protocol

Class GatewayOuterClass.SetVariablesRequest.Builder

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<GatewayOuterClass.SetVariablesRequest.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<GatewayOuterClass.SetVariablesRequest.Builder>

      • getDefaultInstanceForType

        public GatewayOuterClass.SetVariablesRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public GatewayOuterClass.SetVariablesRequest build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public GatewayOuterClass.SetVariablesRequest buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<GatewayOuterClass.SetVariablesRequest.Builder>

      • getElementInstanceKey

        public long getElementInstanceKey()
         the unique identifier of a particular element; can be the workflow 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;
        Specified by:
        getElementInstanceKey in interface GatewayOuterClass.SetVariablesRequestOrBuilder
        Returns:
        The elementInstanceKey.

      • setElementInstanceKey

        public GatewayOuterClass.SetVariablesRequest.Builder setElementInstanceKey​(long value)
         the unique identifier of a particular element; can be the workflow 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;
        Parameters:
        value - The elementInstanceKey to set.
        Returns:
        This builder for chaining.

      • clearElementInstanceKey

        public GatewayOuterClass.SetVariablesRequest.Builder clearElementInstanceKey()
         the unique identifier of a particular element; can be the workflow 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:
        This builder for chaining.

      • getVariablesBytes

        public 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;
        Specified by:
        getVariablesBytes in interface GatewayOuterClass.SetVariablesRequestOrBuilder
        Returns:
        The bytes for variables.

      • setVariables

        public GatewayOuterClass.SetVariablesRequest.Builder setVariables​(String value)
         a JSON serialized document describing variables as key value pairs; the root of the document
 must be an object
        string variables = 2;
        Parameters:
        value - The variables to set.
        Returns:
        This builder for chaining.

      • clearVariables

        public GatewayOuterClass.SetVariablesRequest.Builder clearVariables()
         a JSON serialized document describing variables as key value pairs; the root of the document
 must be an object
        string variables = 2;
        Returns:
        This builder for chaining.

      • setVariablesBytes

        public GatewayOuterClass.SetVariablesRequest.Builder setVariablesBytes​(com.google.protobuf.ByteString value)
         a JSON serialized document describing variables as key value pairs; the root of the document
 must be an object
        string variables = 2;
        Parameters:
        value - The bytes for variables to set.
        Returns:
        This builder for chaining.

      • getLocal

        public 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;
        Specified by:
        getLocal in interface GatewayOuterClass.SetVariablesRequestOrBuilder
        Returns:
        The local.

      • setLocal

        public GatewayOuterClass.SetVariablesRequest.Builder setLocal​(boolean value)
         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;
        Parameters:
        value - The local to set.
        Returns:
        This builder for chaining.

      • clearLocal

        public GatewayOuterClass.SetVariablesRequest.Builder clearLocal()
         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:
        This builder for chaining.