Skip to content
This repository was archived by the owner on Sep 16, 2023. It is now read-only.

Commit f93ad03

Browse files
docs: improve comments for protos (#503)
- [ ] Regenerate this pull request now. PiperOrigin-RevId: 458250124 Source-Link: googleapis/googleapis@913b9bd Source-Link: https://github.com/googleapis/googleapis-gen/commit/5601594f1cdf45d9df26f245604c333e3ff3838d Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNTYwMTU5NGYxY2RmNDVkOWRmMjZmMjQ1NjA0YzMzM2UzZmYzODM4ZCJ9
1 parent 52f3a16 commit f93ad03

File tree

4 files changed

+26
-3
lines changed

4 files changed

+26
-3
lines changed

proto-google-cloud-dialogflow-cx-v3/src/main/java/com/google/cloud/dialogflow/cx/v3/AdvancedSettings.java

+12-2
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,12 @@
2424
* <pre>
2525
* Hierarchical advanced settings for agent/flow/page/fulfillment/parameter.
2626
* Settings exposed at lower level overrides the settings exposed at higher
27-
* level.
27+
* level. Overriding occurs at the sub-setting level. For example, the
28+
* playback_interruption_settings at fulfillment level only overrides the
29+
* playback_interruption_settings at the agent level, leaving other settings
30+
* at the agent level unchanged.
31+
* DTMF settings does not override each other. DTMF settings set at different
32+
* levels define DTMF detections running in parallel.
2833
* Hierarchy: Agent-&gt;Flow-&gt;Page-&gt;Fulfillment/Parameter.
2934
* </pre>
3035
*
@@ -1026,7 +1031,12 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build
10261031
* <pre>
10271032
* Hierarchical advanced settings for agent/flow/page/fulfillment/parameter.
10281033
* Settings exposed at lower level overrides the settings exposed at higher
1029-
* level.
1034+
* level. Overriding occurs at the sub-setting level. For example, the
1035+
* playback_interruption_settings at fulfillment level only overrides the
1036+
* playback_interruption_settings at the agent level, leaving other settings
1037+
* at the agent level unchanged.
1038+
* DTMF settings does not override each other. DTMF settings set at different
1039+
* levels define DTMF detections running in parallel.
10301040
* Hierarchy: Agent-&gt;Flow-&gt;Page-&gt;Fulfillment/Parameter.
10311041
* </pre>
10321042
*

proto-google-cloud-dialogflow-cx-v3/src/main/java/com/google/cloud/dialogflow/cx/v3/WebhookRequest.java

+4
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@
2424
* <pre>
2525
* The request message for a webhook call. The request is sent as a JSON object
2626
* and the field names will be presented in camel cases.
27+
* You may see undocumented fields in an actual request. These fields are used
28+
* internally by Dialogflow and should be ignored.
2729
* </pre>
2830
*
2931
* Protobuf type {@code google.cloud.dialogflow.cx.v3.WebhookRequest}
@@ -5409,6 +5411,8 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build
54095411
* <pre>
54105412
* The request message for a webhook call. The request is sent as a JSON object
54115413
* and the field names will be presented in camel cases.
5414+
* You may see undocumented fields in an actual request. These fields are used
5415+
* internally by Dialogflow and should be ignored.
54125416
* </pre>
54135417
*
54145418
* Protobuf type {@code google.cloud.dialogflow.cx.v3.WebhookRequest}

proto-google-cloud-dialogflow-cx-v3/src/main/proto/google/cloud/dialogflow/cx/v3/advanced_settings.proto

+7-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,13 @@ option ruby_package = "Google::Cloud::Dialogflow::CX::V3";
2929

3030
// Hierarchical advanced settings for agent/flow/page/fulfillment/parameter.
3131
// Settings exposed at lower level overrides the settings exposed at higher
32-
// level.
32+
// level. Overriding occurs at the sub-setting level. For example, the
33+
// playback_interruption_settings at fulfillment level only overrides the
34+
// playback_interruption_settings at the agent level, leaving other settings
35+
// at the agent level unchanged.
36+
//
37+
// DTMF settings does not override each other. DTMF settings set at different
38+
// levels define DTMF detections running in parallel.
3339
//
3440
// Hierarchy: Agent->Flow->Page->Fulfillment/Parameter.
3541
message AdvancedSettings {

proto-google-cloud-dialogflow-cx-v3/src/main/proto/google/cloud/dialogflow/cx/v3/webhook.proto

+3
Original file line numberDiff line numberDiff line change
@@ -273,6 +273,9 @@ message DeleteWebhookRequest {
273273

274274
// The request message for a webhook call. The request is sent as a JSON object
275275
// and the field names will be presented in camel cases.
276+
//
277+
// You may see undocumented fields in an actual request. These fields are used
278+
// internally by Dialogflow and should be ignored.
276279
message WebhookRequest {
277280
// Represents fulfillment information communicated to the webhook.
278281
message FulfillmentInfo {

0 commit comments

Comments
 (0)