Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3e17f8990db54bec16c48c319072799a14f5a53f / . / docs / dyn / ml_v1.projects.locations.html
blob: 6a395389846d92f9f3cedbedbc45a76c93b43fdb [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
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]75<h1><a href="ml_v1.html">AI Platform Training & Prediction API</a> . <a href="ml_v1.projects.html">projects</a> . <a href="ml_v1.projects.locations.html">locations</a></h1>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]78 <code><a href="ml_v1.projects.locations.operations.html">operations()</a></code>
79</p>
80<p class="firstline">Returns the operations Resource.</p>
81
82<p class="toc_element">
83 <code><a href="ml_v1.projects.locations.studies.html">studies()</a></code>
84</p>
85<p class="firstline">Returns the studies Resource.</p>
86
87<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]88 <code><a href="#close">close()</a></code></p>
89<p class="firstline">Close httplib2 connections.</p>
90<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]91 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]92<p class="firstline">Get the complete list of CMLE capabilities in a location, along with their location-specific properties.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]93<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]94 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]95<p class="firstline">List all locations that provides at least one type of CMLE capability.</p>
96<p class="toc_element">
97 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
98<p class="firstline">Retrieves the next page of results.</p>
99<h3>Method Details</h3>
100<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]101 <code class="details" id="close">close()</code>
102 <pre>Close httplib2 connections.</pre>
103</div>
104
105<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]106 <code class="details" id="get">get(name, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]107 <pre>Get the complete list of CMLE capabilities in a location, along with their location-specific properties.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]108
109Args:
110 name: string, Required. The name of the location. (required)
111 x__xgafv: string, V1 error format.
112 Allowed values
113 1 - v1 error format
114 2 - v2 error format
115
116Returns:
117 An object of the form:
118
119 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]120 &quot;capabilities&quot;: [ # Capabilities available in the location.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]121 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]122 &quot;availableAccelerators&quot;: [ # Available accelerators for the capability.
123 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]124 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]125 &quot;type&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]126 },
127 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]128 &quot;name&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]129 }</pre>
130</div>
131
132<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]133 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]134 <pre>List all locations that provides at least one type of CMLE capability.
135
136Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]137 parent: string, Required. The name of the project for which available locations are to be listed (since some locations might be whitelisted for specific projects). (required)
138 pageSize: integer, Optional. The number of locations to retrieve per &quot;page&quot; of results. If there are more remaining results than this number, the response message will contain a valid value in the `next_page_token` field. The default value is 20, and the maximum page size is 100.
139 pageToken: string, Optional. A page token to request the next page of results. You get the token from the `next_page_token` field of the response from the previous call.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]140 x__xgafv: string, V1 error format.
141 Allowed values
142 1 - v1 error format
143 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]144
145Returns:
146 An object of the form:
147
148 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]149 &quot;locations&quot;: [ # Locations where at least one type of CMLE capability is available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]150 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]151 &quot;capabilities&quot;: [ # Capabilities available in the location.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]152 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]153 &quot;availableAccelerators&quot;: [ # Available accelerators for the capability.
154 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]155 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]156 &quot;type&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]157 },
158 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]159 &quot;name&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]160 },
161 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]162 &quot;nextPageToken&quot;: &quot;A String&quot;, # Optional. Pass this token as the `page_token` field of the request for a subsequent call.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]163 }</pre>
164</div>
165
166<div class="method">
167 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
168 <pre>Retrieves the next page of results.
169
170Args:
171 previous_request: The request for the previous page. (required)
172 previous_response: The response from the request for the previous page. (required)
173
174Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]175 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]176 page. Returns None if there are no more items in the collection.
177 </pre>
178</div>
179
180</body></html>