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