proto/flow.proto

syntax = "proto2";

package devtools.gerritcodereview.flow;

option java_package = "com.google.gerrit.server.flow.proto";
option java_multiple_files = true;

message FlowAction {
  // The name of the action.
  optional string name = 1;
  // Parameters for the action.
  repeated string parameters = 2;
}

message FlowExpression {
  // The condition which must be satisfied for the action to be triggered.
  //
  // Can contain multiple obstacles separated by comma.
  optional string condition = 1;
  // The action that should be triggered when the condition is satisfied.
  optional FlowAction action = 2;
}

message FlowStageEvaluationStatus {
  enum State {
    UNKNOWN = 0;
    // The previous stages are not finished yet, the condition of the stage is
    // not satisfied yet or the action has not been executed yet.
    PENDING = 1;
    // The condition of the stage is satisfied and the action has been executed.
    DONE = 2;
    // The stage has a non-recoverable error, e.g. performing the action has
    // failed.
    FAILED = 3;
    // The stage has been terminated without having been executed, e.g. because
    // a previous stage failed or because it wasn't done within a timeout.
    TERMINATED = 4;
  }
  optional State state = 1;
  // Message contains extra information about the stage execution. Such as error
  // details if the stage failed.
  optional string message = 2;
  // The timestamp at which all previous stages completed and evaluation of the
  // current this stage started.
  optional int64 start_time_millis = 3;
  // The timestamp at which the stage became DONE/FAILED/TERMINATED.
  optional int64 end_time_millis = 4;
}