From 442b14cb8904ad59db506586771ad51ac4cfa745 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Fri, 1 Jul 2022 03:34:42 +0000 Subject: [PATCH] docs: improve comments for protos (#503) - [ ] Regenerate this pull request now. PiperOrigin-RevId: 458250124 Source-Link: https://github.com/googleapis/googleapis/commit/913b9bd72a584301d0317feeb39ba53681dea553 Source-Link: https://github.com/googleapis/googleapis-gen/commit/5601594f1cdf45d9df26f245604c333e3ff3838d Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNTYwMTU5NGYxY2RmNDVkOWRmMjZmMjQ1NjA0YzMzM2UzZmYzODM4ZCJ9 --- .../cloud/dialogflow/cx/v3/AdvancedSettings.java | 14 ++++++++++++-- .../cloud/dialogflow/cx/v3/WebhookRequest.java | 4 ++++ .../cloud/dialogflow/cx/v3/advanced_settings.proto | 8 +++++++- .../google/cloud/dialogflow/cx/v3/webhook.proto | 3 +++ 4 files changed, 26 insertions(+), 3 deletions(-) diff --git a/java-dialogflow-cx/proto-google-cloud-dialogflow-cx-v3/src/main/java/com/google/cloud/dialogflow/cx/v3/AdvancedSettings.java b/java-dialogflow-cx/proto-google-cloud-dialogflow-cx-v3/src/main/java/com/google/cloud/dialogflow/cx/v3/AdvancedSettings.java index 0ebe2a2588b6..8aa91ca911f4 100644 --- a/java-dialogflow-cx/proto-google-cloud-dialogflow-cx-v3/src/main/java/com/google/cloud/dialogflow/cx/v3/AdvancedSettings.java +++ b/java-dialogflow-cx/proto-google-cloud-dialogflow-cx-v3/src/main/java/com/google/cloud/dialogflow/cx/v3/AdvancedSettings.java @@ -24,7 +24,12 @@ *
  * Hierarchical advanced settings for agent/flow/page/fulfillment/parameter.
  * Settings exposed at lower level overrides the settings exposed at higher
- * level.
+ * level. Overriding occurs at the sub-setting level. For example, the
+ * playback_interruption_settings at fulfillment level only overrides the
+ * playback_interruption_settings at the agent level, leaving other settings
+ * at the agent level unchanged.
+ * DTMF settings does not override each other. DTMF settings set at different
+ * levels define DTMF detections running in parallel.
  * Hierarchy: Agent->Flow->Page->Fulfillment/Parameter.
  * 
* @@ -1026,7 +1031,12 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build *
    * Hierarchical advanced settings for agent/flow/page/fulfillment/parameter.
    * Settings exposed at lower level overrides the settings exposed at higher
-   * level.
+   * level. Overriding occurs at the sub-setting level. For example, the
+   * playback_interruption_settings at fulfillment level only overrides the
+   * playback_interruption_settings at the agent level, leaving other settings
+   * at the agent level unchanged.
+   * DTMF settings does not override each other. DTMF settings set at different
+   * levels define DTMF detections running in parallel.
    * Hierarchy: Agent->Flow->Page->Fulfillment/Parameter.
    * 
* diff --git a/java-dialogflow-cx/proto-google-cloud-dialogflow-cx-v3/src/main/java/com/google/cloud/dialogflow/cx/v3/WebhookRequest.java b/java-dialogflow-cx/proto-google-cloud-dialogflow-cx-v3/src/main/java/com/google/cloud/dialogflow/cx/v3/WebhookRequest.java index 106548508ba0..5248b95bd9f0 100644 --- a/java-dialogflow-cx/proto-google-cloud-dialogflow-cx-v3/src/main/java/com/google/cloud/dialogflow/cx/v3/WebhookRequest.java +++ b/java-dialogflow-cx/proto-google-cloud-dialogflow-cx-v3/src/main/java/com/google/cloud/dialogflow/cx/v3/WebhookRequest.java @@ -24,6 +24,8 @@ *
  * The request message for a webhook call. The request is sent as a JSON object
  * and the field names will be presented in camel cases.
+ * You may see undocumented fields in an actual request. These fields are used
+ * internally by Dialogflow and should be ignored.
  * 
* * Protobuf type {@code google.cloud.dialogflow.cx.v3.WebhookRequest} @@ -5409,6 +5411,8 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build *
    * The request message for a webhook call. The request is sent as a JSON object
    * and the field names will be presented in camel cases.
+   * You may see undocumented fields in an actual request. These fields are used
+   * internally by Dialogflow and should be ignored.
    * 
* * Protobuf type {@code google.cloud.dialogflow.cx.v3.WebhookRequest} diff --git a/java-dialogflow-cx/proto-google-cloud-dialogflow-cx-v3/src/main/proto/google/cloud/dialogflow/cx/v3/advanced_settings.proto b/java-dialogflow-cx/proto-google-cloud-dialogflow-cx-v3/src/main/proto/google/cloud/dialogflow/cx/v3/advanced_settings.proto index 904faab84dbb..d2de5b1fc2e6 100644 --- a/java-dialogflow-cx/proto-google-cloud-dialogflow-cx-v3/src/main/proto/google/cloud/dialogflow/cx/v3/advanced_settings.proto +++ b/java-dialogflow-cx/proto-google-cloud-dialogflow-cx-v3/src/main/proto/google/cloud/dialogflow/cx/v3/advanced_settings.proto @@ -29,7 +29,13 @@ option ruby_package = "Google::Cloud::Dialogflow::CX::V3"; // Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. // Settings exposed at lower level overrides the settings exposed at higher -// level. +// level. Overriding occurs at the sub-setting level. For example, the +// playback_interruption_settings at fulfillment level only overrides the +// playback_interruption_settings at the agent level, leaving other settings +// at the agent level unchanged. +// +// DTMF settings does not override each other. DTMF settings set at different +// levels define DTMF detections running in parallel. // // Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. message AdvancedSettings { diff --git a/java-dialogflow-cx/proto-google-cloud-dialogflow-cx-v3/src/main/proto/google/cloud/dialogflow/cx/v3/webhook.proto b/java-dialogflow-cx/proto-google-cloud-dialogflow-cx-v3/src/main/proto/google/cloud/dialogflow/cx/v3/webhook.proto index 0f20d698a5b0..7974131d7c76 100644 --- a/java-dialogflow-cx/proto-google-cloud-dialogflow-cx-v3/src/main/proto/google/cloud/dialogflow/cx/v3/webhook.proto +++ b/java-dialogflow-cx/proto-google-cloud-dialogflow-cx-v3/src/main/proto/google/cloud/dialogflow/cx/v3/webhook.proto @@ -273,6 +273,9 @@ message DeleteWebhookRequest { // The request message for a webhook call. The request is sent as a JSON object // and the field names will be presented in camel cases. +// +// You may see undocumented fields in an actual request. These fields are used +// internally by Dialogflow and should be ignored. message WebhookRequest { // Represents fulfillment information communicated to the webhook. message FulfillmentInfo {