Package io.camunda.zeebe.gateway.protocol

Interface GatewayOuterClass.JobResultOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    GatewayOuterClass.JobResultCorrections
    getCorrections()
    Attributes that were corrected by the worker.
    GatewayOuterClass.JobResultCorrectionsOrBuilder
    getCorrectionsOrBuilder()
    Attributes that were corrected by the worker.
    boolean
    getDenied()
    Indicates whether the worker denies the work, i.e. explicitly doesn't approve it.
    String
    getDeniedReason()
    The reason provided by the user task listener for denying the work.
    com.google.protobuf.ByteString
    getDeniedReasonBytes()
    The reason provided by the user task listener for denying the work.
    boolean
    hasCorrections()
    Attributes that were corrected by the worker.
    boolean
    hasDenied()
    Indicates whether the worker denies the work, i.e. explicitly doesn't approve it.
    boolean
    hasDeniedReason()
    The reason provided by the user task listener for denying the work.

    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

    • hasDenied

      boolean hasDenied()
       Indicates whether the worker denies the work, i.e. explicitly doesn't approve it.
 For example, a user task listener can deny the completion of a user task by setting this flag to true.
 In this example, the completion of a task is represented by a job that the worker can complete as denied.
 As a result, the completion request is rejected and the task remains active.
 Defaults to false.
      optional bool denied = 1;
      Returns:
      Whether the denied field is set.

    • getDenied

      boolean getDenied()
       Indicates whether the worker denies the work, i.e. explicitly doesn't approve it.
 For example, a user task listener can deny the completion of a user task by setting this flag to true.
 In this example, the completion of a task is represented by a job that the worker can complete as denied.
 As a result, the completion request is rejected and the task remains active.
 Defaults to false.
      optional bool denied = 1;
      Returns:
      The denied.

    • hasCorrections

      boolean hasCorrections()
       Attributes that were corrected by the worker.
 The following attributes can be corrected, additional attributes will be ignored:
 * `assignee` - clear by providing an empty string
 * `dueDate` - clear by providing an empty string
 * `followUpDate` - clear by providing an empty string
 * `candidateGroups` - clear by providing an empty list
 * `candidateUsers` - clear by providing an empty list
 * `priority` - minimum 0, maximum 100, default 50
 Omitting any of the attributes will preserve the persisted attribute's value.
      optional .gateway_protocol.JobResultCorrections corrections = 2;
      Returns:
      Whether the corrections field is set.

    • getCorrections

      GatewayOuterClass.JobResultCorrections getCorrections()
       Attributes that were corrected by the worker.
 The following attributes can be corrected, additional attributes will be ignored:
 * `assignee` - clear by providing an empty string
 * `dueDate` - clear by providing an empty string
 * `followUpDate` - clear by providing an empty string
 * `candidateGroups` - clear by providing an empty list
 * `candidateUsers` - clear by providing an empty list
 * `priority` - minimum 0, maximum 100, default 50
 Omitting any of the attributes will preserve the persisted attribute's value.
      optional .gateway_protocol.JobResultCorrections corrections = 2;
      Returns:
      The corrections.

    • getCorrectionsOrBuilder

      GatewayOuterClass.JobResultCorrectionsOrBuilder getCorrectionsOrBuilder()
       Attributes that were corrected by the worker.
 The following attributes can be corrected, additional attributes will be ignored:
 * `assignee` - clear by providing an empty string
 * `dueDate` - clear by providing an empty string
 * `followUpDate` - clear by providing an empty string
 * `candidateGroups` - clear by providing an empty list
 * `candidateUsers` - clear by providing an empty list
 * `priority` - minimum 0, maximum 100, default 50
 Omitting any of the attributes will preserve the persisted attribute's value.
      optional .gateway_protocol.JobResultCorrections corrections = 2;

    • hasDeniedReason

      boolean hasDeniedReason()
       The reason provided by the user task listener for denying the work.
      optional string deniedReason = 3;
      Returns:
      Whether the deniedReason field is set.

    • getDeniedReason

      String getDeniedReason()
       The reason provided by the user task listener for denying the work.
      optional string deniedReason = 3;
      Returns:
      The deniedReason.

    • getDeniedReasonBytes

      com.google.protobuf.ByteString getDeniedReasonBytes()
       The reason provided by the user task listener for denying the work.
      optional string deniedReason = 3;
      Returns:
      The bytes for deniedReason.