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

blob: 2d6fce441ab3a3c0ad9733d32132b68f22f551f1 [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_v3.html">Dialogflow API</a> . <a href="dialogflow_v3.projects.html">projects</a> . <a href="dialogflow_v3.projects.locations.html">locations</a> . <a href="dialogflow_v3.projects.locations.agents.html">agents</a> . <a href="dialogflow_v3.projects.locations.agents.environments.html">environments</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="dialogflow_v3.projects.locations.agents.environments.experiments.html">experiments()</a></code>
				79	</p>
				80	<p class="firstline">Returns the experiments Resource.</p>
				81
				82	<p class="toc_element">
				83	<code><a href="dialogflow_v3.projects.locations.agents.environments.sessions.html">sessions()</a></code>
				84	</p>
				85	<p class="firstline">Returns the sessions Resource.</p>
				86
				87	<p class="toc_element">
				88	<code><a href="#close">close()</a></code></p>
				89	<p class="firstline">Close httplib2 connections.</p>
				90	<p class="toc_element">
				91	<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
				92	<p class="firstline">Creates an Environment in the specified Agent.</p>
				93	<p class="toc_element">
				94	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
				95	<p class="firstline">Deletes the specified Environment.</p>
				96	<p class="toc_element">
				97	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
				98	<p class="firstline">Retrieves the specified Environment.</p>
				99	<p class="toc_element">
				100	<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
				101	<p class="firstline">Returns the list of all environments in the specified Agent.</p>
				102	<p class="toc_element">
				103	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				104	<p class="firstline">Retrieves the next page of results.</p>
				105	<p class="toc_element">
				106	<code><a href="#lookupEnvironmentHistory">lookupEnvironmentHistory(name, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
				107	<p class="firstline">Looks up the history of the specified Environment.</p>
				108	<p class="toc_element">
				109	<code><a href="#lookupEnvironmentHistory_next">lookupEnvironmentHistory_next(previous_request, previous_response)</a></code></p>
				110	<p class="firstline">Retrieves the next page of results.</p>
				111	<p class="toc_element">
				112	<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
				113	<p class="firstline">Updates the specified Environment.</p>
				114	<h3>Method Details</h3>
				115	<div class="method">
				116	<code class="details" id="close">close()</code>
				117	<pre>Close httplib2 connections.</pre>
				118	</div>
				119
				120	<div class="method">
				121	<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
				122	<pre>Creates an Environment in the specified Agent.
				123
				124	Args:
				125	parent: string, Required. The Agent to create an Environment for. Format: `projects//locations//agents/`. (required)
				126	body: object, The request body.
				127	The object takes the form of:
				128
				129	{ # 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.
				130	"description": "A String", # The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.
				131	"displayName": "A String", # Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters.
				132	"name": "A String", # The name of the environment. Format: `projects//locations//agents//environments/`.
				133	"updateTime": "A String", # Output only. Update time of this environment.
				134	"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.
				135	{ # Configuration for the version.
				136	"version": "A String", # Required. Format: projects//locations//agents//flows//versions/.
				137	},
				138	],
				139	}
				140
				141	x__xgafv: string, V1 error format.
				142	Allowed values
				143	1 - v1 error format
				144	2 - v2 error format
				145
				146	Returns:
				147	An object of the form:
				148
				149	{ # This resource represents a long-running operation that is the result of a network API call.
				150	"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.
				151	"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.
				152	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				153	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				154	{
				155	"a_key": "", # Properties of the object. Contains field @type with type URL.
				156	},
				157	],
				158	"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.
				159	},
				160	"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.
				161	"a_key": "", # Properties of the object. Contains field @type with type URL.
				162	},
				163	"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}`.
				164	"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`.
				165	"a_key": "", # Properties of the object. Contains field @type with type URL.
				166	},
				167	}</pre>
				168	</div>
				169
				170	<div class="method">
				171	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
				172	<pre>Deletes the specified Environment.
				173
				174	Args:
				175	name: string, Required. The name of the Environment to delete. Format: `projects//locations//agents//environments/`. (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	{ # 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 `{}`.
				185	}</pre>
				186	</div>
				187
				188	<div class="method">
				189	<code class="details" id="get">get(name, x__xgafv=None)</code>
				190	<pre>Retrieves the specified Environment.
				191
				192	Args:
				193	name: string, Required. The name of the Environment. Format: `projects//locations//agents//environments/`. (required)
				194	x__xgafv: string, V1 error format.
				195	Allowed values
				196	1 - v1 error format
				197	2 - v2 error format
				198
				199	Returns:
				200	An object of the form:
				201
				202	{ # 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.
				203	"description": "A String", # The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.
				204	"displayName": "A String", # Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters.
				205	"name": "A String", # The name of the environment. Format: `projects//locations//agents//environments/`.
				206	"updateTime": "A String", # Output only. Update time of this environment.
				207	"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.
				208	{ # Configuration for the version.
				209	"version": "A String", # Required. Format: projects//locations//agents//flows//versions/.
				210	},
				211	],
				212	}</pre>
				213	</div>
				214
				215	<div class="method">
				216	<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
				217	<pre>Returns the list of all environments in the specified Agent.
				218
				219	Args:
				220	parent: string, Required. The Agent to list all environments for. Format: `projects//locations//agents/`. (required)
				221	pageSize: integer, The maximum number of items to return in a single page. By default 20 and at most 100.
				222	pageToken: string, The next_page_token value returned from a previous list request.
				223	x__xgafv: string, V1 error format.
				224	Allowed values
				225	1 - v1 error format
				226	2 - v2 error format
				227
				228	Returns:
				229	An object of the form:
				230
				231	{ # The response message for Environments.ListEnvironments.
				232	"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.
				233	{ # 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.
				234	"description": "A String", # The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.
				235	"displayName": "A String", # Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters.
				236	"name": "A String", # The name of the environment. Format: `projects//locations//agents//environments/`.
				237	"updateTime": "A String", # Output only. Update time of this environment.
				238	"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.
				239	{ # Configuration for the version.
				240	"version": "A String", # Required. Format: projects//locations//agents//flows//versions/.
				241	},
				242	],
				243	},
				244	],
				245	"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
				246	}</pre>
				247	</div>
				248
				249	<div class="method">
				250	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				251	<pre>Retrieves the next page of results.
				252
				253	Args:
				254	previous_request: The request for the previous page. (required)
				255	previous_response: The response from the request for the previous page. (required)
				256
				257	Returns:
				258	A request object that you can call 'execute()' on to request the next
				259	page. Returns None if there are no more items in the collection.
				260	</pre>
				261	</div>
				262
				263	<div class="method">
				264	<code class="details" id="lookupEnvironmentHistory">lookupEnvironmentHistory(name, pageSize=None, pageToken=None, x__xgafv=None)</code>
				265	<pre>Looks up the history of the specified Environment.
				266
				267	Args:
				268	name: string, Required. Resource name of the environment to look up the history for. Format: `projects//locations//agents//environments/`. (required)
				269	pageSize: integer, The maximum number of items to return in a single page. By default 100 and at most 1000.
				270	pageToken: string, The next_page_token value returned from a previous list request.
				271	x__xgafv: string, V1 error format.
				272	Allowed values
				273	1 - v1 error format
				274	2 - v2 error format
				275
				276	Returns:
				277	An object of the form:
				278
				279	{ # The response message for Environments.LookupEnvironmentHistory.
				280	"environments": [ # Represents a list of snapshots for an environment. Time of the snapshots is stored in `update_time`.
				281	{ # 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.
				282	"description": "A String", # The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.
				283	"displayName": "A String", # Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters.
				284	"name": "A String", # The name of the environment. Format: `projects//locations//agents//environments/`.
				285	"updateTime": "A String", # Output only. Update time of this environment.
				286	"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.
				287	{ # Configuration for the version.
				288	"version": "A String", # Required. Format: projects//locations//agents//flows//versions/.
				289	},
				290	],
				291	},
				292	],
				293	"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
				294	}</pre>
				295	</div>
				296
				297	<div class="method">
				298	<code class="details" id="lookupEnvironmentHistory_next">lookupEnvironmentHistory_next(previous_request, previous_response)</code>
				299	<pre>Retrieves the next page of results.
				300
				301	Args:
				302	previous_request: The request for the previous page. (required)
				303	previous_response: The response from the request for the previous page. (required)
				304
				305	Returns:
				306	A request object that you can call 'execute()' on to request the next
				307	page. Returns None if there are no more items in the collection.
				308	</pre>
				309	</div>
				310
				311	<div class="method">
				312	<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
				313	<pre>Updates the specified Environment.
				314
				315	Args:
				316	name: string, The name of the environment. Format: `projects//locations//agents//environments/`. (required)
				317	body: object, The request body.
				318	The object takes the form of:
				319
				320	{ # 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.
				321	"description": "A String", # The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.
				322	"displayName": "A String", # Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters.
				323	"name": "A String", # The name of the environment. Format: `projects//locations//agents//environments/`.
				324	"updateTime": "A String", # Output only. Update time of this environment.
				325	"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.
				326	{ # Configuration for the version.
				327	"version": "A String", # Required. Format: projects//locations//agents//flows//versions/.
				328	},
				329	],
				330	}
				331
				332	updateMask: string, Required. The mask to control which fields get updated.
				333	x__xgafv: string, V1 error format.
				334	Allowed values
				335	1 - v1 error format
				336	2 - v2 error format
				337
				338	Returns:
				339	An object of the form:
				340
				341	{ # This resource represents a long-running operation that is the result of a network API call.
				342	"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.
				343	"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.
				344	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				345	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				346	{
				347	"a_key": "", # Properties of the object. Contains field @type with type URL.
				348	},
				349	],
				350	"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.
				351	},
				352	"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.
				353	"a_key": "", # Properties of the object. Contains field @type with type URL.
				354	},
				355	"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}`.
				356	"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`.
				357	"a_key": "", # Properties of the object. Contains field @type with type URL.
				358	},
				359	}</pre>
				360	</div>
				361
				362	</body></html>