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

Commit f42002c

Browse files
yoshi-automationyoshi-automation
authored
docs(v3): clarified documentation for security settings (#215)
This PR was generated using Autosynth. 🌈 Synth log will be available here: https://source.cloud.google.com/results/invocations/ae41db5c-8b66-4c93-bc7d-82a4a6b6243c/targets - [ ] To automatically regenerate this PR, check this box. (May take up to 24 hours.) PiperOrigin-RevId: 374474736 Source-Link: googleapis/googleapis@c27d046 PiperOrigin-RevId: 374473298 Source-Link: googleapis/googleapis@f57b0b7 docs(v3): clarified documentation for session parameters docs(v3beta1): clarified documentation for security settings docs(v3beta1): clarified documentation for session parameters
1 parent 5f81e7c commit f42002c

File tree

13 files changed

+248
-90
lines changed

13 files changed

+248
-90
lines changed

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

+24
Original file line numberDiff line numberDiff line change
@@ -497,6 +497,8 @@ public com.google.protobuf.StructOrBuilder getPayloadOrBuilder() {
497497
* parameters][SessionInfo.parameters]. To remove a
498498
* parameter from the session, clients should explicitly set the parameter
499499
* value to null.
500+
* You can reference the session parameters in the agent with the following
501+
* format: $session.params.parameter-id.
500502
* Depending on your protocol or client library language, this is a
501503
* map, associative array, symbol table, dictionary, or JSON object
502504
* composed of a collection of (MapKey, MapValue) pairs:
@@ -528,6 +530,8 @@ public boolean hasParameters() {
528530
* parameters][SessionInfo.parameters]. To remove a
529531
* parameter from the session, clients should explicitly set the parameter
530532
* value to null.
533+
* You can reference the session parameters in the agent with the following
534+
* format: $session.params.parameter-id.
531535
* Depending on your protocol or client library language, this is a
532536
* map, associative array, symbol table, dictionary, or JSON object
533537
* composed of a collection of (MapKey, MapValue) pairs:
@@ -559,6 +563,8 @@ public com.google.protobuf.Struct getParameters() {
559563
* parameters][SessionInfo.parameters]. To remove a
560564
* parameter from the session, clients should explicitly set the parameter
561565
* value to null.
566+
* You can reference the session parameters in the agent with the following
567+
* format: $session.params.parameter-id.
562568
* Depending on your protocol or client library language, this is a
563569
* map, associative array, symbol table, dictionary, or JSON object
564570
* composed of a collection of (MapKey, MapValue) pairs:
@@ -2377,6 +2383,8 @@ public com.google.protobuf.StructOrBuilder getPayloadOrBuilder() {
23772383
* parameters][SessionInfo.parameters]. To remove a
23782384
* parameter from the session, clients should explicitly set the parameter
23792385
* value to null.
2386+
* You can reference the session parameters in the agent with the following
2387+
* format: $session.params.parameter-id.
23802388
* Depending on your protocol or client library language, this is a
23812389
* map, associative array, symbol table, dictionary, or JSON object
23822390
* composed of a collection of (MapKey, MapValue) pairs:
@@ -2407,6 +2415,8 @@ public boolean hasParameters() {
24072415
* parameters][SessionInfo.parameters]. To remove a
24082416
* parameter from the session, clients should explicitly set the parameter
24092417
* value to null.
2418+
* You can reference the session parameters in the agent with the following
2419+
* format: $session.params.parameter-id.
24102420
* Depending on your protocol or client library language, this is a
24112421
* map, associative array, symbol table, dictionary, or JSON object
24122422
* composed of a collection of (MapKey, MapValue) pairs:
@@ -2441,6 +2451,8 @@ public com.google.protobuf.Struct getParameters() {
24412451
* parameters][SessionInfo.parameters]. To remove a
24422452
* parameter from the session, clients should explicitly set the parameter
24432453
* value to null.
2454+
* You can reference the session parameters in the agent with the following
2455+
* format: $session.params.parameter-id.
24442456
* Depending on your protocol or client library language, this is a
24452457
* map, associative array, symbol table, dictionary, or JSON object
24462458
* composed of a collection of (MapKey, MapValue) pairs:
@@ -2479,6 +2491,8 @@ public Builder setParameters(com.google.protobuf.Struct value) {
24792491
* parameters][SessionInfo.parameters]. To remove a
24802492
* parameter from the session, clients should explicitly set the parameter
24812493
* value to null.
2494+
* You can reference the session parameters in the agent with the following
2495+
* format: $session.params.parameter-id.
24822496
* Depending on your protocol or client library language, this is a
24832497
* map, associative array, symbol table, dictionary, or JSON object
24842498
* composed of a collection of (MapKey, MapValue) pairs:
@@ -2514,6 +2528,8 @@ public Builder setParameters(com.google.protobuf.Struct.Builder builderForValue)
25142528
* parameters][SessionInfo.parameters]. To remove a
25152529
* parameter from the session, clients should explicitly set the parameter
25162530
* value to null.
2531+
* You can reference the session parameters in the agent with the following
2532+
* format: $session.params.parameter-id.
25172533
* Depending on your protocol or client library language, this is a
25182534
* map, associative array, symbol table, dictionary, or JSON object
25192535
* composed of a collection of (MapKey, MapValue) pairs:
@@ -2554,6 +2570,8 @@ public Builder mergeParameters(com.google.protobuf.Struct value) {
25542570
* parameters][SessionInfo.parameters]. To remove a
25552571
* parameter from the session, clients should explicitly set the parameter
25562572
* value to null.
2573+
* You can reference the session parameters in the agent with the following
2574+
* format: $session.params.parameter-id.
25572575
* Depending on your protocol or client library language, this is a
25582576
* map, associative array, symbol table, dictionary, or JSON object
25592577
* composed of a collection of (MapKey, MapValue) pairs:
@@ -2590,6 +2608,8 @@ public Builder clearParameters() {
25902608
* parameters][SessionInfo.parameters]. To remove a
25912609
* parameter from the session, clients should explicitly set the parameter
25922610
* value to null.
2611+
* You can reference the session parameters in the agent with the following
2612+
* format: $session.params.parameter-id.
25932613
* Depending on your protocol or client library language, this is a
25942614
* map, associative array, symbol table, dictionary, or JSON object
25952615
* composed of a collection of (MapKey, MapValue) pairs:
@@ -2620,6 +2640,8 @@ public com.google.protobuf.Struct.Builder getParametersBuilder() {
26202640
* parameters][SessionInfo.parameters]. To remove a
26212641
* parameter from the session, clients should explicitly set the parameter
26222642
* value to null.
2643+
* You can reference the session parameters in the agent with the following
2644+
* format: $session.params.parameter-id.
26232645
* Depending on your protocol or client library language, this is a
26242646
* map, associative array, symbol table, dictionary, or JSON object
26252647
* composed of a collection of (MapKey, MapValue) pairs:
@@ -2652,6 +2674,8 @@ public com.google.protobuf.StructOrBuilder getParametersOrBuilder() {
26522674
* parameters][SessionInfo.parameters]. To remove a
26532675
* parameter from the session, clients should explicitly set the parameter
26542676
* value to null.
2677+
* You can reference the session parameters in the agent with the following
2678+
* format: $session.params.parameter-id.
26552679
* Depending on your protocol or client library language, this is a
26562680
* map, associative array, symbol table, dictionary, or JSON object
26572681
* composed of a collection of (MapKey, MapValue) pairs:

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

