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
googleapis · May 19, 2021 · f42002c · f42002c
1 parent 5f81e7c
commit f42002c
Show file tree

Hide file tree

Showing 13 changed files with 248 additions and 90 deletions.
diff --git a/...oud-dialogflow-cx-v3/src/main/java/com/google/cloud/dialogflow/cx/v3/QueryParameters.java b/...oud-dialogflow-cx-v3/src/main/java/com/google/cloud/dialogflow/cx/v3/QueryParameters.java
@@ -497,6 +497,8 @@ public com.google.protobuf.StructOrBuilder getPayloadOrBuilder() {
    * parameters][SessionInfo.parameters]. To remove a
    * parameter from the session, clients should explicitly set the parameter
    * value to null.
+   * You can reference the session parameters in the agent with the following
+   * format: $session.params.parameter-id.
    * Depending on your protocol or client library language, this is a
    * map, associative array, symbol table, dictionary, or JSON object
    * composed of a collection of (MapKey, MapValue) pairs:
@@ -528,6 +530,8 @@ public boolean hasParameters() {
    * parameters][SessionInfo.parameters]. To remove a
    * parameter from the session, clients should explicitly set the parameter
    * value to null.
+   * You can reference the session parameters in the agent with the following
+   * format: $session.params.parameter-id.
    * Depending on your protocol or client library language, this is a
    * map, associative array, symbol table, dictionary, or JSON object
    * composed of a collection of (MapKey, MapValue) pairs:
@@ -559,6 +563,8 @@ public com.google.protobuf.Struct getParameters() {
    * parameters][SessionInfo.parameters]. To remove a
    * parameter from the session, clients should explicitly set the parameter
    * value to null.
+   * You can reference the session parameters in the agent with the following
+   * format: $session.params.parameter-id.
    * Depending on your protocol or client library language, this is a
    * map, associative array, symbol table, dictionary, or JSON object
    * composed of a collection of (MapKey, MapValue) pairs:
@@ -2377,6 +2383,8 @@ public com.google.protobuf.StructOrBuilder getPayloadOrBuilder() {
      * parameters][SessionInfo.parameters]. To remove a
      * parameter from the session, clients should explicitly set the parameter
      * value to null.
+     * You can reference the session parameters in the agent with the following
+     * format: $session.params.parameter-id.
      * Depending on your protocol or client library language, this is a
      * map, associative array, symbol table, dictionary, or JSON object
      * composed of a collection of (MapKey, MapValue) pairs:
@@ -2407,6 +2415,8 @@ public boolean hasParameters() {
      * parameters][SessionInfo.parameters]. To remove a
      * parameter from the session, clients should explicitly set the parameter
      * value to null.
+     * You can reference the session parameters in the agent with the following
+     * format: $session.params.parameter-id.
      * Depending on your protocol or client library language, this is a
      * map, associative array, symbol table, dictionary, or JSON object
      * composed of a collection of (MapKey, MapValue) pairs:
@@ -2441,6 +2451,8 @@ public com.google.protobuf.Struct getParameters() {
      * parameters][SessionInfo.parameters]. To remove a
      * parameter from the session, clients should explicitly set the parameter
      * value to null.
+     * You can reference the session parameters in the agent with the following
+     * format: $session.params.parameter-id.
      * Depending on your protocol or client library language, this is a
      * map, associative array, symbol table, dictionary, or JSON object
      * composed of a collection of (MapKey, MapValue) pairs:
@@ -2479,6 +2491,8 @@ public Builder setParameters(com.google.protobuf.Struct value) {
      * parameters][SessionInfo.parameters]. To remove a
      * parameter from the session, clients should explicitly set the parameter
      * value to null.
+     * You can reference the session parameters in the agent with the following
+     * format: $session.params.parameter-id.
      * Depending on your protocol or client library language, this is a
      * map, associative array, symbol table, dictionary, or JSON object
      * composed of a collection of (MapKey, MapValue) pairs:
@@ -2514,6 +2528,8 @@ public Builder setParameters(com.google.protobuf.Struct.Builder builderForValue)
      * parameters][SessionInfo.parameters]. To remove a
      * parameter from the session, clients should explicitly set the parameter
      * value to null.
+     * You can reference the session parameters in the agent with the following
+     * format: $session.params.parameter-id.
      * Depending on your protocol or client library language, this is a
      * map, associative array, symbol table, dictionary, or JSON object
      * composed of a collection of (MapKey, MapValue) pairs:
