blob: 5cdaacb6497831fb752ea78b1428e7de9be8af88 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -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
Dan O'Mearadd494642020-05-01 07:42:23 -070075<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 -070076<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070078 <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">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070088 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
89<p class="firstline">Get the complete list of CMLE capabilities in a location, along with their</p>
90<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -070091 <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070092<p class="firstline">List all locations that provides at least one type of CMLE capability.</p>
93<p class="toc_element">
94 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
95<p class="firstline">Retrieves the next page of results.</p>
96<h3>Method Details</h3>
97<div class="method">
98 <code class="details" id="get">get(name, x__xgafv=None)</code>
99 <pre>Get the complete list of CMLE capabilities in a location, along with their
100location-specific properties.
101
102Args:
103 name: string, Required. The name of the location. (required)
104 x__xgafv: string, V1 error format.
105 Allowed values
106 1 - v1 error format
107 2 - v2 error format
108
109Returns:
110 An object of the form:
111
112 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700113 &quot;name&quot;: &quot;A String&quot;,
114 &quot;capabilities&quot;: [ # Capabilities available in the location.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700115 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700116 &quot;type&quot;: &quot;A String&quot;,
117 &quot;availableAccelerators&quot;: [ # Available accelerators for the capability.
118 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700119 ],
120 },
121 ],
122 }</pre>
123</div>
124
125<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700126 <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700127 <pre>List all locations that provides at least one type of CMLE capability.
128
129Args:
130 parent: string, Required. The name of the project for which available locations are to be
131listed (since some locations might be whitelisted for specific projects). (required)
132 pageToken: string, Optional. A page token to request the next page of results.
133
134You get the token from the `next_page_token` field of the response from
135the previous call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700136 pageSize: integer, Optional. The number of locations to retrieve per &quot;page&quot; of results. If
137there are more remaining results than this number, the response message
138will contain a valid value in the `next_page_token` field.
139
140The default value is 20, and the maximum page size is 100.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700141 x__xgafv: string, V1 error format.
142 Allowed values
143 1 - v1 error format
144 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700145
146Returns:
147 An object of the form:
148
149 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700150 &quot;locations&quot;: [ # Locations where at least one type of CMLE capability is available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700151 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700152 &quot;name&quot;: &quot;A String&quot;,
153 &quot;capabilities&quot;: [ # Capabilities available in the location.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700154 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700155 &quot;type&quot;: &quot;A String&quot;,
156 &quot;availableAccelerators&quot;: [ # Available accelerators for the capability.
157 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700158 ],
159 },
160 ],
161 },
162 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700163 &quot;nextPageToken&quot;: &quot;A String&quot;, # Optional. Pass this token as the `page_token` field of the request for a
164 # subsequent call.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700165 }</pre>
166</div>
167
168<div class="method">
169 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
170 <pre>Retrieves the next page of results.
171
172Args:
173 previous_request: The request for the previous page. (required)
174 previous_response: The response from the request for the previous page. (required)
175
176Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700177 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700178 page. Returns None if there are no more items in the collection.
179 </pre>
180</div>
181
182</body></html>