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

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