feat: added support for handlers

Google APIs · copybara-github · commit 8ed13a08afe4 · 2025-02-25T18:45:39.000-08:00
PiperOrigin-RevId: 731109606
diff --git a/google/cloud/dialogflow/cx/v3beta1/playbook.proto b/google/cloud/dialogflow/cx/v3beta1/playbook.proto
@@ -22,6 +22,7 @@ import "google/api/field_behavior.proto";
 import "google/api/resource.proto";
 import "google/cloud/dialogflow/cx/v3beta1/advanced_settings.proto";
 import "google/cloud/dialogflow/cx/v3beta1/example.proto";
+import "google/cloud/dialogflow/cx/v3beta1/fulfillment.proto";
 import "google/cloud/dialogflow/cx/v3beta1/generative_settings.proto";
 import "google/cloud/dialogflow/cx/v3beta1/parameter_definition.proto";
 import "google/protobuf/empty.proto";
@@ -314,6 +315,10 @@ message Playbook {
   // Optional. Playbook level Settings for speech to text detection.
   AdvancedSettings.SpeechSettings speech_settings = 20
       [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. A list of registered handlers to execute based on the specified
+  // triggers.
+  repeated Handler handlers = 16 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // The request message for
@@ -422,3 +427,47 @@ message DeletePlaybookVersionRequest {
     }
   ];
 }
+
+// Handler can be used to define custom logic to be executed based on the
+// user-specified triggers.
+message Handler {
+  // A handler that is triggered by the specified
+  // [event][google.cloud.dialogflow.cx.v3beta1.Handler.EventHandler.event].
+  message EventHandler {
+    // Required. The name of the event that triggers this handler.
+    string event = 1 [(google.api.field_behavior) = REQUIRED];
+
+    // Optional. The condition that must be satisfied to trigger this handler.
+    string condition = 3 [(google.api.field_behavior) = OPTIONAL];
+
+    // Required. The fulfillment to call when the event occurs.
+    Fulfillment fulfillment = 2 [(google.api.field_behavior) = REQUIRED];
+  }
+
+  // A handler that is triggered on the specific
+  // [lifecycle_stage][google.cloud.dialogflow.cx.v3beta1.Handler.LifecycleHandler.lifecycle_stage]
+  // of the playbook execution.
+  message LifecycleHandler {
+    // Required. The name of the lifecycle stage that triggers this handler.
+    // Supported values:
+    // * `playbook-start`
+    // * `pre-action-selection`
+    // * `pre-action-execution`
+    string lifecycle_stage = 1 [(google.api.field_behavior) = REQUIRED];
+
+    // Optional. The condition that must be satisfied to trigger this handler.
+    string condition = 2 [(google.api.field_behavior) = OPTIONAL];
+
+    // Required. The fulfillment to call when this handler is triggered.
+    Fulfillment fulfillment = 3 [(google.api.field_behavior) = REQUIRED];
+  }
+
+  // Specifies the type of handler to invoke.
+  oneof handler {
+    // A handler triggered by event.
+    EventHandler event_handler = 1;
+
+    // A handler triggered during specific lifecycle of the playbook execution.
+    LifecycleHandler lifecycle_handler = 3;
+  }
+}
