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

blob: 1b0e407c9272396bdead1b3313891dc124a1c3eb [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.environments.html">environments</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="dialogflow_v3beta1.projects.locations.agents.environments.sessions.html">sessions()</a></code>
				79	</p>
				80	<p class="firstline">Returns the sessions Resource.</p>
				81
				82	<p class="toc_element">
				83	<code><a href="#close">close()</a></code></p>
				84	<p class="firstline">Close httplib2 connections.</p>
				85	<p class="toc_element">
				86	<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
				87	<p class="firstline">Creates an Environment in the specified Agent.</p>
				88	<p class="toc_element">
				89	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
				90	<p class="firstline">Deletes the specified Environment.</p>
				91	<p class="toc_element">
				92	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
				93	<p class="firstline">Retrieves the specified Environment.</p>
				94	<p class="toc_element">
				95	<code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
				96	<p class="firstline">Returns the list of all environments in the specified Agent.</p>
				97	<p class="toc_element">
				98	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				99	<p class="firstline">Retrieves the next page of results.</p>
				100	<p class="toc_element">
				101	<code><a href="#lookupEnvironmentHistory">lookupEnvironmentHistory(name, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
				102	<p class="firstline">Looks up the history of the specified Environment.</p>
				103	<p class="toc_element">
				104	<code><a href="#lookupEnvironmentHistory_next">lookupEnvironmentHistory_next(previous_request, previous_response)</a></code></p>
				105	<p class="firstline">Retrieves the next page of results.</p>
				106	<p class="toc_element">
				107	<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
				108	<p class="firstline">Updates the specified Environment.</p>
				109	<h3>Method Details</h3>
				110	<div class="method">
				111	<code class="details" id="close">close()</code>
				112	<pre>Close httplib2 connections.</pre>
				113	</div>
				114
				115	<div class="method">
				116	<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
				117	<pre>Creates an Environment in the specified Agent.
				118
				119	Args:
				120	parent: string, Required. The Agent to create an Environment for. Format: `projects//locations//agents/`. (required)
				121	body: object, The request body.
				122	The object takes the form of:
				123
				124	{ # Represents an environment for an agent. You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for testing, development, production, etc.
				125	"versionConfigs": [ # Required. A list of configurations for flow versions. You should include version configs for all flows that are reachable from `Start Flow` in the agent. Otherwise, an error will be returned.
				126	{ # Configuration for the version.
				127	"version": "A String", # Required. Format: projects//locations//agents//flows//versions/.
				128	},
				129	],
				130	"updateTime": "A String", # Output only. Update time of this environment.
				131	"description": "A String", # The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.
				132	"displayName": "A String", # Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters.
				133	"name": "A String", # The name of the environment. Format: `projects//locations//agents//environments/`.
				134	}
				135
				136	x__xgafv: string, V1 error format.
				137	Allowed values
				138	1 - v1 error format
				139	2 - v2 error format
				140
				141	Returns:
				142	An object of the form:
				143
				144	{ # This resource represents a long-running operation that is the result of a network API call.
				145	"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
				146	"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
				147	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				148	"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
				149	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				150	{
				151	"a_key": "", # Properties of the object. Contains field @type with type URL.
				152	},
				153	],
				154	},
				155	"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
				156	"a_key": "", # Properties of the object. Contains field @type with type URL.
				157	},
				158	"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
				159	"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
				160	"a_key": "", # Properties of the object. Contains field @type with type URL.
				161	},
				162	}</pre>
				163	</div>
				164
				165	<div class="method">
				166	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
				167	<pre>Deletes the specified Environment.
				168
				169	Args:
				170	name: string, Required. The name of the Environment to delete. Format: `projects//locations//agents//environments/`. (required)
				171	x__xgafv: string, V1 error format.
				172	Allowed values
				173	1 - v1 error format
				174	2 - v2 error format
				175
				176	Returns:
				177	An object of the form:
				178
				179	{ # 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 `{}`.
				180	}</pre>
				181	</div>
				182
				183	<div class="method">
				184	<code class="details" id="get">get(name, x__xgafv=None)</code>
				185	<pre>Retrieves the specified Environment.
				186
				187	Args:
				188	name: string, Required. The name of the Environment. Format: `projects//locations//agents//environments/`. (required)
				189	x__xgafv: string, V1 error format.
				190	Allowed values
				191	1 - v1 error format
				192	2 - v2 error format
				193
				194	Returns:
				195	An object of the form:
				196
				197	{ # Represents an environment for an agent. You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for testing, development, production, etc.
				198	"versionConfigs": [ # Required. A list of configurations for flow versions. You should include version configs for all flows that are reachable from `Start Flow` in the agent. Otherwise, an error will be returned.
				199	{ # Configuration for the version.
				200	"version": "A String", # Required. Format: projects//locations//agents//flows//versions/.
				201	},
				202	],
				203	"updateTime": "A String", # Output only. Update time of this environment.
				204	"description": "A String", # The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.
				205	"displayName": "A String", # Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters.
				206	"name": "A String", # The name of the environment. Format: `projects//locations//agents//environments/`.
				207	}</pre>
				208	</div>
				209
				210	<div class="method">
				211	<code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
				212	<pre>Returns the list of all environments in the specified Agent.
				213
				214	Args:
				215	parent: string, Required. The Agent to list all environments for. Format: `projects//locations//agents/`. (required)
				216	pageToken: string, The next_page_token value returned from a previous list request.
				217	pageSize: integer, The maximum number of items to return in a single page. By default 20 and at most 100.
				218	x__xgafv: string, V1 error format.
				219	Allowed values
				220	1 - v1 error format
				221	2 - v2 error format
				222
				223	Returns:
				224	An object of the form:
				225
				226	{ # The response message for Environments.ListEnvironments.
				227	"environments": [ # The list of environments. There will be a maximum number of items returned based on the page_size field in the request. The list may in some cases be empty or contain fewer entries than page_size even if this isn't the last page.
				228	{ # Represents an environment for an agent. You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for testing, development, production, etc.
				229	"versionConfigs": [ # Required. A list of configurations for flow versions. You should include version configs for all flows that are reachable from `Start Flow` in the agent. Otherwise, an error will be returned.
				230	{ # Configuration for the version.
				231	"version": "A String", # Required. Format: projects//locations//agents//flows//versions/.
				232	},
				233	],
				234	"updateTime": "A String", # Output only. Update time of this environment.
				235	"description": "A String", # The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.
				236	"displayName": "A String", # Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters.
				237	"name": "A String", # The name of the environment. Format: `projects//locations//agents//environments/`.
				238	},
				239	],
				240	"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
				241	}</pre>
				242	</div>
				243
				244	<div class="method">
				245	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				246	<pre>Retrieves the next page of results.
				247
				248	Args:
				249	previous_request: The request for the previous page. (required)
				250	previous_response: The response from the request for the previous page. (required)
				251
				252	Returns:
				253	A request object that you can call 'execute()' on to request the next
				254	page. Returns None if there are no more items in the collection.
				255	</pre>
				256	</div>
				257
				258	<div class="method">
				259	<code class="details" id="lookupEnvironmentHistory">lookupEnvironmentHistory(name, pageToken=None, pageSize=None, x__xgafv=None)</code>
				260	<pre>Looks up the history of the specified Environment.
				261
				262	Args:
				263	name: string, Required. Resource name of the environment to look up the history for. Format: `projects//locations//agents//environments/`. (required)
				264	pageToken: string, The next_page_token value returned from a previous list request.
				265	pageSize: integer, The maximum number of items to return in a single page. By default 100 and at most 1000.
				266	x__xgafv: string, V1 error format.
				267	Allowed values
				268	1 - v1 error format
				269	2 - v2 error format
				270
				271	Returns:
				272	An object of the form:
				273
				274	{ # The response message for Environments.LookupEnvironmentHistory.
				275	"environments": [ # Represents a list of snapshots for an environment. Time of the snapshots is stored in `update_time`.
				276	{ # Represents an environment for an agent. You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for testing, development, production, etc.
				277	"versionConfigs": [ # Required. A list of configurations for flow versions. You should include version configs for all flows that are reachable from `Start Flow` in the agent. Otherwise, an error will be returned.
				278	{ # Configuration for the version.
				279	"version": "A String", # Required. Format: projects//locations//agents//flows//versions/.
				280	},
				281	],
				282	"updateTime": "A String", # Output only. Update time of this environment.
				283	"description": "A String", # The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.
				284	"displayName": "A String", # Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters.
				285	"name": "A String", # The name of the environment. Format: `projects//locations//agents//environments/`.
				286	},
				287	],
				288	"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
				289	}</pre>
				290	</div>
				291
				292	<div class="method">
				293	<code class="details" id="lookupEnvironmentHistory_next">lookupEnvironmentHistory_next(previous_request, previous_response)</code>
				294	<pre>Retrieves the next page of results.
				295
				296	Args:
				297	previous_request: The request for the previous page. (required)
				298	previous_response: The response from the request for the previous page. (required)
				299
				300	Returns:
				301	A request object that you can call 'execute()' on to request the next
				302	page. Returns None if there are no more items in the collection.
				303	</pre>
				304	</div>
				305
				306	<div class="method">
				307	<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
				308	<pre>Updates the specified Environment.
				309
				310	Args:
				311	name: string, The name of the environment. Format: `projects//locations//agents//environments/`. (required)
				312	body: object, The request body.
				313	The object takes the form of:
				314
				315	{ # Represents an environment for an agent. You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for testing, development, production, etc.
				316	"versionConfigs": [ # Required. A list of configurations for flow versions. You should include version configs for all flows that are reachable from `Start Flow` in the agent. Otherwise, an error will be returned.
				317	{ # Configuration for the version.
				318	"version": "A String", # Required. Format: projects//locations//agents//flows//versions/.
				319	},
				320	],
				321	"updateTime": "A String", # Output only. Update time of this environment.
				322	"description": "A String", # The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.
				323	"displayName": "A String", # Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters.
				324	"name": "A String", # The name of the environment. Format: `projects//locations//agents//environments/`.
				325	}
				326
				327	updateMask: string, Required. The mask to control which fields get updated.
				328	x__xgafv: string, V1 error format.
				329	Allowed values
				330	1 - v1 error format
				331	2 - v2 error format
				332
				333	Returns:
				334	An object of the form:
				335
				336	{ # This resource represents a long-running operation that is the result of a network API call.
				337	"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
				338	"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
				339	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				340	"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
				341	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				342	{
				343	"a_key": "", # Properties of the object. Contains field @type with type URL.
				344	},
				345	],
				346	},
				347	"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
				348	"a_key": "", # Properties of the object. Contains field @type with type URL.
				349	},
				350	"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
				351	"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
				352	"a_key": "", # Properties of the object. Contains field @type with type URL.
				353	},
				354	}</pre>
				355	</div>
				356
				357	</body></html>