blob: dc4b165706b3b492ef1e0b4188dc397cf06a0093 [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -07001<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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_v2.html">Dialogflow API</a> . <a href="dialogflow_v2.projects.html">projects</a> . <a href="dialogflow_v2.projects.agent.html">agent</a> . <a href="dialogflow_v2.projects.agent.environments.html">environments</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
yoshi-code-botb6dc1b92021-03-02 11:49:08 -080078 <code><a href="dialogflow_v2.projects.agent.environments.intents.html">intents()</a></code>
79</p>
80<p class="firstline">Returns the intents Resource.</p>
81
82<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -070083 <code><a href="dialogflow_v2.projects.agent.environments.users.html">users()</a></code>
84</p>
85<p class="firstline">Returns the users Resource.</p>
86
87<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070088 <code><a href="#close">close()</a></code></p>
89<p class="firstline">Close httplib2 connections.</p>
90<p class="toc_element">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -080091 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim65020912020-05-20 12:08:20 -070092<p class="firstline">Returns the list of all non-draft environments of the specified agent.</p>
93<p class="toc_element">
94 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
95<p class="firstline">Retrieves the next page of results.</p>
96<h3>Method Details</h3>
97<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070098 <code class="details" id="close">close()</code>
99 <pre>Close httplib2 connections.</pre>
100</div>
101
102<div class="method">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800103 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700104 <pre>Returns the list of all non-draft environments of the specified agent.
105
106Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700107 parent: string, Required. The agent to list all environments from. Format: `projects//agent`. (required)
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800108 pageSize: integer, Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800109 pageToken: string, Optional. The next_page_token value returned from a previous list request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700110 x__xgafv: string, V1 error format.
111 Allowed values
112 1 - v1 error format
113 2 - v2 error format
114
115Returns:
116 An object of the form:
117
118 { # The response message for Environments.ListEnvironments.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800119 &quot;environments&quot;: [ # The list of agent environments. There will be a maximum number of items returned based on the page_size field in the request.
120 { # 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. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).
121 &quot;agentVersion&quot;: &quot;A String&quot;, # Optional. The agent version loaded into this environment. Format: `projects//agent/versions/`.
122 &quot;description&quot;: &quot;A String&quot;, # Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected.
123 &quot;name&quot;: &quot;A String&quot;, # Output only. The unique identifier of this agent environment. Format: `projects//agent/environments/`. For Environment ID, &quot;-&quot; is reserved for &#x27;draft&#x27; environment.
124 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
125 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update time of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
126 },
127 ],
128 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no more results in the list.
129}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700130</div>
131
132<div class="method">
133 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
134 <pre>Retrieves the next page of results.
135
136Args:
137 previous_request: The request for the previous page. (required)
138 previous_response: The response from the request for the previous page. (required)
139
140Returns:
141 A request object that you can call &#x27;execute()&#x27; on to request the next
142 page. Returns None if there are no more items in the collection.
143 </pre>
144</div>
145
146</body></html>