+6
Original file line numberDiff line numberDiff line change
@@ -236,6 +236,8 @@ com.google.cloud.dialogflow.cx.v3.SessionEntityTypeOrBuilder getSessionEntityTyp
236236
* parameters][SessionInfo.parameters]. To remove a
237237
* parameter from the session, clients should explicitly set the parameter
238238
* value to null.
239+
* You can reference the session parameters in the agent with the following
240+
* format: $session.params.parameter-id.
239241
* Depending on your protocol or client library language, this is a
240242
* map, associative array, symbol table, dictionary, or JSON object
241243
* composed of a collection of (MapKey, MapValue) pairs:
@@ -264,6 +266,8 @@ com.google.cloud.dialogflow.cx.v3.SessionEntityTypeOrBuilder getSessionEntityTyp
264266
* parameters][SessionInfo.parameters]. To remove a
265267
* parameter from the session, clients should explicitly set the parameter
266268
* value to null.
269+
* You can reference the session parameters in the agent with the following
270+
* format: $session.params.parameter-id.
267271
* Depending on your protocol or client library language, this is a
268272
* map, associative array, symbol table, dictionary, or JSON object
269273
* composed of a collection of (MapKey, MapValue) pairs:
@@ -292,6 +296,8 @@ com.google.cloud.dialogflow.cx.v3.SessionEntityTypeOrBuilder getSessionEntityTyp
292296
* parameters][SessionInfo.parameters]. To remove a
293297
* parameter from the session, clients should explicitly set the parameter
294298
* value to null.
299+
* You can reference the session parameters in the agent with the following
300+
* format: $session.params.parameter-id.
295301
* Depending on your protocol or client library language, this is a
296302
* map, associative array, symbol table, dictionary, or JSON object
297303
* composed of a collection of (MapKey, MapValue) pairs:

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

