blob: f988beed57fa66ea53396c76540f1b15c9f84333 [file] [log] [blame]
Anthonios Partheniou10f4b672021-04-13 14:47:53 -04001<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="metastore_v1alpha.html">Dataproc Metastore API</a> . <a href="metastore_v1alpha.projects.html">projects</a> . <a href="metastore_v1alpha.projects.locations.html">locations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="metastore_v1alpha.projects.locations.operations.html">operations()</a></code>
79</p>
80<p class="firstline">Returns the operations Resource.</p>
81
82<p class="toc_element">
83 <code><a href="metastore_v1alpha.projects.locations.services.html">services()</a></code>
84</p>
85<p class="firstline">Returns the services 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(name, 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(name, 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.</p>
96<p class="toc_element">
97 <code><a href="#list_next">list_next(previous_request, previous_response)</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(name, x__xgafv=None)</code>
107 <pre>Gets information about a location.
108
109Args:
110 name: string, Resource name for the location. (required)
111 x__xgafv: string, V1 error format.
112 Allowed values
113 1 - v1 error format
114 2 - v2 error format
115
116Returns:
117 An object of the form:
118
119 { # A resource that represents Google Cloud Platform location.
120 &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name. For example, &quot;Tokyo&quot;.
121 &quot;labels&quot;: { # Cross-service attributes for the location. For example {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
122 &quot;a_key&quot;: &quot;A String&quot;,
123 },
124 &quot;locationId&quot;: &quot;A String&quot;, # The canonical id for this location. For example: &quot;us-east1&quot;.
125 &quot;metadata&quot;: { # Service-specific metadata. For example the available capacity at the given location.
126 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
127 },
128 &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;
129}</pre>
130</div>
131
132<div class="method">
133 <code class="details" id="list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
134 <pre>Lists information about the supported locations for this service.
135
136Args:
137 name: string, The resource that owns the locations collection, if applicable. (required)
138 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).
yoshi-code-bot3dd15272021-04-21 15:07:48 -0700139 pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400140 pageToken: string, A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.
141 x__xgafv: string, V1 error format.
142 Allowed values
143 1 - v1 error format
144 2 - v2 error format
145
146Returns:
147 An object of the form:
148
149 { # The response message for Locations.ListLocations.
150 &quot;locations&quot;: [ # A list of locations that matches the specified filter in the request.
151 { # A resource that represents Google Cloud Platform location.
152 &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name. For example, &quot;Tokyo&quot;.
153 &quot;labels&quot;: { # Cross-service attributes for the location. For example {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
154 &quot;a_key&quot;: &quot;A String&quot;,
155 },
156 &quot;locationId&quot;: &quot;A String&quot;, # The canonical id for this location. For example: &quot;us-east1&quot;.
157 &quot;metadata&quot;: { # Service-specific metadata. For example the available capacity at the given location.
158 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
159 },
160 &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;
161 },
162 ],
163 &quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
164}</pre>
165</div>
166
167<div class="method">
168 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
169 <pre>Retrieves the next page of results.
170
171Args:
172 previous_request: The request for the previous page. (required)
173 previous_response: The response from the request for the previous page. (required)
174
175Returns:
176 A request object that you can call &#x27;execute()&#x27; on to request the next
177 page. Returns None if there are no more items in the collection.
178 </pre>
179</div>
180
181</body></html>