Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a527de24cda7c7d62a371203158fd5f617a1c08c / . / docs / dyn / dialogflow_v2beta1.projects.agent.environments.html
blob: 3637f0c7b93b92b33ec432ed68c14874c9d7dfe0 [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 Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]83 <code><a href="#list">list(parent, pageSize=None, pageToken=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 Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]90 <code class="details" id="list">list(parent, pageSize=None, pageToken=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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]95Format:
96- `projects/&lt;Project Number / ID&gt;/agent`
97- `projects/&lt;Project Number / ID&gt;/locations/&lt;Location
98ID&gt;/agent (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]99 pageSize: integer, Optional. The maximum number of items to return in a single page. By default 100 and
100at most 1000.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]101 pageToken: string, Optional. The next_page_token value returned from a previous list request.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]102 x__xgafv: string, V1 error format.
103 Allowed values
104 1 - v1 error format
105 2 - v2 error format
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]106
107Returns:
108 An object of the form:
109
110 { # The response message for Environments.ListEnvironments.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]111 &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]112 # returned based on the page_size field in the request.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]113 { # You can create multiple versions of your agent and publish them to separate
114 # environments.
115 #
116 # When you edit an agent, you are editing the draft agent. At any point, you
117 # can save the draft agent as an agent version, which is an immutable snapshot
118 # of your agent.
119 #
120 # When you save the draft agent, it is published to the default environment.
121 # When you create agent versions, you can publish them to custom environments.
122 # You can create a variety of custom environments for:
123 #
124 # - testing
125 # - development
126 # - production
127 # - etc.
128 #
129 # For more information, see the [versions and environments
130 # guide](https://cloud.google.com/dialogflow/docs/agents-versions).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]131 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of this environment. This field is read-only, i.e., it cannot be
132 # set by create and update methods.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]133 &quot;description&quot;: &quot;A String&quot;, # Optional. The developer-provided description for this environment.
134 # The maximum length is 500 characters. If exceeded, the request is rejected.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]135 &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]136 # cannot be set by create and update methods.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]137 &quot;name&quot;: &quot;A String&quot;, # Output only. The unique identifier of this agent environment.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]138 # Format:
139 # - `projects/&lt;Project Number / ID&gt;/agent/environments/&lt;Environment ID&gt;`
140 # - `projects/&lt;Project Number / ID&gt;/locations/&lt;Location
141 # ID&gt;/agent/environments/&lt;Environment ID&gt;`
142 &quot;agentVersion&quot;: &quot;A String&quot;, # Optional. The agent version loaded into this environment.
143 # Format: `projects/&lt;Project ID&gt;/agent/versions/&lt;Version ID&gt;`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]144 },
145 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]146 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no
147 # more results in the list.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]148 }</pre>
149</div>
150
151<div class="method">
152 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
153 <pre>Retrieves the next page of results.
154
155Args:
156 previous_request: The request for the previous page. (required)
157 previous_response: The response from the request for the previous page. (required)
158
159Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]160 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]161 page. Returns None if there are no more items in the collection.
162 </pre>
163</div>
164
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]165</body></html>