+55-24
Original file line numberDiff line numberDiff line change
@@ -486,8 +486,8 @@ public enum PurgeDataType implements com.google.protobuf.ProtocolMessageEnum {
486486
*
487487
*
488488
* <pre>
489-
* Dialogflow history. This does not include Stackdriver log, which is
490-
* owned by the user not Dialogflow.
489+
* Dialogflow history. This does not include Cloud logging, which is
490+
* owned by the user - not Dialogflow.
491491
* </pre>
492492
*
493493
* <code>DIALOGFLOW_HISTORY = 1;</code>
@@ -510,8 +510,8 @@ public enum PurgeDataType implements com.google.protobuf.ProtocolMessageEnum {
510510
*
511511
*
512512
* <pre>
513-
* Dialogflow history. This does not include Stackdriver log, which is
514-
* owned by the user not Dialogflow.
513+
* Dialogflow history. This does not include Cloud logging, which is
514+
* owned by the user - not Dialogflow.
515515
* </pre>
516516
*
517517
* <code>DIALOGFLOW_HISTORY = 1;</code>
@@ -797,8 +797,9 @@ public int getRedactionStrategyValue() {
797797
*
798798
*
799799
* <pre>
800-
* Defines on what data we apply redaction. Note that we don't
801-
* redact data to which we don't have access, e.g., Stackdriver logs.
800+
* Defines the data for which Dialogflow applies redaction. Dialogflow does
801+
* not redact data that it does not have access to – for example, Cloud
802+
* logging.
802803
* </pre>
803804
*
804805
* <code>.google.cloud.dialogflow.cx.v3.SecuritySettings.RedactionScope redaction_scope = 4;
@@ -814,8 +815,9 @@ public int getRedactionScopeValue() {
814815
*
815816
*
816817
* <pre>
817-
* Defines on what data we apply redaction. Note that we don't
818-
* redact data to which we don't have access, e.g., Stackdriver logs.
818+
* Defines the data for which Dialogflow applies redaction. Dialogflow does
819+
* not redact data that it does not have access to – for example, Cloud
820+
* logging.
819821
* </pre>
820822
*
821823
* <code>.google.cloud.dialogflow.cx.v3.SecuritySettings.RedactionScope redaction_scope = 4;
@@ -897,11 +899,15 @@ public com.google.protobuf.ByteString getInspectTemplateBytes() {
897899
*
898900
*
899901
* <pre>
900-
* Retains the data for the specified number of days.
902+
* Retains data in interaction logging for the specified number of days.
903+
* This does not apply to Cloud logging, which is owned by the user - not
904+
* Dialogflow.
901905
* User must Set a value lower than Dialogflow's default 30d TTL. Setting a
902906
* value higher than that has no effect.
903907
* A missing value or setting to 0 also means we use Dialogflow's default
904908
* TTL.
909+
* Note: Interaction logging is a limited access feature. Talk to your
910+
* Google representative to check availability for you.
905911
* </pre>
906912
*
907913
* <code>int32 retention_window_days = 6;</code>
@@ -916,11 +922,15 @@ public boolean hasRetentionWindowDays() {
916922
*
917923
*
918924
* <pre>
919-
* Retains the data for the specified number of days.
925+
* Retains data in interaction logging for the specified number of days.
926+
* This does not apply to Cloud logging, which is owned by the user - not
927+
* Dialogflow.
920928
* User must Set a value lower than Dialogflow's default 30d TTL. Setting a
921929
* value higher than that has no effect.
922930
* A missing value or setting to 0 also means we use Dialogflow's default
923931
* TTL.
932+
* Note: Interaction logging is a limited access feature. Talk to your
933+
* Google representative to check availability for you.
924934
* </pre>
925935
*
926936
* <code>int32 retention_window_days = 6;</code>
@@ -1880,8 +1890,9 @@ public Builder clearRedactionStrategy() {
18801890
*
18811891
*
18821892
* <pre>
1883-
* Defines on what data we apply redaction. Note that we don't
1884-
* redact data to which we don't have access, e.g., Stackdriver logs.
1893+
* Defines the data for which Dialogflow applies redaction. Dialogflow does
1894+
* not redact data that it does not have access to – for example, Cloud
1895+
* logging.
18851896
* </pre>
18861897
*
18871898
* <code>.google.cloud.dialogflow.cx.v3.SecuritySettings.RedactionScope redaction_scope = 4;
@@ -1897,8 +1908,9 @@ public int getRedactionScopeValue() {
18971908
*
18981909
*
18991910
* <pre>
1900-
* Defines on what data we apply redaction. Note that we don't
1901-
* redact data to which we don't have access, e.g., Stackdriver logs.
1911+
* Defines the data for which Dialogflow applies redaction. Dialogflow does
1912+
* not redact data that it does not have access to – for example, Cloud
1913+
* logging.
19021914
* </pre>
19031915
*
19041916
* <code>.google.cloud.dialogflow.cx.v3.SecuritySettings.RedactionScope redaction_scope = 4;
@@ -1917,8 +1929,9 @@ public Builder setRedactionScopeValue(int value) {
19171929
*
19181930
*
19191931
* <pre>
1920-
* Defines on what data we apply redaction. Note that we don't
1921-
* redact data to which we don't have access, e.g., Stackdriver logs.
1932+
* Defines the data for which Dialogflow applies redaction. Dialogflow does
1933+
* not redact data that it does not have access to – for example, Cloud
1934+
* logging.
19221935
* </pre>
19231936
*
19241937
* <code>.google.cloud.dialogflow.cx.v3.SecuritySettings.RedactionScope redaction_scope = 4;
@@ -1940,8 +1953,9 @@ public com.google.cloud.dialogflow.cx.v3.SecuritySettings.RedactionScope getReda
19401953
*
19411954
*
19421955
* <pre>
1943-
* Defines on what data we apply redaction. Note that we don't
1944-
* redact data to which we don't have access, e.g., Stackdriver logs.
1956+
* Defines the data for which Dialogflow applies redaction. Dialogflow does
1957+
* not redact data that it does not have access to – for example, Cloud
1958+
* logging.
19451959
* </pre>
19461960
*
19471961
* <code>.google.cloud.dialogflow.cx.v3.SecuritySettings.RedactionScope redaction_scope = 4;
@@ -1964,8 +1978,9 @@ public Builder setRedactionScope(
19641978
*
19651979
*
19661980
* <pre>
1967-
* Defines on what data we apply redaction. Note that we don't
1968-
* redact data to which we don't have access, e.g., Stackdriver logs.
1981+
* Defines the data for which Dialogflow applies redaction. Dialogflow does
1982+
* not redact data that it does not have access to – for example, Cloud
1983+
* logging.
19691984
* </pre>
19701985
*
19711986
* <code>.google.cloud.dialogflow.cx.v3.SecuritySettings.RedactionScope redaction_scope = 4;
@@ -2115,11 +2130,15 @@ public Builder setInspectTemplateBytes(com.google.protobuf.ByteString value) {
21152130
*
21162131
*
21172132
* <pre>
2118-
* Retains the data for the specified number of days.
2133+
* Retains data in interaction logging for the specified number of days.
2134+
* This does not apply to Cloud logging, which is owned by the user - not
2135+
* Dialogflow.
21192136
* User must Set a value lower than Dialogflow's default 30d TTL. Setting a
21202137
* value higher than that has no effect.
21212138
* A missing value or setting to 0 also means we use Dialogflow's default
21222139
* TTL.
2140+
* Note: Interaction logging is a limited access feature. Talk to your
2141+
* Google representative to check availability for you.
21232142
* </pre>
21242143
*
21252144
* <code>int32 retention_window_days = 6;</code>
@@ -2133,11 +2152,15 @@ public boolean hasRetentionWindowDays() {
21332152
*
21342153
*
21352154
* <pre>
2136-
* Retains the data for the specified number of days.
2155+
* Retains data in interaction logging for the specified number of days.
2156+
* This does not apply to Cloud logging, which is owned by the user - not
2157+
* Dialogflow.
21372158
* User must Set a value lower than Dialogflow's default 30d TTL. Setting a
21382159
* value higher than that has no effect.
21392160
* A missing value or setting to 0 also means we use Dialogflow's default
21402161
* TTL.
2162+
* Note: Interaction logging is a limited access feature. Talk to your
2163+
* Google representative to check availability for you.
21412164
* </pre>
21422165
*
21432166
* <code>int32 retention_window_days = 6;</code>
@@ -2154,11 +2177,15 @@ public int getRetentionWindowDays() {
21542177
*
21552178
*
21562179
* <pre>
2157-
* Retains the data for the specified number of days.
2180+
* Retains data in interaction logging for the specified number of days.
2181+
* This does not apply to Cloud logging, which is owned by the user - not
2182+
* Dialogflow.
21582183
* User must Set a value lower than Dialogflow's default 30d TTL. Setting a
21592184
* value higher than that has no effect.
21602185
* A missing value or setting to 0 also means we use Dialogflow's default
21612186
* TTL.
2187+
* Note: Interaction logging is a limited access feature. Talk to your
2188+
* Google representative to check availability for you.
21622189
* </pre>
21632190
*
21642191
* <code>int32 retention_window_days = 6;</code>
@@ -2176,11 +2203,15 @@ public Builder setRetentionWindowDays(int value) {
21762203
*
21772204
*
21782205
* <pre>
2179-
* Retains the data for the specified number of days.
2206+
* Retains data in interaction logging for the specified number of days.
2207+
* This does not apply to Cloud logging, which is owned by the user - not
2208+
* Dialogflow.
21802209
* User must Set a value lower than Dialogflow's default 30d TTL. Setting a
21812210
* value higher than that has no effect.
21822211
* A missing value or setting to 0 also means we use Dialogflow's default
21832212
* TTL.
2213+
* Note: Interaction logging is a limited access feature. Talk to your
2214+
* Google representative to check availability for you.
21842215
* </pre>
21852216
*
21862217
* <code>int32 retention_window_days = 6;</code>

0 commit comments

Comments
 (0)