Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c72efbc6b71c963997c5728d471c04ab33d95e4f / . / docs / dyn / dialogflow_v2beta1.projects.agent.environments.html
blob: d9c2c0fb9306061064e314f01dfc5dda042d1e8f [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<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_v2beta1.html">Dialogflow API</a> . <a href="dialogflow_v2beta1.projects.html">projects</a> . <a href="dialogflow_v2beta1.projects.agent.html">agent</a> . <a href="dialogflow_v2beta1.projects.agent.environments.html">environments</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="dialogflow_v2beta1.projects.agent.environments.users.html">users()</a></code>
79</p>
80<p class="firstline">Returns the users Resource.</p>
81
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]82<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]83 <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]84<p class="firstline">Returns the list of all non-draft environments of the specified agent.</p>
85<p class="toc_element">
86 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
87<p class="firstline">Retrieves the next page of results.</p>
88<h3>Method Details</h3>
89<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]90 <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]91 <pre>Returns the list of all non-draft environments of the specified agent.
92
93Args:
94 parent: string, Required. The agent to list all environments from.
95Format: `projects/&lt;Project ID&gt;/agent`. (required)
96 pageToken: string, Optional. The next_page_token value returned from a previous list request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]97 pageSize: integer, Optional. The maximum number of items to return in a single page. By default 100 and
98at most 1000.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]99 x__xgafv: string, V1 error format.
100 Allowed values
101 1 - v1 error format
102 2 - v2 error format
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]103
104Returns:
105 An object of the form:
106
107 { # The response message for Environments.ListEnvironments.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]108 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]109 # more results in the list.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]110 &quot;environments&quot;: [ # The list of agent environments. There will be a maximum number of items
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]111 # returned based on the page_size field in the request.
112 { # Represents an agent environment.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]113 &quot;agentVersion&quot;: &quot;A String&quot;, # Optional. The agent version loaded into this environment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]114 # Format: `projects/&lt;Project ID&gt;/agent/versions/&lt;Version ID&gt;`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]115 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of this environment. This field is read-only, i.e., it cannot be
116 # set by create and update methods.
117 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update time of this environment. This field is read-only, i.e., it
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]118 # cannot be set by create and update methods.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]119 &quot;name&quot;: &quot;A String&quot;, # Output only. The unique identifier of this agent environment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]120 # Format: `projects/&lt;Project ID&gt;/agent/environments/&lt;Environment ID&gt;`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]121 # For Environment ID, &quot;-&quot; is reserved for &#x27;draft&#x27; environment.
122 &quot;description&quot;: &quot;A String&quot;, # Optional. The developer-provided description for this environment.
123 # The maximum length is 500 characters. If exceeded, the request is rejected.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]124 },
125 ],
126 }</pre>
127</div>
128
129<div class="method">
130 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
131 <pre>Retrieves the next page of results.
132
133Args:
134 previous_request: The request for the previous page. (required)
135 previous_response: The response from the request for the previous page. (required)
136
137Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]138 A request object that you can call &#x27;execute()&#x27; on to request the next
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]139 page. Returns None if there are no more items in the collection.
140 </pre>
141</div>
142
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]143</body></html>