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

blob: dbf5087bcec357f6fdcfcdbfb2df4ec966f90106 [file] [log] [blame]

Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[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.agents.html">agents</a> . <a href="dialogflow_v3beta1.projects.locations.agents.webhooks.html">webhooks</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">Creates a webhook in the specified agent.</p>
				83	<p class="toc_element">
				84	<code><a href="#delete">delete(name, force=None, x__xgafv=None)</a></code></p>
				85	<p class="firstline">Deletes the specified webhook.</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 webhook.</p>
				89	<p class="toc_element">
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	90	<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	91	<p class="firstline">Returns the list of all webhooks in the specified agent.</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 webhook.</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>Creates a webhook in the specified agent.
				107
				108	Args:
				109	parent: string, Required. The agent to create a webhook for. Format: `projects//locations//agents/`. (required)
				110	body: object, The request body.
				111	The object takes the form of:
				112
				113	{ # Webhooks host the developer's business logic. During a session, webhooks allow the developer to use the data extracted by Dialogflow's natural language processing to generate dynamic responses, validate collected data, or trigger actions on the backend.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	114	"displayName": "A String", # Required. The human-readable name of the webhook, unique within the agent.
				115	"disabled": True or False, # Indicates whether the webhook is disabled.
				116	"name": "A String", # The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: `projects//locations//agents//webhooks/`.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	117	"genericWebService": { # Represents configuration for a generic web service. # Configuration for a generic web service.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	118	"password": "A String", # The password for HTTP Basic authentication.
				119	"uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	120	"requestHeaders": { # The HTTP request headers to send together with webhook requests.
				121	"a_key": "A String",
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	122	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	123	"username": "A String", # The user name for HTTP Basic authentication.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	124	},
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	125	"timeout": "A String", # Webhook execution timeout. Execution is considered failed if Dialogflow doesn't receive a response from webhook at the end of the timeout period. Defaults to 5 seconds, maximum allowed timeout is 30 seconds.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	126	}
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	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	{ # Webhooks host the developer's business logic. During a session, webhooks allow the developer to use the data extracted by Dialogflow's natural language processing to generate dynamic responses, validate collected data, or trigger actions on the backend.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	137	"displayName": "A String", # Required. The human-readable name of the webhook, unique within the agent.
				138	"disabled": True or False, # Indicates whether the webhook is disabled.
				139	"name": "A String", # The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: `projects//locations//agents//webhooks/`.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	140	"genericWebService": { # Represents configuration for a generic web service. # Configuration for a generic web service.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	141	"password": "A String", # The password for HTTP Basic authentication.
				142	"uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	143	"requestHeaders": { # The HTTP request headers to send together with webhook requests.
				144	"a_key": "A String",
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	145	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	146	"username": "A String", # The user name for HTTP Basic authentication.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	147	},
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	148	"timeout": "A String", # Webhook execution timeout. Execution is considered failed if Dialogflow doesn't receive a response from webhook at the end of the timeout period. Defaults to 5 seconds, maximum allowed timeout is 30 seconds.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	149	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	150	</div>
				151
				152	<div class="method">
				153	<code class="details" id="delete">delete(name, force=None, x__xgafv=None)</code>
				154	<pre>Deletes the specified webhook.
				155
				156	Args:
				157	name: string, Required. The name of the webhook to delete. Format: `projects//locations//agents//webhooks/`. (required)
				158	force: boolean, This field has no effect for webhook not being used. For webhooks that are used by pages/flows/transition route groups: * If `force` is set to false, an error will be returned with message indicating the referenced resources. * If `force` is set to true, Dialogflow will remove the webhook, as well as any references to the webhook (i.e. Webhook and tagin fulfillments that point to this webhook will be removed).
				159	x__xgafv: string, V1 error format.
				160	Allowed values
				161	1 - v1 error format
				162	2 - v2 error format
				163
				164	Returns:
				165	An object of the form:
				166
				167	{ # 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 `{}`.
				168	}</pre>
				169	</div>
				170
				171	<div class="method">
				172	<code class="details" id="get">get(name, x__xgafv=None)</code>
				173	<pre>Retrieves the specified webhook.
				174
				175	Args:
				176	name: string, Required. The name of the webhook. Format: `projects//locations//agents//webhooks/`. (required)
				177	x__xgafv: string, V1 error format.
				178	Allowed values
				179	1 - v1 error format
				180	2 - v2 error format
				181
				182	Returns:
				183	An object of the form:
				184
				185	{ # Webhooks host the developer's business logic. During a session, webhooks allow the developer to use the data extracted by Dialogflow's natural language processing to generate dynamic responses, validate collected data, or trigger actions on the backend.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	186	"displayName": "A String", # Required. The human-readable name of the webhook, unique within the agent.
				187	"disabled": True or False, # Indicates whether the webhook is disabled.
				188	"name": "A String", # The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: `projects//locations//agents//webhooks/`.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	189	"genericWebService": { # Represents configuration for a generic web service. # Configuration for a generic web service.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	190	"password": "A String", # The password for HTTP Basic authentication.
				191	"uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	192	"requestHeaders": { # The HTTP request headers to send together with webhook requests.
				193	"a_key": "A String",
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	194	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	195	"username": "A String", # The user name for HTTP Basic authentication.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	196	},
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	197	"timeout": "A String", # Webhook execution timeout. Execution is considered failed if Dialogflow doesn't receive a response from webhook at the end of the timeout period. Defaults to 5 seconds, maximum allowed timeout is 30 seconds.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	198	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	199	</div>
				200
				201	<div class="method">
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	202	<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	203	<pre>Returns the list of all webhooks in the specified agent.
				204
				205	Args:
				206	parent: string, Required. The agent to list all webhooks for. Format: `projects//locations//agents/`. (required)
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	207	pageSize: integer, The maximum number of items to return in a single page. By default 100 and at most 1000.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	208	pageToken: string, The next_page_token value returned from a previous list request.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	209	x__xgafv: string, V1 error format.
				210	Allowed values
				211	1 - v1 error format
				212	2 - v2 error format
				213
				214	Returns:
				215	An object of the form:
				216
				217	{ # The response message for Webhooks.ListWebhooks.
				218	"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
				219	"webhooks": [ # The list of webhooks. There will be a maximum number of items returned based on the page_size field in the request.
				220	{ # Webhooks host the developer's business logic. During a session, webhooks allow the developer to use the data extracted by Dialogflow's natural language processing to generate dynamic responses, validate collected data, or trigger actions on the backend.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	221	"displayName": "A String", # Required. The human-readable name of the webhook, unique within the agent.
				222	"disabled": True or False, # Indicates whether the webhook is disabled.
				223	"name": "A String", # The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: `projects//locations//agents//webhooks/`.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	224	"genericWebService": { # Represents configuration for a generic web service. # Configuration for a generic web service.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	225	"password": "A String", # The password for HTTP Basic authentication.
				226	"uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	227	"requestHeaders": { # The HTTP request headers to send together with webhook requests.
				228	"a_key": "A String",
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	229	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	230	"username": "A String", # The user name for HTTP Basic authentication.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	231	},
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	232	"timeout": "A String", # Webhook execution timeout. Execution is considered failed if Dialogflow doesn't receive a response from webhook at the end of the timeout period. Defaults to 5 seconds, maximum allowed timeout is 30 seconds.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	233	},
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	234	],
				235	}</pre>
				236	</div>
				237
				238	<div class="method">
				239	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				240	<pre>Retrieves the next page of results.
				241
				242	Args:
				243	previous_request: The request for the previous page. (required)
				244	previous_response: The response from the request for the previous page. (required)
				245
				246	Returns:
				247	A request object that you can call 'execute()' on to request the next
				248	page. Returns None if there are no more items in the collection.
				249	</pre>
				250	</div>
				251
				252	<div class="method">
				253	<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
				254	<pre>Updates the specified webhook.
				255
				256	Args:
				257	name: string, The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: `projects//locations//agents//webhooks/`. (required)
				258	body: object, The request body.
				259	The object takes the form of:
				260
				261	{ # Webhooks host the developer's business logic. During a session, webhooks allow the developer to use the data extracted by Dialogflow's natural language processing to generate dynamic responses, validate collected data, or trigger actions on the backend.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	262	"displayName": "A String", # Required. The human-readable name of the webhook, unique within the agent.
				263	"disabled": True or False, # Indicates whether the webhook is disabled.
				264	"name": "A String", # The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: `projects//locations//agents//webhooks/`.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	265	"genericWebService": { # Represents configuration for a generic web service. # Configuration for a generic web service.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	266	"password": "A String", # The password for HTTP Basic authentication.
				267	"uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	268	"requestHeaders": { # The HTTP request headers to send together with webhook requests.
				269	"a_key": "A String",
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	270	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	271	"username": "A String", # The user name for HTTP Basic authentication.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	272	},
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	273	"timeout": "A String", # Webhook execution timeout. Execution is considered failed if Dialogflow doesn't receive a response from webhook at the end of the timeout period. Defaults to 5 seconds, maximum allowed timeout is 30 seconds.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	274	}
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	275
				276	updateMask: string, The mask to control which fields get updated. If the mask is not present, all fields will be updated.
				277	x__xgafv: string, V1 error format.
				278	Allowed values
				279	1 - v1 error format
				280	2 - v2 error format
				281
				282	Returns:
				283	An object of the form:
				284
				285	{ # Webhooks host the developer's business logic. During a session, webhooks allow the developer to use the data extracted by Dialogflow's natural language processing to generate dynamic responses, validate collected data, or trigger actions on the backend.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	286	"displayName": "A String", # Required. The human-readable name of the webhook, unique within the agent.
				287	"disabled": True or False, # Indicates whether the webhook is disabled.
				288	"name": "A String", # The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: `projects//locations//agents//webhooks/`.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	289	"genericWebService": { # Represents configuration for a generic web service. # Configuration for a generic web service.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	290	"password": "A String", # The password for HTTP Basic authentication.
				291	"uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	292	"requestHeaders": { # The HTTP request headers to send together with webhook requests.
				293	"a_key": "A String",
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	294	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	295	"username": "A String", # The user name for HTTP Basic authentication.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	296	},
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	297	"timeout": "A String", # Webhook execution timeout. Execution is considered failed if Dialogflow doesn't receive a response from webhook at the end of the timeout period. Defaults to 5 seconds, maximum allowed timeout is 30 seconds.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	298	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	299	</div>
				300
				301	</body></html>