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

blob: 2da4dba7e8262d9af86be51f2696efee0ff3e910 [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	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame^]	115	"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]	116	"name": "A String", # Required. Resource name of the settings. Format: `projects//locations//securitySettings/`.
				117	"purgeDataTypes": [ # List of types of data to remove when retention settings triggers purge.
				118	"A String",
				119	],
yoshi-code-bot	7700bbf	2021-05-20 04:44:03 -0700	[diff] [blame]	120	"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]	121	"redactionStrategy": "A String", # Strategy that defines how we do redaction.
yoshi-code-bot	7700bbf	2021-05-20 04:44:03 -0700	[diff] [blame]	122	"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]	123	}
				124
				125	x__xgafv: string, V1 error format.
				126	Allowed values
				127	1 - v1 error format
				128	2 - v2 error format
				129
				130	Returns:
				131	An object of the form:
				132
				133	{ # 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.
				134	"displayName": "A String", # Required. The human-readable name of the security settings, unique within the location.
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame^]	135	"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]	136	"name": "A String", # Required. Resource name of the settings. Format: `projects//locations//securitySettings/`.
				137	"purgeDataTypes": [ # List of types of data to remove when retention settings triggers purge.
				138	"A String",
				139	],
yoshi-code-bot	7700bbf	2021-05-20 04:44:03 -0700	[diff] [blame]	140	"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]	141	"redactionStrategy": "A String", # Strategy that defines how we do redaction.
yoshi-code-bot	7700bbf	2021-05-20 04:44:03 -0700	[diff] [blame]	142	"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]	143	}</pre>
				144	</div>
				145
				146	<div class="method">
				147	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
				148	<pre>Deletes the specified SecuritySettings.
				149
				150	Args:
				151	name: string, Required. The name of the SecuritySettings to delete. Format: `projects//locations//securitySettings/`. (required)
				152	x__xgafv: string, V1 error format.
				153	Allowed values
				154	1 - v1 error format
				155	2 - v2 error format
				156
				157	Returns:
				158	An object of the form:
				159
				160	{ # 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 `{}`.
				161	}</pre>
				162	</div>
				163
				164	<div class="method">
				165	<code class="details" id="get">get(name, x__xgafv=None)</code>
				166	<pre>Retrieves the specified SecuritySettings. The returned settings may be stale by up to 1 minute.
				167
				168	Args:
				169	name: string, Required. Resource name of the settings. Format: `projects//locations//securitySettings/`. (required)
				170	x__xgafv: string, V1 error format.
				171	Allowed values
				172	1 - v1 error format
				173	2 - v2 error format
				174
				175	Returns:
				176	An object of the form:
				177
				178	{ # 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.
				179	"displayName": "A String", # Required. The human-readable name of the security settings, unique within the location.
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame^]	180	"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]	181	"name": "A String", # Required. Resource name of the settings. Format: `projects//locations//securitySettings/`.
				182	"purgeDataTypes": [ # List of types of data to remove when retention settings triggers purge.
				183	"A String",
				184	],
yoshi-code-bot	7700bbf	2021-05-20 04:44:03 -0700	[diff] [blame]	185	"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]	186	"redactionStrategy": "A String", # Strategy that defines how we do redaction.
yoshi-code-bot	7700bbf	2021-05-20 04:44:03 -0700	[diff] [blame]	187	"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]	188	}</pre>
				189	</div>
				190
				191	<div class="method">
				192	<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
				193	<pre>Returns the list of all security settings in the specified location.
				194
				195	Args:
				196	parent: string, Required. The location to list all security settings for. Format: `projects//locations/`. (required)
				197	pageSize: integer, The maximum number of items to return in a single page. By default 20 and at most 100.
				198	pageToken: string, The next_page_token value returned from a previous list request.
				199	x__xgafv: string, V1 error format.
				200	Allowed values
				201	1 - v1 error format
				202	2 - v2 error format
				203
				204	Returns:
				205	An object of the form:
				206
				207	{ # The response message for SecuritySettings.ListSecuritySettings.
				208	"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
				209	"securitySettings": [ # The list of security settings.
				210	{ # 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.
				211	"displayName": "A String", # Required. The human-readable name of the security settings, unique within the location.
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame^]	212	"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]	213	"name": "A String", # Required. Resource name of the settings. Format: `projects//locations//securitySettings/`.
				214	"purgeDataTypes": [ # List of types of data to remove when retention settings triggers purge.
				215	"A String",
				216	],
yoshi-code-bot	7700bbf	2021-05-20 04:44:03 -0700	[diff] [blame]	217	"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]	218	"redactionStrategy": "A String", # Strategy that defines how we do redaction.
yoshi-code-bot	7700bbf	2021-05-20 04:44:03 -0700	[diff] [blame]	219	"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]	220	},
				221	],
				222	}</pre>
				223	</div>
				224
				225	<div class="method">
				226	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				227	<pre>Retrieves the next page of results.
				228
				229	Args:
				230	previous_request: The request for the previous page. (required)
				231	previous_response: The response from the request for the previous page. (required)
				232
				233	Returns:
				234	A request object that you can call 'execute()' on to request the next
				235	page. Returns None if there are no more items in the collection.
				236	</pre>
				237	</div>
				238
				239	<div class="method">
				240	<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
				241	<pre>Updates the specified SecuritySettings.
				242
				243	Args:
				244	name: string, Required. Resource name of the settings. Format: `projects//locations//securitySettings/`. (required)
				245	body: object, The request body.
				246	The object takes the form of:
				247
				248	{ # 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.
				249	"displayName": "A String", # Required. The human-readable name of the security settings, unique within the location.
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame^]	250	"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]	251	"name": "A String", # Required. Resource name of the settings. Format: `projects//locations//securitySettings/`.
				252	"purgeDataTypes": [ # List of types of data to remove when retention settings triggers purge.
				253	"A String",
				254	],
yoshi-code-bot	7700bbf	2021-05-20 04:44:03 -0700	[diff] [blame]	255	"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]	256	"redactionStrategy": "A String", # Strategy that defines how we do redaction.
yoshi-code-bot	7700bbf	2021-05-20 04:44:03 -0700	[diff] [blame]	257	"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]	258	}
				259
				260	updateMask: string, Required. The mask to control which fields get updated. If the mask is not present, all fields will be updated.
				261	x__xgafv: string, V1 error format.
				262	Allowed values
				263	1 - v1 error format
				264	2 - v2 error format
				265
				266	Returns:
				267	An object of the form:
				268
				269	{ # 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.
				270	"displayName": "A String", # Required. The human-readable name of the security settings, unique within the location.
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame^]	271	"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]	272	"name": "A String", # Required. Resource name of the settings. Format: `projects//locations//securitySettings/`.
				273	"purgeDataTypes": [ # List of types of data to remove when retention settings triggers purge.
				274	"A String",
				275	],
yoshi-code-bot	7700bbf	2021-05-20 04:44:03 -0700	[diff] [blame]	276	"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]	277	"redactionStrategy": "A String", # Strategy that defines how we do redaction.
yoshi-code-bot	7700bbf	2021-05-20 04:44:03 -0700	[diff] [blame]	278	"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]	279	}</pre>
				280	</div>
				281
				282	</body></html>