Package io.camunda.zeebe.gateway.protocol

Class GatewayOuterClass.ThrowErrorRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<GatewayOuterClass.ThrowErrorRequest.Builder>
com.google.protobuf.GeneratedMessage.Builder<GatewayOuterClass.ThrowErrorRequest.Builder>
io.camunda.zeebe.gateway.protocol.GatewayOuterClass.ThrowErrorRequest.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, GatewayOuterClass.ThrowErrorRequestOrBuilder, Cloneable
Enclosing class:
GatewayOuterClass.ThrowErrorRequest
public static final class GatewayOuterClass.ThrowErrorRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<GatewayOuterClass.ThrowErrorRequest.Builder> implements GatewayOuterClass.ThrowErrorRequestOrBuilder
Protobuf type gateway_protocol.ThrowErrorRequest

  • Method Summary

    Modifier and Type
    Method
    Description
    GatewayOuterClass.ThrowErrorRequest
    build()
     
    GatewayOuterClass.ThrowErrorRequest
    buildPartial()
     
    GatewayOuterClass.ThrowErrorRequest.Builder
    clear()
     
    GatewayOuterClass.ThrowErrorRequest.Builder
    clearErrorCode()
    the error code that will be matched with an error catch event
    GatewayOuterClass.ThrowErrorRequest.Builder
    clearErrorMessage()
    an optional error message that provides additional context
    GatewayOuterClass.ThrowErrorRequest.Builder
    clearJobKey()
    the unique job identifier, as obtained when activating the job
    GatewayOuterClass.ThrowErrorRequest.Builder
    clearVariables()
    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.
    GatewayOuterClass.ThrowErrorRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    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. 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 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.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    GatewayOuterClass.ThrowErrorRequest.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    GatewayOuterClass.ThrowErrorRequest.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    GatewayOuterClass.ThrowErrorRequest.Builder
    mergeFrom(GatewayOuterClass.ThrowErrorRequest other)
     
    GatewayOuterClass.ThrowErrorRequest.Builder
    setErrorCode(String value)
    the error code that will be matched with an error catch event
    GatewayOuterClass.ThrowErrorRequest.Builder
    setErrorCodeBytes(com.google.protobuf.ByteString value)
    the error code that will be matched with an error catch event
    GatewayOuterClass.ThrowErrorRequest.Builder
    setErrorMessage(String value)
    an optional error message that provides additional context
    GatewayOuterClass.ThrowErrorRequest.Builder
    setErrorMessageBytes(com.google.protobuf.ByteString value)
    an optional error message that provides additional context
    GatewayOuterClass.ThrowErrorRequest.Builder
    setJobKey(long value)
    the unique job identifier, as obtained when activating the job
    GatewayOuterClass.ThrowErrorRequest.Builder
    setVariables(String value)
    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.
    GatewayOuterClass.ThrowErrorRequest.Builder
    setVariablesBytes(com.google.protobuf.ByteString value)
    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.

    Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

    addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

    Methods inherited from class com.google.protobuf.AbstractMessage.Builder

    findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

    Methods inherited from interface com.google.protobuf.MessageLite.Builder

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • clear

      public GatewayOuterClass.ThrowErrorRequest.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<GatewayOuterClass.ThrowErrorRequest.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.GeneratedMessage.Builder<GatewayOuterClass.ThrowErrorRequest.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public GatewayOuterClass.ThrowErrorRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GatewayOuterClass.ThrowErrorRequest.Builder>

    • mergeFrom

      public GatewayOuterClass.ThrowErrorRequest.Builder mergeFrom(GatewayOuterClass.ThrowErrorRequest other)

    • isInitialized

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

    • mergeFrom

      public GatewayOuterClass.ThrowErrorRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GatewayOuterClass.ThrowErrorRequest.Builder>
      Throws:
      IOException

    • getJobKey

      public long getJobKey()
       the unique job identifier, as obtained when activating the job
      int64 jobKey = 1;
      Specified by:
      getJobKey in interface GatewayOuterClass.ThrowErrorRequestOrBuilder
      Returns:
      The jobKey.

    • setJobKey

      public GatewayOuterClass.ThrowErrorRequest.Builder setJobKey(long value)
       the unique job identifier, as obtained when activating the job
      int64 jobKey = 1;
      Parameters:
      value - The jobKey to set.
      Returns:
      This builder for chaining.

    • clearJobKey

      public GatewayOuterClass.ThrowErrorRequest.Builder clearJobKey()
       the unique job identifier, as obtained when activating the job
      int64 jobKey = 1;
      Returns:
      This builder for chaining.

    • getErrorCode

      public String getErrorCode()
       the error code that will be matched with an error catch event
      string errorCode = 2;
      Specified by:
      getErrorCode in interface GatewayOuterClass.ThrowErrorRequestOrBuilder
      Returns:
      The errorCode.

    • getErrorCodeBytes

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

    • setErrorCode

      public GatewayOuterClass.ThrowErrorRequest.Builder setErrorCode(String value)
       the error code that will be matched with an error catch event
      string errorCode = 2;
      Parameters:
      value - The errorCode to set.
      Returns:
      This builder for chaining.

    • clearErrorCode

      public GatewayOuterClass.ThrowErrorRequest.Builder clearErrorCode()
       the error code that will be matched with an error catch event
      string errorCode = 2;
      Returns:
      This builder for chaining.

    • setErrorCodeBytes

      public GatewayOuterClass.ThrowErrorRequest.Builder setErrorCodeBytes(com.google.protobuf.ByteString value)
       the error code that will be matched with an error catch event
      string errorCode = 2;
      Parameters:
      value - The bytes for errorCode to set.
      Returns:
      This builder for chaining.

    • getErrorMessage

      public String getErrorMessage()
       an optional error message that provides additional context
      string errorMessage = 3;
      Specified by:
      getErrorMessage in interface GatewayOuterClass.ThrowErrorRequestOrBuilder
      Returns:
      The errorMessage.

    • getErrorMessageBytes

      public com.google.protobuf.ByteString getErrorMessageBytes()
       an optional error message that provides additional context
      string errorMessage = 3;
      Specified by:
      getErrorMessageBytes in interface GatewayOuterClass.ThrowErrorRequestOrBuilder
      Returns:
      The bytes for errorMessage.

    • setErrorMessage

      public GatewayOuterClass.ThrowErrorRequest.Builder setErrorMessage(String value)
       an optional error message that provides additional context
      string errorMessage = 3;
      Parameters:
      value - The errorMessage to set.
      Returns:
      This builder for chaining.

    • clearErrorMessage

      public GatewayOuterClass.ThrowErrorRequest.Builder clearErrorMessage()
       an optional error message that provides additional context
      string errorMessage = 3;
      Returns:
      This builder for chaining.

    • setErrorMessageBytes

      public GatewayOuterClass.ThrowErrorRequest.Builder setErrorMessageBytes(com.google.protobuf.ByteString value)
       an optional error message that provides additional context
      string errorMessage = 3;
      Parameters:
      value - The bytes for errorMessage to set.
      Returns:
      This builder for chaining.

    • getVariables

      public 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;
      Specified by:
      getVariables in interface GatewayOuterClass.ThrowErrorRequestOrBuilder
      Returns:
      The variables.

    • getVariablesBytes

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

    • setVariables

      public GatewayOuterClass.ThrowErrorRequest.Builder setVariables(String value)
       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;
      Parameters:
      value - The variables to set.
      Returns:
      This builder for chaining.

    • clearVariables

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

    • setVariablesBytes

      public GatewayOuterClass.ThrowErrorRequest.Builder setVariablesBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for variables to set.
      Returns:
      This builder for chaining.