@@ -2554,6 +2570,8 @@ public Builder mergeParameters(com.google.protobuf.Struct value) {
      * parameters][SessionInfo.parameters]. To remove a
      * parameter from the session, clients should explicitly set the parameter
      * value to null.
+     * You can reference the session parameters in the agent with the following
+     * format: $session.params.parameter-id.
      * Depending on your protocol or client library language, this is a
      * map, associative array, symbol table, dictionary, or JSON object
      * composed of a collection of (MapKey, MapValue) pairs:
@@ -2590,6 +2608,8 @@ public Builder clearParameters() {
      * parameters][SessionInfo.parameters]. To remove a
      * parameter from the session, clients should explicitly set the parameter
      * value to null.
+     * You can reference the session parameters in the agent with the following
+     * format: $session.params.parameter-id.
      * Depending on your protocol or client library language, this is a
      * map, associative array, symbol table, dictionary, or JSON object
      * composed of a collection of (MapKey, MapValue) pairs:
@@ -2620,6 +2640,8 @@ public com.google.protobuf.Struct.Builder getParametersBuilder() {
      * parameters][SessionInfo.parameters]. To remove a
      * parameter from the session, clients should explicitly set the parameter
      * value to null.
+     * You can reference the session parameters in the agent with the following
+     * format: $session.params.parameter-id.
      * Depending on your protocol or client library language, this is a
      * map, associative array, symbol table, dictionary, or JSON object
      * composed of a collection of (MapKey, MapValue) pairs:
@@ -2652,6 +2674,8 @@ public com.google.protobuf.StructOrBuilder getParametersOrBuilder() {
      * parameters][SessionInfo.parameters]. To remove a
      * parameter from the session, clients should explicitly set the parameter
      * value to null.
+     * You can reference the session parameters in the agent with the following
+     * format: $session.params.parameter-id.
      * Depending on your protocol or client library language, this is a
      * map, associative array, symbol table, dictionary, or JSON object
      * composed of a collection of (MapKey, MapValue) pairs:

diff --git a/...gflow-cx-v3/src/main/java/com/google/cloud/dialogflow/cx/v3/QueryParametersOrBuilder.java b/...gflow-cx-v3/src/main/java/com/google/cloud/dialogflow/cx/v3/QueryParametersOrBuilder.java
@@ -236,6 +236,8 @@ com.google.cloud.dialogflow.cx.v3.SessionEntityTypeOrBuilder getSessionEntityTyp
    * parameters][SessionInfo.parameters]. To remove a
    * parameter from the session, clients should explicitly set the parameter
    * value to null.
+   * You can reference the session parameters in the agent with the following
+   * format: $session.params.parameter-id.
    * Depending on your protocol or client library language, this is a
    * map, associative array, symbol table, dictionary, or JSON object
    * composed of a collection of (MapKey, MapValue) pairs:
@@ -264,6 +266,8 @@ com.google.cloud.dialogflow.cx.v3.SessionEntityTypeOrBuilder getSessionEntityTyp
    * parameters][SessionInfo.parameters]. To remove a
    * parameter from the session, clients should explicitly set the parameter
    * value to null.
+   * You can reference the session parameters in the agent with the following
+   * format: $session.params.parameter-id.
    * Depending on your protocol or client library language, this is a
    * map, associative array, symbol table, dictionary, or JSON object
    * composed of a collection of (MapKey, MapValue) pairs:
@@ -292,6 +296,8 @@ com.google.cloud.dialogflow.cx.v3.SessionEntityTypeOrBuilder getSessionEntityTyp
    * parameters][SessionInfo.parameters]. To remove a
    * parameter from the session, clients should explicitly set the parameter
    * value to null.
+   * You can reference the session parameters in the agent with the following
+   * format: $session.params.parameter-id.
    * Depending on your protocol or client library language, this is a
    * map, associative array, symbol table, dictionary, or JSON object
    * composed of a collection of (MapKey, MapValue) pairs:

