Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 673ec5cf1a654055c85c0d426b27d270a8ade262 / . / docs / dyn / appengine_v1.apps.locations.html
blob: c37fd2b588654d554780b3d0526a5062fcfd0a55 [file] [log] [blame]
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -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
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]75<h1><a href="appengine_v1.html">App Engine Admin API</a> . <a href="appengine_v1.apps.html">apps</a> . <a href="appengine_v1.apps.locations.html">locations</a></h1>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]81 <code><a href="#get">get(appsId, locationsId, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]82<p class="firstline">Gets information about a location.</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]83<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]84 <code><a href="#list">list(appsId, pageToken=None, filter=None, pageSize=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]85<p class="firstline">Lists information about the supported locations for this service.</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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]91 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93</div>
94
95<div class="method">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]96 <code class="details" id="get">get(appsId, locationsId, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]97 <pre>Gets information about a location.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]98
99Args:
100 appsId: string, Part of `name`. Resource name for the location. (required)
101 locationsId: string, Part of `name`. See documentation of `appsId`. (required)
102 x__xgafv: string, V1 error format.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]103 Allowed values
104 1 - v1 error format
105 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]106
107Returns:
108 An object of the form:
109
110 { # A resource that represents Google Cloud Platform location.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]111 &quot;metadata&quot;: { # Service-specific metadata. For example the available capacity at the given location.
112 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
113 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]114 &quot;labels&quot;: { # Cross-service attributes for the location. For example {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
115 &quot;a_key&quot;: &quot;A String&quot;,
116 },
117 &quot;name&quot;: &quot;A String&quot;, # Resource name for the location, which may vary between implementations. For example: &quot;projects/example-project/locations/us-east1&quot;
118 &quot;locationId&quot;: &quot;A String&quot;, # The canonical id for this location. For example: &quot;us-east1&quot;.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]119 &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name. For example, &quot;Tokyo&quot;.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]120 }</pre>
121</div>
122
123<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]124 <code class="details" id="list">list(appsId, pageToken=None, filter=None, pageSize=None, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]125 <pre>Lists information about the supported locations for this service.
126
127Args:
128 appsId: string, Part of `name`. The resource that owns the locations collection, if applicable. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]129 pageToken: string, The standard list page token.
130 filter: string, The standard list filter.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]131 pageSize: integer, The standard list page size.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]132 x__xgafv: string, V1 error format.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]133 Allowed values
134 1 - v1 error format
135 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]136
137Returns:
138 An object of the form:
139
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]140 { # The response message for Locations.ListLocations.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]141 &quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]142 &quot;locations&quot;: [ # A list of locations that matches the specified filter in the request.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]143 { # A resource that represents Google Cloud Platform location.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]144 &quot;metadata&quot;: { # Service-specific metadata. For example the available capacity at the given location.
145 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
146 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]147 &quot;labels&quot;: { # Cross-service attributes for the location. For example {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
148 &quot;a_key&quot;: &quot;A String&quot;,
149 },
150 &quot;name&quot;: &quot;A String&quot;, # Resource name for the location, which may vary between implementations. For example: &quot;projects/example-project/locations/us-east1&quot;
151 &quot;locationId&quot;: &quot;A String&quot;, # The canonical id for this location. For example: &quot;us-east1&quot;.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]152 &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name. For example, &quot;Tokyo&quot;.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]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:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]167 A request object that you can call &#x27;execute()&#x27; on to request the next
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]168 page. Returns None if there are no more items in the collection.
169 </pre>
170</div>
171
172</body></html>