• 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="networkconnectivity_v1alpha1.html">Network Connectivity API</a> . <a href="networkconnectivity_v1alpha1.projects.html">projects</a> . <a href="networkconnectivity_v1alpha1.projects.locations.html">locations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="networkconnectivity_v1alpha1.projects.locations.global_.html">global_()</a></code>
79</p>
80<p class="firstline">Returns the global_ Resource.</p>
81
82<p class="toc_element">
83  <code><a href="networkconnectivity_v1alpha1.projects.locations.internalRanges.html">internalRanges()</a></code>
84</p>
85<p class="firstline">Returns the internalRanges Resource.</p>
86
87<p class="toc_element">
88  <code><a href="networkconnectivity_v1alpha1.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="networkconnectivity_v1alpha1.projects.locations.spokes.html">spokes()</a></code>
94</p>
95<p class="firstline">Returns the spokes Resource.</p>
96
97<p class="toc_element">
98  <code><a href="#close">close()</a></code></p>
99<p class="firstline">Close httplib2 connections.</p>
100<p class="toc_element">
101  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
102<p class="firstline">Gets information about a location.</p>
103<p class="toc_element">
104  <code><a href="#list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
105<p class="firstline">Lists information about the supported locations for this service.</p>
106<p class="toc_element">
107  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
108<p class="firstline">Retrieves the next page of results.</p>
109<h3>Method Details</h3>
110<div class="method">
111    <code class="details" id="close">close()</code>
112  <pre>Close httplib2 connections.</pre>
113</div>
114
115<div class="method">
116    <code class="details" id="get">get(name, x__xgafv=None)</code>
117  <pre>Gets information about a location.
118
119Args:
120  name: string, Resource name for the location. (required)
121  x__xgafv: string, V1 error format.
122    Allowed values
123      1 - v1 error format
124      2 - v2 error format
125
126Returns:
127  An object of the form:
128
129    { # A resource that represents Google Cloud Platform location.
130  &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name. For example, &quot;Tokyo&quot;.
131  &quot;labels&quot;: { # Cross-service attributes for the location. For example {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
132    &quot;a_key&quot;: &quot;A String&quot;,
133  },
134  &quot;locationId&quot;: &quot;A String&quot;, # The canonical id for this location. For example: `&quot;us-east1&quot;`.
135  &quot;metadata&quot;: { # Service-specific metadata. For example the available capacity at the given location.
136    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
137  },
138  &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;`
139}</pre>
140</div>
141
142<div class="method">
143    <code class="details" id="list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
144  <pre>Lists information about the supported locations for this service.
145
146Args:
147  name: string, The resource that owns the locations collection, if applicable. (required)
148  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).
149  pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
150  pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
151  x__xgafv: string, V1 error format.
152    Allowed values
153      1 - v1 error format
154      2 - v2 error format
155
156Returns:
157  An object of the form:
158
159    { # The response message for Locations.ListLocations.
160  &quot;locations&quot;: [ # A list of locations that matches the specified filter in the request.
161    { # A resource that represents Google Cloud Platform location.
162      &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name. For example, &quot;Tokyo&quot;.
163      &quot;labels&quot;: { # Cross-service attributes for the location. For example {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
164        &quot;a_key&quot;: &quot;A String&quot;,
165      },
166      &quot;locationId&quot;: &quot;A String&quot;, # The canonical id for this location. For example: `&quot;us-east1&quot;`.
167      &quot;metadata&quot;: { # Service-specific metadata. For example the available capacity at the given location.
168        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
169      },
170      &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;`
171    },
172  ],
173  &quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
174}</pre>
175</div>
176
177<div class="method">
178    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
179  <pre>Retrieves the next page of results.
180
181Args:
182  previous_request: The request for the previous page. (required)
183  previous_response: The response from the request for the previous page. (required)
184
185Returns:
186  A request object that you can call &#x27;execute()&#x27; on to request the next
187  page. Returns None if there are no more items in the collection.
188    </pre>
189</div>
190
191</body></html>