diff --git a/...ud-dialogflow-cx-v3/src/main/java/com/google/cloud/dialogflow/cx/v3/SecuritySettings.java b/...ud-dialogflow-cx-v3/src/main/java/com/google/cloud/dialogflow/cx/v3/SecuritySettings.java
@@ -486,8 +486,8 @@ public enum PurgeDataType implements com.google.protobuf.ProtocolMessageEnum {
      *
      *
      * <pre>
-     * Dialogflow history. This does not include Stackdriver log, which is
-     * owned by the user not Dialogflow.
+     * Dialogflow history. This does not include Cloud logging, which is
+     * owned by the user - not Dialogflow.
      * </pre>
      *
      * <code>DIALOGFLOW_HISTORY = 1;</code>
@@ -510,8 +510,8 @@ public enum PurgeDataType implements com.google.protobuf.ProtocolMessageEnum {
      *
      *
      * <pre>
-     * Dialogflow history. This does not include Stackdriver log, which is
-     * owned by the user not Dialogflow.
+     * Dialogflow history. This does not include Cloud logging, which is
+     * owned by the user - not Dialogflow.
      * </pre>
      *
      * <code>DIALOGFLOW_HISTORY = 1;</code>
@@ -797,8 +797,9 @@ public int getRedactionStrategyValue() {
    *
    *
    * <pre>
-   * Defines on what data we apply redaction. Note that we don't
-   * redact data to which we don't have access, e.g., Stackdriver logs.
+   * Defines the data for which Dialogflow applies redaction. Dialogflow does
+   * not redact data that it does not have access to – for example, Cloud
+   * logging.
    * </pre>
    *
    * <code>.google.cloud.dialogflow.cx.v3.SecuritySettings.RedactionScope redaction_scope = 4;
@@ -814,8 +815,9 @@ public int getRedactionScopeValue() {
    *
    *
    * <pre>
-   * Defines on what data we apply redaction. Note that we don't
-   * redact data to which we don't have access, e.g., Stackdriver logs.
+   * Defines the data for which Dialogflow applies redaction. Dialogflow does
+   * not redact data that it does not have access to – for example, Cloud
+   * logging.
    * </pre>
    *
    * <code>.google.cloud.dialogflow.cx.v3.SecuritySettings.RedactionScope redaction_scope = 4;
@@ -897,11 +899,15 @@ public com.google.protobuf.ByteString getInspectTemplateBytes() {
    *
    *
    * <pre>
-   * Retains the data for the specified number of days.
+   * Retains data in interaction logging for the specified number of days.
+   * This does not apply to Cloud logging, which is owned by the user - not
+   * Dialogflow.
    * User must Set a value lower than Dialogflow's default 30d TTL. Setting a
    * value higher than that has no effect.
    * A missing value or setting to 0 also means we use Dialogflow's default
    * TTL.
+   * Note: Interaction logging is a limited access feature. Talk to your
+   * Google representative to check availability for you.
    * </pre>
    *
    * <code>int32 retention_window_days = 6;</code>
@@ -916,11 +922,15 @@ public boolean hasRetentionWindowDays() {
    *
    *
    * <pre>
-   * Retains the data for the specified number of days.
+   * Retains data in interaction logging for the specified number of days.
+   * This does not apply to Cloud logging, which is owned by the user - not
+   * Dialogflow.
    * User must Set a value lower than Dialogflow's default 30d TTL. Setting a
    * value higher than that has no effect.
    * A missing value or setting to 0 also means we use Dialogflow's default
    * TTL.
+   * Note: Interaction logging is a limited access feature. Talk to your
+   * Google representative to check availability for you.
    * </pre>
    *
    * <code>int32 retention_window_days = 6;</code>
@@ -1880,8 +1890,9 @@ public Builder clearRedactionStrategy() {
      *
      *
      * <pre>
-     * Defines on what data we apply redaction. Note that we don't
-     * redact data to which we don't have access, e.g., Stackdriver logs.
+     * Defines the data for which Dialogflow applies redaction. Dialogflow does
+     * not redact data that it does not have access to – for example, Cloud
+     * logging.
      * </pre>
      *
      * <code>.google.cloud.dialogflow.cx.v3.SecuritySettings.RedactionScope redaction_scope = 4;
@@ -1897,8 +1908,9 @@ public int getRedactionScopeValue() {
      *
      *
      * <pre>
-     * Defines on what data we apply redaction. Note that we don't
-     * redact data to which we don't have access, e.g., Stackdriver logs.
+     * Defines the data for which Dialogflow applies redaction. Dialogflow does
+     * not redact data that it does not have access to – for example, Cloud
+     * logging.
      * </pre>
      *
      * <code>.google.cloud.dialogflow.cx.v3.SecuritySettings.RedactionScope redaction_scope = 4;
@@ -1917,8 +1929,9 @@ public Builder setRedactionScopeValue(int value) {
      *
      *
      * <pre>
-     * Defines on what data we apply redaction. Note that we don't
-     * redact data to which we don't have access, e.g., Stackdriver logs.
+     * Defines the data for which Dialogflow applies redaction. Dialogflow does
+     * not redact data that it does not have access to – for example, Cloud
+     * logging.
      * </pre>
      *
      * <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
      *
      *
      * <pre>
-     * Defines on what data we apply redaction. Note that we don't
-     * redact data to which we don't have access, e.g., Stackdriver logs.
+     * Defines the data for which Dialogflow applies redaction. Dialogflow does
+     * not redact data that it does not have access to – for example, Cloud
+     * logging.
      * </pre>
      *
      * <code>.google.cloud.dialogflow.cx.v3.SecuritySettings.RedactionScope redaction_scope = 4;
@@ -1964,8 +1978,9 @@ public Builder setRedactionScope(
      *
      *
      * <pre>
-     * Defines on what data we apply redaction. Note that we don't
-     * redact data to which we don't have access, e.g., Stackdriver logs.
+     * Defines the data for which Dialogflow applies redaction. Dialogflow does
+     * not redact data that it does not have access to – for example, Cloud
+     * logging.
      * </pre>
      *
      * <code>.google.cloud.dialogflow.cx.v3.SecuritySettings.RedactionScope redaction_scope = 4;
@@ -2115,11 +2130,15 @@ public Builder setInspectTemplateBytes(com.google.protobuf.ByteString value) {
      *
      *
      * <pre>
-     * Retains the data for the specified number of days.
+     * Retains data in interaction logging for the specified number of days.
+     * This does not apply to Cloud logging, which is owned by the user - not
+     * Dialogflow.
      * User must Set a value lower than Dialogflow's default 30d TTL. Setting a
      * value higher than that has no effect.
      * A missing value or setting to 0 also means we use Dialogflow's default
      * TTL.
+     * Note: Interaction logging is a limited access feature. Talk to your
+     * Google representative to check availability for you.
      * </pre>
      *
      * <code>int32 retention_window_days = 6;</code>
@@ -2133,11 +2152,15 @@ public boolean hasRetentionWindowDays() {
      *
      *
      * <pre>
-     * Retains the data for the specified number of days.
+     * Retains data in interaction logging for the specified number of days.
+     * This does not apply to Cloud logging, which is owned by the user - not
+     * Dialogflow.
      * User must Set a value lower than Dialogflow's default 30d TTL. Setting a
      * value higher than that has no effect.
      * A missing value or setting to 0 also means we use Dialogflow's default
      * TTL.
+     * Note: Interaction logging is a limited access feature. Talk to your
+     * Google representative to check availability for you.
      * </pre>
      *
      * <code>int32 retention_window_days = 6;</code>
@@ -2154,11 +2177,15 @@ public int getRetentionWindowDays() {
      *
      *
      * <pre>
-     * Retains the data for the specified number of days.
+     * Retains data in interaction logging for the specified number of days.
+     * This does not apply to Cloud logging, which is owned by the user - not
+     * Dialogflow.
      * User must Set a value lower than Dialogflow's default 30d TTL. Setting a
      * value higher than that has no effect.
      * A missing value or setting to 0 also means we use Dialogflow's default
      * TTL.
+     * Note: Interaction logging is a limited access feature. Talk to your
+     * Google representative to check availability for you.
      * </pre>
      *
      * <code>int32 retention_window_days = 6;</code>
@@ -2176,11 +2203,15 @@ public Builder setRetentionWindowDays(int value) {
      *
      *
      * <pre>
-     * Retains the data for the specified number of days.
+     * Retains data in interaction logging for the specified number of days.
+     * This does not apply to Cloud logging, which is owned by the user - not
+     * Dialogflow.
      * User must Set a value lower than Dialogflow's default 30d TTL. Setting a
      * value higher than that has no effect.
      * A missing value or setting to 0 also means we use Dialogflow's default
      * TTL.
+     * Note: Interaction logging is a limited access feature. Talk to your
+     * Google representative to check availability for you.
      * </pre>
      *
      * <code>int32 retention_window_days = 6;</code>