Package io.camunda.zeebe.gateway.protocol

Interface GatewayOuterClass.ThrowErrorRequestOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getErrorCode()
    the error code that will be matched with an error catch event
    com.google.protobuf.ByteString
    getErrorCodeBytes()
    the error code that will be matched with an error catch event
    String
    getErrorMessage()
    an optional error message that provides additional context
    com.google.protobuf.ByteString
    getErrorMessageBytes()
    an optional error message that provides additional context
    long
    getJobKey()
    the unique job identifier, as obtained when activating the job
    String
    getVariables()
    JSON document that will instantiate the variables at the local scope of the error catch event that catches the thrown error; 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 at the local scope of the error catch event that catches the thrown error; it must be a JSON object, as variables will be mapped in a key-value fashion.

    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

    • getJobKey

      long getJobKey()
       the unique job identifier, as obtained when activating the job
      int64 jobKey = 1;
      Returns:
      The jobKey.

    • getErrorCode

      String getErrorCode()
       the error code that will be matched with an error catch event
      string errorCode = 2;
      Returns:
      The errorCode.

    • getErrorCodeBytes

      com.google.protobuf.ByteString getErrorCodeBytes()
       the error code that will be matched with an error catch event
      string errorCode = 2;
      Returns:
      The bytes for errorCode.

    • getErrorMessage

      String getErrorMessage()
       an optional error message that provides additional context
      string errorMessage = 3;
      Returns:
      The errorMessage.

    • getErrorMessageBytes

      com.google.protobuf.ByteString getErrorMessageBytes()
       an optional error message that provides additional context
      string errorMessage = 3;
      Returns:
      The bytes for errorMessage.

    • getVariables

      String getVariables()
       JSON document that will instantiate the variables at the local scope of the
 error catch event that catches the thrown error; 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 at the local scope of the
 error catch event that catches the thrown error; 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.