Debian Codegraph @

docs/dyn/apim_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="apim_v1alpha.html">API Management API</a> . <a href="apim_v1alpha.projects.html">projects</a> . <a href="apim_v1alpha.projects.locations.html">locations</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="apim_v1alpha.projects.locations.observationJobs.html">observationJobs()</a></code>
79 </p>
80 <p class="firstline">Returns the observationJobs Resource.</p>
81
82 <p class="toc_element">
83 <code><a href="apim_v1alpha.projects.locations.observationSources.html">observationSources()</a></code>
84 </p>
85 <p class="firstline">Returns the observationSources Resource.</p>
86
87 <p class="toc_element">
88 <code><a href="apim_v1alpha.projects.locations.operations.html">operations()</a></code>
89 </p>
90 <p class="firstline">Returns the operations Resource.</p>
91
92 <p class="toc_element">
93 <code><a href="#close">close()</a></code></p>
94 <p class="firstline">Close httplib2 connections.</p>
95 <p class="toc_element">
96 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
97 <p class="firstline">Gets information about a location.</p>
98 <p class="toc_element">
99 <code><a href="#getEntitlement">getEntitlement(name, x__xgafv=None)</a></code></p>
100 <p class="firstline">GetEntitlement returns the entitlement for the provided project.</p>
101 <p class="toc_element">
102 <code><a href="#list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
103 <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>
104 <p class="toc_element">
105 <code><a href="#listApiObservationTags">listApiObservationTags(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
106 <p class="firstline">ListApiObservationTags lists all extant tags on any observation in the given project.</p>
107 <p class="toc_element">
108 <code><a href="#listApiObservationTags_next">listApiObservationTags_next()</a></code></p>
109 <p class="firstline">Retrieves the next page of results.</p>
110 <p class="toc_element">
111 <code><a href="#list_next">list_next()</a></code></p>
112 <p class="firstline">Retrieves the next page of results.</p>
113 <h3>Method Details</h3>
114 <div class="method">
115 <code class="details" id="close">close()</code>
116 <pre>Close httplib2 connections.</pre>
117 </div>
118
119 <div class="method">
120 <code class="details" id="get">get(name, x__xgafv=None)</code>
121 <pre>Gets information about a location.
122
123 Args:
124 name: string, Resource name for the location. (required)
125 x__xgafv: string, V1 error format.
126 Allowed values
127 1 - v1 error format
128 2 - v2 error format
129
130 Returns:
131 An object of the form:
132
133 { # A resource that represents a Google Cloud location.
134 &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name. For example, &quot;Tokyo&quot;.
135 &quot;labels&quot;: { # Cross-service attributes for the location. For example {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
136 &quot;a_key&quot;: &quot;A String&quot;,
137 },
138 &quot;locationId&quot;: &quot;A String&quot;, # The canonical id for this location. For example: `&quot;us-east1&quot;`.
139 &quot;metadata&quot;: { # Service-specific metadata. For example the available capacity at the given location.
140 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
141 },
142 &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;`
143 }</pre>
144 </div>
145
146 <div class="method">
147 <code class="details" id="getEntitlement">getEntitlement(name, x__xgafv=None)</code>
148 <pre>GetEntitlement returns the entitlement for the provided project.
149
150 Args:
151 name: string, Required. The entitlement resource name Format: projects/{project}/locations/{location}/entitlement (required)
152 x__xgafv: string, V1 error format.
153 Allowed values
154 1 - v1 error format
155 2 - v2 error format
156
157 Returns:
158 An object of the form:
159
160 { # Entitlement stores data related to API Observation entitlement for a given project
161 &quot;apiObservationEntitled&quot;: True or False, # Whether API Observation is entitled.
162 &quot;billingProjectNumber&quot;: &quot;A String&quot;, # Project number of associated billing project that has Apigee and Advanced API Security entitled.
163 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time of the entitlement creation.
164 &quot;name&quot;: &quot;A String&quot;, # Identifier. The entitlement resource name `projects/{project}/locations/{location}/entitlement`
165 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time of the entitlement update.
166 }</pre>
167 </div>
168
169 <div class="method">
170 <code class="details" id="list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
171 <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.
172
173 Args:
174 name: string, The resource that owns the locations collection, if applicable. (required)
175 extraLocationTypes: string, Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
176 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).
177 pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
178 pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
179 x__xgafv: string, V1 error format.
180 Allowed values
181 1 - v1 error format
182 2 - v2 error format
183
184 Returns:
185 An object of the form:
186
187 { # The response message for Locations.ListLocations.
188 &quot;locations&quot;: [ # A list of locations that matches the specified filter in the request.
189 { # A resource that represents a Google Cloud location.
190 &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name. For example, &quot;Tokyo&quot;.
191 &quot;labels&quot;: { # Cross-service attributes for the location. For example {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
192 &quot;a_key&quot;: &quot;A String&quot;,
193 },
194 &quot;locationId&quot;: &quot;A String&quot;, # The canonical id for this location. For example: `&quot;us-east1&quot;`.
195 &quot;metadata&quot;: { # Service-specific metadata. For example the available capacity at the given location.
196 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
197 },
198 &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;`
199 },
200 ],
201 &quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
202 }</pre>
203 </div>
204
205 <div class="method">
206 <code class="details" id="listApiObservationTags">listApiObservationTags(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
207 <pre>ListApiObservationTags lists all extant tags on any observation in the given project.
208
209 Args:
210 parent: string, Required. The parent, which owns this collection of tags. Format: projects/{project}/locations/{location} (required)
211 pageSize: integer, Optional. The maximum number of tags to return. The service may return fewer than this value. If unspecified, at most 10 tags will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
212 pageToken: string, Optional. A page token, received from a previous `ListApiObservationTags` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiObservationTags` must match the call that provided the page token.
213 x__xgafv: string, V1 error format.
214 Allowed values
215 1 - v1 error format
216 2 - v2 error format
217
218 Returns:
219 An object of the form:
220
221 { # Message for response to listing tags
222 &quot;apiObservationTags&quot;: [ # The tags from the specified project
223 &quot;A String&quot;,
224 ],
225 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
226 }</pre>
227 </div>
228
229 <div class="method">
230 <code class="details" id="listApiObservationTags_next">listApiObservationTags_next()</code>
231 <pre>Retrieves the next page of results.
232
233 Args:
234 previous_request: The request for the previous page. (required)
235 previous_response: The response from the request for the previous page. (required)
236
237 Returns:
238 A request object that you can call &#x27;execute()&#x27; on to request the next
239 page. Returns None if there are no more items in the collection.
240 </pre>
241 </div>
242
243 <div class="method">
244 <code class="details" id="list_next">list_next()</code>
245 <pre>Retrieves the next page of results.
246
247 Args:
248 previous_request: The request for the previous page. (required)
249 previous_response: The response from the request for the previous page. (required)
250
251 Returns:
252 A request object that you can call &#x27;execute()&#x27; on to request the next
253 page. Returns None if there are no more items in the collection.
254 </pre>
255 </div>
256
257 </body></html>