Debian Codegraph @

docs/dyn/appengine_v1alpha.projects.locations.html

raw
1 <html><body>
2 <style>
3
4 body, 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
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, 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">App Engine Admin API</a> . <a href="appengine_v1alpha.projects.html">projects</a> . <a href="appengine_v1alpha.projects.locations.html">locations</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="appengine_v1alpha.projects.locations.applications.html">applications()</a></code>
79 </p>
80 <p class="firstline">Returns the applications Resource.</p>
81
82 <p class="toc_element">
83 <code><a href="appengine_v1alpha.projects.locations.operations.html">operations()</a></code>
84 </p>
85 <p class="firstline">Returns the operations Resource.</p>
86
87 <p class="toc_element">
88 <code><a href="#close">close()</a></code></p>
89 <p class="firstline">Close httplib2 connections.</p>
90 <p class="toc_element">
91 <code><a href="#get">get(projectsId, locationsId, x__xgafv=None)</a></code></p>
92 <p class="firstline">Gets information about a location.</p>
93 <p class="toc_element">
94 <code><a href="#list">list(projectsId, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
95 <p class="firstline">Lists information about the supported locations for this service.This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: Global locations: If name is empty, the method lists the public locations available to all projects. Project-specific locations: If name follows the format projects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project.For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.</p>
96 <p class="toc_element">
97 <code><a href="#list_next">list_next()</a></code></p>
98 <p class="firstline">Retrieves the next page of results.</p>
99 <h3>Method Details</h3>
100 <div class="method">
101 <code class="details" id="close">close()</code>
102 <pre>Close httplib2 connections.</pre>
103 </div>
104
105 <div class="method">
106 <code class="details" id="get">get(projectsId, locationsId, x__xgafv=None)</code>
107 <pre>Gets information about a location.
108
109 Args:
110 projectsId: string, Part of `name`. Resource name for the location. (required)
111 locationsId: string, Part of `name`. See documentation of `projectsId`. (required)
112 x__xgafv: string, V1 error format.
113 Allowed values
114 1 - v1 error format
115 2 - v2 error format
116
117 Returns:
118 An object of the form:
119
120 { # A resource that represents a Google Cloud location.
121 &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name. For example, &quot;Tokyo&quot;.
122 &quot;labels&quot;: { # Cross-service attributes for the location. For example {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
123 &quot;a_key&quot;: &quot;A String&quot;,
124 },
125 &quot;locationId&quot;: &quot;A String&quot;, # The canonical id for this location. For example: &quot;us-east1&quot;.
126 &quot;metadata&quot;: { # Service-specific metadata. For example the available capacity at the given location.
127 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
128 },
129 &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;
130 }</pre>
131 </div>
132
133 <div class="method">
134 <code class="details" id="list">list(projectsId, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
135 <pre>Lists information about the supported locations for this service.This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: Global locations: If name is empty, the method lists the public locations available to all projects. Project-specific locations: If name follows the format projects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project.For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
136
137 Args:
138 projectsId: string, Part of `name`. The resource that owns the locations collection, if applicable. (required)
139 extraLocationTypes: string, Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
140 filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like &quot;displayName=tokyo&quot;, and is documented in more detail in AIP-160 (https://google.aip.dev/160).
141 pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
142 pageToken: string, A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.
143 x__xgafv: string, V1 error format.
144 Allowed values
145 1 - v1 error format
146 2 - v2 error format
147
148 Returns:
149 An object of the form:
150
151 { # The response message for Locations.ListLocations.
152 &quot;locations&quot;: [ # A list of locations that matches the specified filter in the request.
153 { # A resource that represents a Google Cloud location.
154 &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name. For example, &quot;Tokyo&quot;.
155 &quot;labels&quot;: { # Cross-service attributes for the location. For example {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
156 &quot;a_key&quot;: &quot;A String&quot;,
157 },
158 &quot;locationId&quot;: &quot;A String&quot;, # The canonical id for this location. For example: &quot;us-east1&quot;.
159 &quot;metadata&quot;: { # Service-specific metadata. For example the available capacity at the given location.
160 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
161 },
162 &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;
163 },
164 ],
165 &quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
166 }</pre>
167 </div>
168
169 <div class="method">
170 <code class="details" id="list_next">list_next()</code>
171 <pre>Retrieves the next page of results.
172
173 Args:
174 previous_request: The request for the previous page. (required)
175 previous_response: The response from the request for the previous page. (required)
176
177 Returns:
178 A request object that you can call &#x27;execute()&#x27; on to request the next
179 page. Returns None if there are no more items in the collection.
180 </pre>
181 </div>
182
183 </body></html>