blob: 0c253617a417cc55b119b29b8c004789fd9e9ad3 [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="dialogflow_v3beta1.html">Dialogflow API</a> . <a href="dialogflow_v3beta1.projects.html">projects</a> . <a href="dialogflow_v3beta1.projects.locations.html">locations</a> . <a href="dialogflow_v3beta1.projects.locations.agents.html">agents</a> . <a href="dialogflow_v3beta1.projects.locations.agents.environments.html">environments</a> . <a href="dialogflow_v3beta1.projects.locations.agents.environments.deployments.html">deployments</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves the specified Deployment.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the list of all deployments in the specified Environment.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Retrieves the specified Deployment.
Args:
name: string, Required. The name of the Deployment. Format: `projects//locations//agents//environments//deployments/`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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.
&quot;endTime&quot;: &quot;A String&quot;, # End time of this deployment.
&quot;flowVersion&quot;: &quot;A String&quot;, # The name of the flow version for this deployment. Format: projects//locations//agents//flows//versions/.
&quot;name&quot;: &quot;A String&quot;, # The name of the deployment. Format: projects//locations//agents//environments//deployments/.
&quot;result&quot;: { # Result of the deployment. # Result of the deployment.
&quot;deploymentTestResults&quot;: [ # Results of test cases running before the deployment. Format: `projects//locations//agents//testCases//results/`.
&quot;A String&quot;,
],
&quot;experiment&quot;: &quot;A String&quot;, # The name of the experiment triggered by this deployment. Format: projects//locations//agents//environments//experiments/.
},
&quot;startTime&quot;: &quot;A String&quot;, # Start time of this deployment.
&quot;state&quot;: &quot;A String&quot;, # The current state of the deployment.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Returns the list of all deployments in the specified Environment.
Args:
parent: string, Required. The Environment to list all environments for. Format: `projects//locations//agents//environments/`. (required)
pageSize: integer, The maximum number of items to return in a single page. By default 20 and at most 100.
pageToken: string, The next_page_token value returned from a previous list request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response message for Deployments.ListDeployments.
&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.
{ # 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.
&quot;endTime&quot;: &quot;A String&quot;, # End time of this deployment.
&quot;flowVersion&quot;: &quot;A String&quot;, # The name of the flow version for this deployment. Format: projects//locations//agents//flows//versions/.
&quot;name&quot;: &quot;A String&quot;, # The name of the deployment. Format: projects//locations//agents//environments//deployments/.
&quot;result&quot;: { # Result of the deployment. # Result of the deployment.
&quot;deploymentTestResults&quot;: [ # Results of test cases running before the deployment. Format: `projects//locations//agents//testCases//results/`.
&quot;A String&quot;,
],
&quot;experiment&quot;: &quot;A String&quot;, # The name of the experiment triggered by this deployment. Format: projects//locations//agents//environments//experiments/.
},
&quot;startTime&quot;: &quot;A String&quot;, # Start time of this deployment.
&quot;state&quot;: &quot;A String&quot;, # The current state of the deployment.
},
],
&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.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>