Package io.zeebe.gateway.protocol

Interface GatewayOuterClass.FailJobRequestOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      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

      • 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 Detail

      • 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.