blob: ca466cb26b4306a802bcca0a6d7553ff86cb0746 [file] [log] [blame]
yoshi-code-botad81f3d2021-09-28 00:22:30 -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_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> . <a href="dialogflow_v3.projects.locations.agents.environments.deployments.html">deployments</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
81 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
82<p class="firstline">Retrieves the specified Deployment.</p>
83<p class="toc_element">
84 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Returns the list of all deployments in the specified Environment.</p>
86<p class="toc_element">
87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<h3>Method Details</h3>
90<div class="method">
91 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93</div>
94
95<div class="method">
96 <code class="details" id="get">get(name, x__xgafv=None)</code>
97 <pre>Retrieves the specified Deployment.
98
99Args:
100 name: string, Required. The name of the Deployment. Format: `projects//locations//agents//environments//deployments/`. (required)
101 x__xgafv: string, V1 error format.
102 Allowed values
103 1 - v1 error format
104 2 - v2 error format
105
106Returns:
107 An object of the form:
108
109 { # Represents an deployment in an environment. A deployment happens when a flow version configured to be active in the environment. You can configure running pre-deployment steps, e.g. running validation test cases, experiment auto-rollout, etc.
110 &quot;endTime&quot;: &quot;A String&quot;, # End time of this deployment.
111 &quot;flowVersion&quot;: &quot;A String&quot;, # The name of the flow version for this deployment. Format: projects//locations//agents//flows//versions/.
112 &quot;name&quot;: &quot;A String&quot;, # The name of the deployment. Format: projects//locations//agents//environments//deployments/.
113 &quot;result&quot;: { # Result of the deployment. # Result of the deployment.
114 &quot;deploymentTestResults&quot;: [ # Results of test cases running before the deployment. Format: `projects//locations//agents//testCases//results/`.
115 &quot;A String&quot;,
116 ],
117 &quot;experiment&quot;: &quot;A String&quot;, # The name of the experiment triggered by this deployment. Format: projects//locations//agents//environments//experiments/.
118 },
119 &quot;startTime&quot;: &quot;A String&quot;, # Start time of this deployment.
120 &quot;state&quot;: &quot;A String&quot;, # The current state of the deployment.
121}</pre>
122</div>
123
124<div class="method">
125 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
126 <pre>Returns the list of all deployments in the specified Environment.
127
128Args:
129 parent: string, Required. The Environment to list all environments for. Format: `projects//locations//agents//environments/`. (required)
130 pageSize: integer, The maximum number of items to return in a single page. By default 20 and at most 100.
131 pageToken: string, The next_page_token value returned from a previous list request.
132 x__xgafv: string, V1 error format.
133 Allowed values
134 1 - v1 error format
135 2 - v2 error format
136
137Returns:
138 An object of the form:
139
140 { # The response message for Deployments.ListDeployments.
141 &quot;deployments&quot;: [ # The list of deployments. 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&#x27;t the last page.
142 { # Represents an deployment in an environment. A deployment happens when a flow version configured to be active in the environment. You can configure running pre-deployment steps, e.g. running validation test cases, experiment auto-rollout, etc.
143 &quot;endTime&quot;: &quot;A String&quot;, # End time of this deployment.
144 &quot;flowVersion&quot;: &quot;A String&quot;, # The name of the flow version for this deployment. Format: projects//locations//agents//flows//versions/.
145 &quot;name&quot;: &quot;A String&quot;, # The name of the deployment. Format: projects//locations//agents//environments//deployments/.
146 &quot;result&quot;: { # Result of the deployment. # Result of the deployment.
147 &quot;deploymentTestResults&quot;: [ # Results of test cases running before the deployment. Format: `projects//locations//agents//testCases//results/`.
148 &quot;A String&quot;,
149 ],
150 &quot;experiment&quot;: &quot;A String&quot;, # The name of the experiment triggered by this deployment. Format: projects//locations//agents//environments//experiments/.
151 },
152 &quot;startTime&quot;: &quot;A String&quot;, # Start time of this deployment.
153 &quot;state&quot;: &quot;A String&quot;, # The current state of the deployment.
154 },
155 ],
156 &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.
157}</pre>
158</div>
159
160<div class="method">
161 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
162 <pre>Retrieves the next page of results.
163
164Args:
165 previous_request: The request for the previous page. (required)
166 previous_response: The response from the request for the previous page. (required)
167
168Returns:
169 A request object that you can call &#x27;execute()&#x27; on to request the next
170 page. Returns None if there are no more items in the collection.
171 </pre>
172</div>
173
174</body></html>