Package io.camunda.zeebe.gateway.protocol

Interface GatewayOuterClass.FailJobRequestOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getErrorMessage()
    an optional message describing why the job failed this is particularly useful if a job runs out of retries and an incident is raised, as it this message can help explain why an incident was raised
    com.google.protobuf.ByteString
    getErrorMessageBytes()
    an optional message describing why the job failed this is particularly useful if a job runs out of retries and an incident is raised, as it this message can help explain why an incident was raised
    long
    getJobKey()
    the unique job identifier, as obtained when activating the job
    int
    getRetries()
    the amount of retries the job should have left
    long
    getRetryBackOff()
    the backoff timeout (in ms) for the next retry
    String
    getVariables()
    JSON document that will instantiate the variables at the local scope of the job's associated task; 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 job's associated task; 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.

    • getRetries

      int getRetries()
       the amount of retries the job should have left
      int32 retries = 2;
      Returns:
      The retries.

    • getErrorMessage

      String getErrorMessage()
       an optional message describing why the job failed
 this is particularly useful if a job runs out of retries and an incident is raised,
 as it this message can help explain why an incident was raised
      string errorMessage = 3;
      Returns:
      The errorMessage.

    • getErrorMessageBytes

      com.google.protobuf.ByteString getErrorMessageBytes()
       an optional message describing why the job failed
 this is particularly useful if a job runs out of retries and an incident is raised,
 as it this message can help explain why an incident was raised
      string errorMessage = 3;
      Returns:
      The bytes for errorMessage.

    • getRetryBackOff

      long getRetryBackOff()
       the backoff timeout (in ms) for the next retry
      int64 retryBackOff = 4;
      Returns:
      The retryBackOff.

    • getVariables

      String getVariables()
       JSON document that will instantiate the variables at the local scope of the
 job's associated task; 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 = 5;
      Returns:
      The variables.

    • getVariablesBytes

      com.google.protobuf.ByteString getVariablesBytes()
       JSON document that will instantiate the variables at the local scope of the
 job's associated task; 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 = 5;
      Returns:
      The bytes for variables.