blob: 9ac0f5788ba63b8edeb11ed4ceb524c14278a1a5 [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
75<h1><a href="ml_v1.html">Cloud Machine Learning Engine</a> . <a href="ml_v1.projects.html">projects</a> . <a href="ml_v1.projects.locations.html">locations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
79<p class="firstline">Get the complete list of CMLE capabilities in a location, along with their</p>
80<p class="toc_element">
81 <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
82<p class="firstline">List all locations that provides at least one type of CMLE capability.</p>
83<p class="toc_element">
84 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<h3>Method Details</h3>
87<div class="method">
88 <code class="details" id="get">get(name, x__xgafv=None)</code>
89 <pre>Get the complete list of CMLE capabilities in a location, along with their
90location-specific properties.
91
92Args:
93 name: string, Required. The name of the location. (required)
94 x__xgafv: string, V1 error format.
95 Allowed values
96 1 - v1 error format
97 2 - v2 error format
98
99Returns:
100 An object of the form:
101
102 {
103 "name": "A String",
104 "capabilities": [ # Capabilities available in the location.
105 {
106 "type": "A String",
107 "availableAccelerators": [ # Available accelerators for the capability.
108 "A String",
109 ],
110 },
111 ],
112 }</pre>
113</div>
114
115<div class="method">
116 <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code>
117 <pre>List all locations that provides at least one type of CMLE capability.
118
119Args:
120 parent: string, Required. The name of the project for which available locations are to be
121listed (since some locations might be whitelisted for specific projects). (required)
122 pageToken: string, Optional. A page token to request the next page of results.
123
124You get the token from the `next_page_token` field of the response from
125the previous call.
126 x__xgafv: string, V1 error format.
127 Allowed values
128 1 - v1 error format
129 2 - v2 error format
130 pageSize: integer, Optional. The number of locations to retrieve per "page" of results. If
131there are more remaining results than this number, the response message
132will contain a valid value in the `next_page_token` field.
133
134The default value is 20, and the maximum page size is 100.
135
136Returns:
137 An object of the form:
138
139 {
140 "nextPageToken": "A String", # Optional. Pass this token as the `page_token` field of the request for a
141 # subsequent call.
142 "locations": [ # Locations where at least one type of CMLE capability is available.
143 {
144 "name": "A String",
145 "capabilities": [ # Capabilities available in the location.
146 {
147 "type": "A String",
148 "availableAccelerators": [ # Available accelerators for the capability.
149 "A String",
150 ],
151 },
152 ],
153 },
154 ],
155 }</pre>
156</div>
157
158<div class="method">
159 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
160 <pre>Retrieves the next page of results.
161
162Args:
163 previous_request: The request for the previous page. (required)
164 previous_response: The response from the request for the previous page. (required)
165
166Returns:
167 A request object that you can call 'execute()' on to request the next
168 page. Returns None if there are no more items in the collection.
169 </pre>
170</div>
171
172</body></html>