Blame - docs/dyn/dialogflow_v3beta1.projects.locations.securitySettings.html - platform/external/python/google-api-python-client

blob: c23bd5bb3dcb4c084c62e213c3c78e1245a5d7c1 [file] [log] [blame]

yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, h1, h2, h3, div, span, p, pre, a {
				5	margin: 0;
				6	padding: 0;
				7	border: 0;
				8	font-weight: inherit;
				9	font-style: inherit;
				10	font-size: 100%;
				11	font-family: inherit;
				12	vertical-align: baseline;
				13	}
				14
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, h2, h3 {
				50	border-bottom: solid #CCC 1px;
				51	}
				52
				53	.toc_element {
				54	margin-top: 0.5em;
				55	}
				56
				57	.firstline {
				58	margin-left: 2 em;
				59	}
				60
				61	.method {
				62	margin-top: 1em;
				63	border: solid 1px #CCC;
				64	padding: 1em;
				65	background: #EEE;
				66	}
				67
				68	.details {
				69	font-weight: bold;
				70	font-size: 14px;
				71	}
				72
				73	</style>
				74
				75	<h1><a href="dialogflow_v3beta1.html">Dialogflow API</a> . <a href="dialogflow_v3beta1.projects.html">projects</a> . <a href="dialogflow_v3beta1.projects.locations.html">locations</a> . <a href="dialogflow_v3beta1.projects.locations.securitySettings.html">securitySettings</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="#close">close()</a></code></p>
				79	<p class="firstline">Close httplib2 connections.</p>
				80	<p class="toc_element">
				81	<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
				82	<p class="firstline">Create security settings in the specified location.</p>
				83	<p class="toc_element">
				84	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
				85	<p class="firstline">Deletes the specified SecuritySettings.</p>
				86	<p class="toc_element">
				87	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
				88	<p class="firstline">Retrieves the specified SecuritySettings. The returned settings may be stale by up to 1 minute.</p>
				89	<p class="toc_element">
				90	<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
				91	<p class="firstline">Returns the list of all security settings in the specified location.</p>
				92	<p class="toc_element">
				93	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				94	<p class="firstline">Retrieves the next page of results.</p>
				95	<p class="toc_element">
				96	<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
				97	<p class="firstline">Updates the specified SecuritySettings.</p>
				98	<h3>Method Details</h3>
				99	<div class="method">
				100	<code class="details" id="close">close()</code>
				101	<pre>Close httplib2 connections.</pre>
				102	</div>
				103
				104	<div class="method">
				105	<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
				106	<pre>Create security settings in the specified location.
				107
				108	Args:
				109	parent: string, Required. The location to create an SecuritySettings for. Format: `projects//locations/`. (required)
				110	body: object, The request body.
				111	The object takes the form of:
				112
				113	{ # Represents the settings related to security issues, such as data redaction and data retention. It may take hours for updates on the settings to propagate to all the related components and take effect.
				114	"displayName": "A String", # Required. The human-readable name of the security settings, unique within the location.
yoshi-code-bot	b539cc4	2021-08-03 00:20:27 -0700	[diff] [blame]	115	"insightsExportSettings": { # Settings for exporting conversations to [Insights](https://cloud.google.com/dialogflow/priv/docs/insights). # Optional. Controls conversation exporting settings to Insights after conversation is completed. If retention_strategy is set to REMOVE_AFTER_CONVERSATION, Insights export is disabled no matter what you configure here.
				116	"enableInsightsExport": True or False, # If enabled, we will automatically exports conversations to Insights and Insights runs its analyzers.
				117	},
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	118	"inspectTemplate": "A String", # [DLP](https://cloud.google.com/dlp/docs) inspect template name. Use this template to define inspect base settings. If empty, we use the default DLP inspect config. The template name will have one of the following formats: `projects//inspectTemplates/` OR `projects//locations//inspectTemplates/` OR `organizations//inspectTemplates/`
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	119	"name": "A String", # Required. Resource name of the settings. Format: `projects//locations//securitySettings/`.
				120	"purgeDataTypes": [ # List of types of data to remove when retention settings triggers purge.
				121	"A String",
				122	],
yoshi-code-bot	7700bbf	2021-05-20 04:44:03 -0700	[diff] [blame]	123	"redactionScope": "A String", # Defines the data for which Dialogflow applies redaction. Dialogflow does not redact data that it does not have access to – for example, Cloud logging.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	124	"redactionStrategy": "A String", # Strategy that defines how we do redaction.
yoshi-code-bot	7700bbf	2021-05-20 04:44:03 -0700	[diff] [blame]	125	"retentionWindowDays": 42, # 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.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	126	}
				127
				128	x__xgafv: string, V1 error format.
				129	Allowed values
				130	1 - v1 error format
				131	2 - v2 error format
				132
				133	Returns:
				134	An object of the form:
				135
				136	{ # Represents the settings related to security issues, such as data redaction and data retention. It may take hours for updates on the settings to propagate to all the related components and take effect.
				137	"displayName": "A String", # Required. The human-readable name of the security settings, unique within the location.
yoshi-code-bot	b539cc4	2021-08-03 00:20:27 -0700	[diff] [blame]	138	"insightsExportSettings": { # Settings for exporting conversations to [Insights](https://cloud.google.com/dialogflow/priv/docs/insights). # Optional. Controls conversation exporting settings to Insights after conversation is completed. If retention_strategy is set to REMOVE_AFTER_CONVERSATION, Insights export is disabled no matter what you configure here.
				139	"enableInsightsExport": True or False, # If enabled, we will automatically exports conversations to Insights and Insights runs its analyzers.
				140	},
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	141	"inspectTemplate": "A String", # [DLP](https://cloud.google.com/dlp/docs) inspect template name. Use this template to define inspect base settings. If empty, we use the default DLP inspect config. The template name will have one of the following formats: `projects//inspectTemplates/` OR `projects//locations//inspectTemplates/` OR `organizations//inspectTemplates/`
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	142	"name": "A String", # Required. Resource name of the settings. Format: `projects//locations//securitySettings/`.
				143	"purgeDataTypes": [ # List of types of data to remove when retention settings triggers purge.
				144	"A String",
				145	],
yoshi-code-bot	7700bbf	2021-05-20 04:44:03 -0700	[diff] [blame]	146	"redactionScope": "A String", # Defines the data for which Dialogflow applies redaction. Dialogflow does not redact data that it does not have access to – for example, Cloud logging.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	147	"redactionStrategy": "A String", # Strategy that defines how we do redaction.
yoshi-code-bot	7700bbf	2021-05-20 04:44:03 -0700	[diff] [blame]	148	"retentionWindowDays": 42, # 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.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	149	}</pre>
				150	</div>
				151
				152	<div class="method">
				153	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
				154	<pre>Deletes the specified SecuritySettings.
				155
				156	Args:
				157	name: string, Required. The name of the SecuritySettings to delete. Format: `projects//locations//securitySettings/`. (required)
				158	x__xgafv: string, V1 error format.
				159	Allowed values
				160	1 - v1 error format
				161	2 - v2 error format
				162
				163	Returns:
				164	An object of the form:
				165
				166	{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
				167	}</pre>
				168	</div>
				169
				170	<div class="method">
				171	<code class="details" id="get">get(name, x__xgafv=None)</code>
				172	<pre>Retrieves the specified SecuritySettings. The returned settings may be stale by up to 1 minute.
				173
				174	Args:
				175	name: string, Required. Resource name of the settings. Format: `projects//locations//securitySettings/`. (required)
				176	x__xgafv: string, V1 error format.
				177	Allowed values
				178	1 - v1 error format
				179	2 - v2 error format
				180
				181	Returns:
				182	An object of the form:
				183
				184	{ # Represents the settings related to security issues, such as data redaction and data retention. It may take hours for updates on the settings to propagate to all the related components and take effect.
				185	"displayName": "A String", # Required. The human-readable name of the security settings, unique within the location.
yoshi-code-bot	b539cc4	2021-08-03 00:20:27 -0700	[diff] [blame]	186	"insightsExportSettings": { # Settings for exporting conversations to [Insights](https://cloud.google.com/dialogflow/priv/docs/insights). # Optional. Controls conversation exporting settings to Insights after conversation is completed. If retention_strategy is set to REMOVE_AFTER_CONVERSATION, Insights export is disabled no matter what you configure here.
				187	"enableInsightsExport": True or False, # If enabled, we will automatically exports conversations to Insights and Insights runs its analyzers.
				188	},
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	189	"inspectTemplate": "A String", # [DLP](https://cloud.google.com/dlp/docs) inspect template name. Use this template to define inspect base settings. If empty, we use the default DLP inspect config. The template name will have one of the following formats: `projects//inspectTemplates/` OR `projects//locations//inspectTemplates/` OR `organizations//inspectTemplates/`
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	190	"name": "A String", # Required. Resource name of the settings. Format: `projects//locations//securitySettings/`.
				191	"purgeDataTypes": [ # List of types of data to remove when retention settings triggers purge.
				192	"A String",
				193	],
yoshi-code-bot	7700bbf	2021-05-20 04:44:03 -0700	[diff] [blame]	194	"redactionScope": "A String", # Defines the data for which Dialogflow applies redaction. Dialogflow does not redact data that it does not have access to – for example, Cloud logging.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	195	"redactionStrategy": "A String", # Strategy that defines how we do redaction.
yoshi-code-bot	7700bbf	2021-05-20 04:44:03 -0700	[diff] [blame]	196	"retentionWindowDays": 42, # 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.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	197	}</pre>
				198	</div>
				199
				200	<div class="method">
				201	<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
				202	<pre>Returns the list of all security settings in the specified location.
				203
				204	Args:
				205	parent: string, Required. The location to list all security settings for. Format: `projects//locations/`. (required)
				206	pageSize: integer, The maximum number of items to return in a single page. By default 20 and at most 100.
				207	pageToken: string, The next_page_token value returned from a previous list request.
				208	x__xgafv: string, V1 error format.
				209	Allowed values
				210	1 - v1 error format
				211	2 - v2 error format
				212
				213	Returns:
				214	An object of the form:
				215
				216	{ # The response message for SecuritySettings.ListSecuritySettings.
				217	"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
				218	"securitySettings": [ # The list of security settings.
				219	{ # Represents the settings related to security issues, such as data redaction and data retention. It may take hours for updates on the settings to propagate to all the related components and take effect.
				220	"displayName": "A String", # Required. The human-readable name of the security settings, unique within the location.
yoshi-code-bot	b539cc4	2021-08-03 00:20:27 -0700	[diff] [blame]	221	"insightsExportSettings": { # Settings for exporting conversations to [Insights](https://cloud.google.com/dialogflow/priv/docs/insights). # Optional. Controls conversation exporting settings to Insights after conversation is completed. If retention_strategy is set to REMOVE_AFTER_CONVERSATION, Insights export is disabled no matter what you configure here.
				222	"enableInsightsExport": True or False, # If enabled, we will automatically exports conversations to Insights and Insights runs its analyzers.
				223	},
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	224	"inspectTemplate": "A String", # [DLP](https://cloud.google.com/dlp/docs) inspect template name. Use this template to define inspect base settings. If empty, we use the default DLP inspect config. The template name will have one of the following formats: `projects//inspectTemplates/` OR `projects//locations//inspectTemplates/` OR `organizations//inspectTemplates/`
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	225	"name": "A String", # Required. Resource name of the settings. Format: `projects//locations//securitySettings/`.
				226	"purgeDataTypes": [ # List of types of data to remove when retention settings triggers purge.
				227	"A String",
				228	],
yoshi-code-bot	7700bbf	2021-05-20 04:44:03 -0700	[diff] [blame]	229	"redactionScope": "A String", # Defines the data for which Dialogflow applies redaction. Dialogflow does not redact data that it does not have access to – for example, Cloud logging.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	230	"redactionStrategy": "A String", # Strategy that defines how we do redaction.
yoshi-code-bot	7700bbf	2021-05-20 04:44:03 -0700	[diff] [blame]	231	"retentionWindowDays": 42, # 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.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	232	},
				233	],
				234	}</pre>
				235	</div>
				236
				237	<div class="method">
				238	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				239	<pre>Retrieves the next page of results.
				240
				241	Args:
				242	previous_request: The request for the previous page. (required)
				243	previous_response: The response from the request for the previous page. (required)
				244
				245	Returns:
				246	A request object that you can call 'execute()' on to request the next
				247	page. Returns None if there are no more items in the collection.
				248	</pre>
				249	</div>
				250
				251	<div class="method">
				252	<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
				253	<pre>Updates the specified SecuritySettings.
				254
				255	Args:
				256	name: string, Required. Resource name of the settings. Format: `projects//locations//securitySettings/`. (required)
				257	body: object, The request body.
				258	The object takes the form of:
				259
				260	{ # Represents the settings related to security issues, such as data redaction and data retention. It may take hours for updates on the settings to propagate to all the related components and take effect.
				261	"displayName": "A String", # Required. The human-readable name of the security settings, unique within the location.
yoshi-code-bot	b539cc4	2021-08-03 00:20:27 -0700	[diff] [blame]	262	"insightsExportSettings": { # Settings for exporting conversations to [Insights](https://cloud.google.com/dialogflow/priv/docs/insights). # Optional. Controls conversation exporting settings to Insights after conversation is completed. If retention_strategy is set to REMOVE_AFTER_CONVERSATION, Insights export is disabled no matter what you configure here.
				263	"enableInsightsExport": True or False, # If enabled, we will automatically exports conversations to Insights and Insights runs its analyzers.
				264	},
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	265	"inspectTemplate": "A String", # [DLP](https://cloud.google.com/dlp/docs) inspect template name. Use this template to define inspect base settings. If empty, we use the default DLP inspect config. The template name will have one of the following formats: `projects//inspectTemplates/` OR `projects//locations//inspectTemplates/` OR `organizations//inspectTemplates/`
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	266	"name": "A String", # Required. Resource name of the settings. Format: `projects//locations//securitySettings/`.
				267	"purgeDataTypes": [ # List of types of data to remove when retention settings triggers purge.
				268	"A String",
				269	],
yoshi-code-bot	7700bbf	2021-05-20 04:44:03 -0700	[diff] [blame]	270	"redactionScope": "A String", # Defines the data for which Dialogflow applies redaction. Dialogflow does not redact data that it does not have access to – for example, Cloud logging.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	271	"redactionStrategy": "A String", # Strategy that defines how we do redaction.
yoshi-code-bot	7700bbf	2021-05-20 04:44:03 -0700	[diff] [blame]	272	"retentionWindowDays": 42, # 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.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	273	}
				274
				275	updateMask: string, Required. The mask to control which fields get updated. If the mask is not present, all fields will be updated.
				276	x__xgafv: string, V1 error format.
				277	Allowed values
				278	1 - v1 error format
				279	2 - v2 error format
				280
				281	Returns:
				282	An object of the form:
				283
				284	{ # Represents the settings related to security issues, such as data redaction and data retention. It may take hours for updates on the settings to propagate to all the related components and take effect.
				285	"displayName": "A String", # Required. The human-readable name of the security settings, unique within the location.
yoshi-code-bot	b539cc4	2021-08-03 00:20:27 -0700	[diff] [blame]	286	"insightsExportSettings": { # Settings for exporting conversations to [Insights](https://cloud.google.com/dialogflow/priv/docs/insights). # Optional. Controls conversation exporting settings to Insights after conversation is completed. If retention_strategy is set to REMOVE_AFTER_CONVERSATION, Insights export is disabled no matter what you configure here.
				287	"enableInsightsExport": True or False, # If enabled, we will automatically exports conversations to Insights and Insights runs its analyzers.
				288	},
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	289	"inspectTemplate": "A String", # [DLP](https://cloud.google.com/dlp/docs) inspect template name. Use this template to define inspect base settings. If empty, we use the default DLP inspect config. The template name will have one of the following formats: `projects//inspectTemplates/` OR `projects//locations//inspectTemplates/` OR `organizations//inspectTemplates/`
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	290	"name": "A String", # Required. Resource name of the settings. Format: `projects//locations//securitySettings/`.
				291	"purgeDataTypes": [ # List of types of data to remove when retention settings triggers purge.
				292	"A String",
				293	],
yoshi-code-bot	7700bbf	2021-05-20 04:44:03 -0700	[diff] [blame]	294	"redactionScope": "A String", # Defines the data for which Dialogflow applies redaction. Dialogflow does not redact data that it does not have access to – for example, Cloud logging.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	295	"redactionStrategy": "A String", # Strategy that defines how we do redaction.
yoshi-code-bot	7700bbf	2021-05-20 04:44:03 -0700	[diff] [blame]	296	"retentionWindowDays": 42, # 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.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	297	}</pre>
				298	</div>
				299
				300	</body></html>