blob: b2df972d8c9517c8f82ed1ab776c19bf8f7869b7 [file] [log] [blame]
Sai Cheemalapatidf613972016-10-21 13:59:49 -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="appengine_v1beta4.html">Google App Engine Admin API</a> . <a href="appengine_v1beta4.apps.html">apps</a> . <a href="appengine_v1beta4.apps.locations.html">locations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(appsId, locationsId, x__xgafv=None)</a></code></p>
79<p class="firstline">Get information about a location.</p>
80<p class="toc_element">
81 <code><a href="#list">list(appsId, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Lists information about the supported locations for this service.</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(appsId, locationsId, x__xgafv=None)</code>
89 <pre>Get information about a location.
90
91Args:
92 appsId: string, Part of `name`. Resource name for the location. (required)
93 locationsId: string, Part of `name`. See documentation of `appsId`. (required)
94 x__xgafv: string, V1 error format.
95
96Returns:
97 An object of the form:
98
99 { # A resource that represents Google Cloud Platform location.
100 "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
101 "a_key": "A String",
102 },
103 "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
104 "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
105 "metadata": { # Service-specific metadata. For example the available capacity at the given location.
106 "a_key": "", # Properties of the object. Contains field @type with type URL.
107 },
108 }</pre>
109</div>
110
111<div class="method">
112 <code class="details" id="list">list(appsId, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
113 <pre>Lists information about the supported locations for this service.
114
115Args:
116 appsId: string, Part of `name`. The resource that owns the locations collection, if applicable. (required)
117 pageSize: integer, The standard list page size.
118 filter: string, The standard list filter.
119 pageToken: string, The standard list page token.
120 x__xgafv: string, V1 error format.
121
122Returns:
123 An object of the form:
124
125 { # The response message for LocationService.ListLocations.
126 "nextPageToken": "A String", # The standard List next-page token.
127 "locations": [ # A list of locations that matches the specified filter in the request.
128 { # A resource that represents Google Cloud Platform location.
129 "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
130 "a_key": "A String",
131 },
132 "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
133 "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
134 "metadata": { # Service-specific metadata. For example the available capacity at the given location.
135 "a_key": "", # Properties of the object. Contains field @type with type URL.
136 },
137 },
138 ],
139 }</pre>
140</div>
141
142<div class="method">
143 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
144 <pre>Retrieves the next page of results.
145
146Args:
147 previous_request: The request for the previous page. (required)
148 previous_response: The response from the request for the previous page. (required)
149
150Returns:
151 A request object that you can call 'execute()' on to request the next
152 page. Returns None if there are no more items in the collection.
153 </pre>
154</div>
155
156</body></html>