From c1c0fb9eb9e62dc794aef1bac357bb5c20e322dc Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Tue, 18 May 2021 17:34:16 -0600 Subject: [PATCH] docs: clarified documentation for security settings docs: clarified documentation for session parameters (#90) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit docs: clarified documentation for security settings docs: clarified documentation for session parameters PiperOrigin-RevId: 374474736 Source-Link: https://github.com/googleapis/googleapis/commit/c27d0463cc0097d7a64a7b108aca659df00d2e06 Source-Link: https://github.com/googleapis/googleapis-gen/commit/abbbe2180d9863eb721cb5d86ed60994dfea0ad8 * 🦉 Updates from OwlBot Co-authored-by: Owl Bot --- .../types/security_settings.py | 21 ++++++++++++------- google/cloud/dialogflowcx_v3/types/session.py | 3 +++ .../types/security_settings.py | 21 ++++++++++++------- .../dialogflowcx_v3beta1/types/session.py | 3 +++ 4 files changed, 34 insertions(+), 14 deletions(-) diff --git a/google/cloud/dialogflowcx_v3/types/security_settings.py b/google/cloud/dialogflowcx_v3/types/security_settings.py index cee26936..4267d511 100644 --- a/google/cloud/dialogflowcx_v3/types/security_settings.py +++ b/google/cloud/dialogflowcx_v3/types/security_settings.py @@ -154,9 +154,10 @@ class SecuritySettings(proto.Message): redaction_strategy (google.cloud.dialogflowcx_v3.types.SecuritySettings.RedactionStrategy): Strategy that defines how we do redaction. redaction_scope (google.cloud.dialogflowcx_v3.types.SecuritySettings.RedactionScope): - 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. inspect_template (str): DLP inspect template name. Use this template to define inspect base settings. @@ -167,12 +168,18 @@ class SecuritySettings(proto.Message): ``projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID`` OR ``organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID`` retention_window_days (int): - Retains the data for the specified number of - days. User must Set a value lower than - Dialogflow's default 30d TTL. Setting a value - higher than that has no effect. + 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. purge_data_types (Sequence[google.cloud.dialogflowcx_v3.types.SecuritySettings.PurgeDataType]): List of types of data to remove when retention settings triggers purge. diff --git a/google/cloud/dialogflowcx_v3/types/session.py b/google/cloud/dialogflowcx_v3/types/session.py index 683e1353..9eb76709 100644 --- a/google/cloud/dialogflowcx_v3/types/session.py +++ b/google/cloud/dialogflowcx_v3/types/session.py @@ -368,6 +368,9 @@ class QueryParameters(proto.Message): 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) diff --git a/google/cloud/dialogflowcx_v3beta1/types/security_settings.py b/google/cloud/dialogflowcx_v3beta1/types/security_settings.py index 59139f23..df231806 100644 --- a/google/cloud/dialogflowcx_v3beta1/types/security_settings.py +++ b/google/cloud/dialogflowcx_v3beta1/types/security_settings.py @@ -154,9 +154,10 @@ class SecuritySettings(proto.Message): redaction_strategy (google.cloud.dialogflowcx_v3beta1.types.SecuritySettings.RedactionStrategy): Strategy that defines how we do redaction. redaction_scope (google.cloud.dialogflowcx_v3beta1.types.SecuritySettings.RedactionScope): - 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. inspect_template (str): DLP inspect template name. Use this template to define inspect base settings. @@ -167,12 +168,18 @@ class SecuritySettings(proto.Message): ``projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID`` OR ``organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID`` retention_window_days (int): - Retains the data for the specified number of - days. User must Set a value lower than - Dialogflow's default 30d TTL. Setting a value - higher than that has no effect. + 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. purge_data_types (Sequence[google.cloud.dialogflowcx_v3beta1.types.SecuritySettings.PurgeDataType]): List of types of data to remove when retention settings triggers purge. diff --git a/google/cloud/dialogflowcx_v3beta1/types/session.py b/google/cloud/dialogflowcx_v3beta1/types/session.py index 19b15006..bcf2da79 100644 --- a/google/cloud/dialogflowcx_v3beta1/types/session.py +++ b/google/cloud/dialogflowcx_v3beta1/types/session.py @@ -368,6 +368,9 @@ class QueryParameters(proto.Message): 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)