• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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
75<h1><a href="appengine_v1alpha.html">Google App Engine Admin API</a> . <a href="appengine_v1alpha.apps.html">apps</a> . <a href="appengine_v1alpha.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    Allowed values
96      1 - v1 error format
97      2 - v2 error format
98
99Returns:
100  An object of the form:
101
102    { # A resource that represents Google Cloud Platform location.
103    "labels": { # Cross-service attributes for the location. For example
104        # {"cloud.googleapis.com/region": "us-east1"}
105      "a_key": "A String",
106    },
107    "locationId": "A String", # The canonical id for this location. For example: "us-east1".
108    "name": "A String", # Resource name for the location, which may vary between implementations. For example: "projects/example-project/locations/us-east1"
109    "metadata": { # Service-specific metadata. For example the available capacity at the given location.
110      "a_key": "", # Properties of the object. Contains field @type with type URL.
111    },
112  }</pre>
113</div>
114
115<div class="method">
116    <code class="details" id="list">list(appsId, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
117  <pre>Lists information about the supported locations for this service.
118
119Args:
120  appsId: string, Part of `name`. The resource that owns the locations collection, if applicable. (required)
121  pageSize: integer, The standard list page size.
122  filter: string, The standard list filter.
123  pageToken: string, The standard list page token.
124  x__xgafv: string, V1 error format.
125    Allowed values
126      1 - v1 error format
127      2 - v2 error format
128
129Returns:
130  An object of the form:
131
132    { # The response message for Locations.ListLocations.
133    "nextPageToken": "A String", # The standard List next-page token.
134    "locations": [ # A list of locations that matches the specified filter in the request.
135      { # A resource that represents Google Cloud Platform location.
136        "labels": { # Cross-service attributes for the location. For example
137            # {"cloud.googleapis.com/region": "us-east1"}
138          "a_key": "A String",
139        },
140        "locationId": "A String", # The canonical id for this location. For example: "us-east1".
141        "name": "A String", # Resource name for the location, which may vary between implementations. For example: "projects/example-project/locations/us-east1"
142        "metadata": { # Service-specific metadata. For example the available capacity at the given location.
143          "a_key": "", # Properties of the object. Contains field @type with type URL.
144        },
145      },
146    ],
147  }</pre>
148</div>
149
150<div class="method">
151    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
152  <pre>Retrieves the next page of results.
153
154Args:
155  previous_request: The request for the previous page. (required)
156  previous_response: The response from the request for the previous page. (required)
157
158Returns:
159  A request object that you can call 'execute()' on to request the next
160  page. Returns None if there are no more items in the collection.
161    </pre>
162</div>
163
164</body></html>