blob: 1c66c1b37f550c4c9db973bf9a743db0b6b83c71 [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -07001<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="bigqueryreservation_v1alpha2.html">BigQuery Reservation API</a> . <a href="bigqueryreservation_v1alpha2.projects.html">projects</a> . <a href="bigqueryreservation_v1alpha2.projects.locations.html">locations</a> . <a href="bigqueryreservation_v1alpha2.projects.locations.reservations.html">reservations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="bigqueryreservation_v1alpha2.projects.locations.reservations.slotPools.html">slotPools()</a></code>
79</p>
80<p class="firstline">Returns the slotPools Resource.</p>
81
82<p class="toc_element">
83 <code><a href="#create">create(parent, body=None, reservationId=None, x__xgafv=None)</a></code></p>
84<p class="firstline">Creates a new reservation resource. Multiple reservations are created if</p>
85<p class="toc_element">
86 <code><a href="#createReservation">createReservation(parent, body=None, reservationId=None, x__xgafv=None)</a></code></p>
87<p class="firstline">Creates a new reservation resource. Multiple reservations are created if</p>
88<p class="toc_element">
89 <code><a href="#delete">delete(name, force=None, x__xgafv=None)</a></code></p>
90<p class="firstline">Deletes a reservation.</p>
91<p class="toc_element">
92 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
93<p class="firstline">Returns information about the reservation.</p>
94<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -070095 <code><a href="#list">list(parent, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim65020912020-05-20 12:08:20 -070096<p class="firstline">Lists all the reservations for the project in the specified location.</p>
97<p class="toc_element">
98 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
99<p class="firstline">Retrieves the next page of results.</p>
100<p class="toc_element">
101 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
102<p class="firstline">Updates an existing reservation resource. Applicable only for child</p>
103<h3>Method Details</h3>
104<div class="method">
105 <code class="details" id="create">create(parent, body=None, reservationId=None, x__xgafv=None)</code>
106 <pre>Creates a new reservation resource. Multiple reservations are created if
107the ancestor reservations do not exist.
108
109Args:
110 parent: string, Project, location, and (optionally) reservation name. E.g.,
111 projects/myproject/locations/us-central1/reservations/parent (required)
112 body: object, The request body.
113 The object takes the form of:
114
115{ # A reservation is a mechanism used to guarantee slots to users.
116 &quot;slotCapacity&quot;: &quot;A String&quot;, # Maximum slots available to this reservation and its children. A slot is a
117 # unit of computational power in BigQuery, and serves as the unit of
118 # parallelism. In a scan of a multi-partitioned table, a single slot operates
119 # on a single partition of the table.
120 #
121 # If the new reservation&#x27;s slot capacity exceed the parent&#x27;s slot capacity or
122 # if total slot capacity of the new reservation and its siblings exceeds the
123 # parent&#x27;s slot capacity, the request will fail with
124 # `google.rpc.Code.RESOURCE_EXHAUSTED`.
125 &quot;name&quot;: &quot;A String&quot;, # The resource name of the reservation, e.g.,
126 # &quot;projects/*/locations/*/reservations/dev/team/product&quot;. Reservation names
127 # (e.g., &quot;dev/team/product&quot;) exceeding a depth of six will fail with
128 # `google.rpc.Code.INVALID_ARGUMENT`.
129 &quot;useParentReservation&quot;: True or False, # If true, any query using this reservation will also be submitted to the
130 # parent reservation. This allows the query to share the additional slot
131 # capacity of the parent with other queries in the parent reservation. If the
132 # parent also has this field set to true, then this process will continue
133 # until it encounters a reservation for which this is false.
134 # If false, a query using this reservation will
135 # execute with the maximum slot capacity as specified above.
136 # If not specified, default value is true.
137 # Ignored for top-level reservation.
138}
139
140 reservationId: string, The reservation ID relative to the parent, e.g., &quot;dev&quot;. This field must
141only contain alphanumeric characters.
142 x__xgafv: string, V1 error format.
143 Allowed values
144 1 - v1 error format
145 2 - v2 error format
146
147Returns:
148 An object of the form:
149
150 { # A reservation is a mechanism used to guarantee slots to users.
151 &quot;slotCapacity&quot;: &quot;A String&quot;, # Maximum slots available to this reservation and its children. A slot is a
152 # unit of computational power in BigQuery, and serves as the unit of
153 # parallelism. In a scan of a multi-partitioned table, a single slot operates
154 # on a single partition of the table.
155 #
156 # If the new reservation&#x27;s slot capacity exceed the parent&#x27;s slot capacity or
157 # if total slot capacity of the new reservation and its siblings exceeds the
158 # parent&#x27;s slot capacity, the request will fail with
159 # `google.rpc.Code.RESOURCE_EXHAUSTED`.
160 &quot;name&quot;: &quot;A String&quot;, # The resource name of the reservation, e.g.,
161 # &quot;projects/*/locations/*/reservations/dev/team/product&quot;. Reservation names
162 # (e.g., &quot;dev/team/product&quot;) exceeding a depth of six will fail with
163 # `google.rpc.Code.INVALID_ARGUMENT`.
164 &quot;useParentReservation&quot;: True or False, # If true, any query using this reservation will also be submitted to the
165 # parent reservation. This allows the query to share the additional slot
166 # capacity of the parent with other queries in the parent reservation. If the
167 # parent also has this field set to true, then this process will continue
168 # until it encounters a reservation for which this is false.
169 # If false, a query using this reservation will
170 # execute with the maximum slot capacity as specified above.
171 # If not specified, default value is true.
172 # Ignored for top-level reservation.
173 }</pre>
174</div>
175
176<div class="method">
177 <code class="details" id="createReservation">createReservation(parent, body=None, reservationId=None, x__xgafv=None)</code>
178 <pre>Creates a new reservation resource. Multiple reservations are created if
179the ancestor reservations do not exist.
180
181Args:
182 parent: string, Project, location, and (optionally) reservation name. E.g.,
183 projects/myproject/locations/us-central1/reservations/parent (required)
184 body: object, The request body.
185 The object takes the form of:
186
187{ # A reservation is a mechanism used to guarantee slots to users.
188 &quot;slotCapacity&quot;: &quot;A String&quot;, # Maximum slots available to this reservation and its children. A slot is a
189 # unit of computational power in BigQuery, and serves as the unit of
190 # parallelism. In a scan of a multi-partitioned table, a single slot operates
191 # on a single partition of the table.
192 #
193 # If the new reservation&#x27;s slot capacity exceed the parent&#x27;s slot capacity or
194 # if total slot capacity of the new reservation and its siblings exceeds the
195 # parent&#x27;s slot capacity, the request will fail with
196 # `google.rpc.Code.RESOURCE_EXHAUSTED`.
197 &quot;name&quot;: &quot;A String&quot;, # The resource name of the reservation, e.g.,
198 # &quot;projects/*/locations/*/reservations/dev/team/product&quot;. Reservation names
199 # (e.g., &quot;dev/team/product&quot;) exceeding a depth of six will fail with
200 # `google.rpc.Code.INVALID_ARGUMENT`.
201 &quot;useParentReservation&quot;: True or False, # If true, any query using this reservation will also be submitted to the
202 # parent reservation. This allows the query to share the additional slot
203 # capacity of the parent with other queries in the parent reservation. If the
204 # parent also has this field set to true, then this process will continue
205 # until it encounters a reservation for which this is false.
206 # If false, a query using this reservation will
207 # execute with the maximum slot capacity as specified above.
208 # If not specified, default value is true.
209 # Ignored for top-level reservation.
210}
211
212 reservationId: string, The reservation ID relative to the parent, e.g., &quot;dev&quot;. This field must
213only contain alphanumeric characters.
214 x__xgafv: string, V1 error format.
215 Allowed values
216 1 - v1 error format
217 2 - v2 error format
218
219Returns:
220 An object of the form:
221
222 { # A reservation is a mechanism used to guarantee slots to users.
223 &quot;slotCapacity&quot;: &quot;A String&quot;, # Maximum slots available to this reservation and its children. A slot is a
224 # unit of computational power in BigQuery, and serves as the unit of
225 # parallelism. In a scan of a multi-partitioned table, a single slot operates
226 # on a single partition of the table.
227 #
228 # If the new reservation&#x27;s slot capacity exceed the parent&#x27;s slot capacity or
229 # if total slot capacity of the new reservation and its siblings exceeds the
230 # parent&#x27;s slot capacity, the request will fail with
231 # `google.rpc.Code.RESOURCE_EXHAUSTED`.
232 &quot;name&quot;: &quot;A String&quot;, # The resource name of the reservation, e.g.,
233 # &quot;projects/*/locations/*/reservations/dev/team/product&quot;. Reservation names
234 # (e.g., &quot;dev/team/product&quot;) exceeding a depth of six will fail with
235 # `google.rpc.Code.INVALID_ARGUMENT`.
236 &quot;useParentReservation&quot;: True or False, # If true, any query using this reservation will also be submitted to the
237 # parent reservation. This allows the query to share the additional slot
238 # capacity of the parent with other queries in the parent reservation. If the
239 # parent also has this field set to true, then this process will continue
240 # until it encounters a reservation for which this is false.
241 # If false, a query using this reservation will
242 # execute with the maximum slot capacity as specified above.
243 # If not specified, default value is true.
244 # Ignored for top-level reservation.
245 }</pre>
246</div>
247
248<div class="method">
249 <code class="details" id="delete">delete(name, force=None, x__xgafv=None)</code>
250 <pre>Deletes a reservation.
251Returns `google.rpc.Code.FAILED_PRECONDITION` in the following cases:
252 1. When reservation has child reservations. This check can be bypassed by
253 setting DeleteReservationRequest.force flag to true.
254 2. When top-level reservation with slot pools is being deleted.
255
256Args:
257 name: string, Resource name of the reservation to retrieve. E.g.,
258 projects/myproject/locations/us-central1/reservations/my_reservation (required)
259 force: boolean, If true, deletes all the child reservations of the given reservation.
260Otherwise, attempting to delete a reservation that has child
261reservations will fail with error code
262`google.rpc.Code.FAILED_PRECONDITION`.
263 x__xgafv: string, V1 error format.
264 Allowed values
265 1 - v1 error format
266 2 - v2 error format
267
268Returns:
269 An object of the form:
270
271 { # A generic empty message that you can re-use to avoid defining duplicated
272 # empty messages in your APIs. A typical example is to use it as the request
273 # or the response type of an API method. For instance:
274 #
275 # service Foo {
276 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
277 # }
278 #
279 # The JSON representation for `Empty` is empty JSON object `{}`.
280 }</pre>
281</div>
282
283<div class="method">
284 <code class="details" id="get">get(name, x__xgafv=None)</code>
285 <pre>Returns information about the reservation.
286
287Args:
288 name: string, Resource name of the reservation to retrieve. E.g.,
289 projects/myproject/locations/us-central1/reservations/path/to/reserv (required)
290 x__xgafv: string, V1 error format.
291 Allowed values
292 1 - v1 error format
293 2 - v2 error format
294
295Returns:
296 An object of the form:
297
298 { # A reservation is a mechanism used to guarantee slots to users.
299 &quot;slotCapacity&quot;: &quot;A String&quot;, # Maximum slots available to this reservation and its children. A slot is a
300 # unit of computational power in BigQuery, and serves as the unit of
301 # parallelism. In a scan of a multi-partitioned table, a single slot operates
302 # on a single partition of the table.
303 #
304 # If the new reservation&#x27;s slot capacity exceed the parent&#x27;s slot capacity or
305 # if total slot capacity of the new reservation and its siblings exceeds the
306 # parent&#x27;s slot capacity, the request will fail with
307 # `google.rpc.Code.RESOURCE_EXHAUSTED`.
308 &quot;name&quot;: &quot;A String&quot;, # The resource name of the reservation, e.g.,
309 # &quot;projects/*/locations/*/reservations/dev/team/product&quot;. Reservation names
310 # (e.g., &quot;dev/team/product&quot;) exceeding a depth of six will fail with
311 # `google.rpc.Code.INVALID_ARGUMENT`.
312 &quot;useParentReservation&quot;: True or False, # If true, any query using this reservation will also be submitted to the
313 # parent reservation. This allows the query to share the additional slot
314 # capacity of the parent with other queries in the parent reservation. If the
315 # parent also has this field set to true, then this process will continue
316 # until it encounters a reservation for which this is false.
317 # If false, a query using this reservation will
318 # execute with the maximum slot capacity as specified above.
319 # If not specified, default value is true.
320 # Ignored for top-level reservation.
321 }</pre>
322</div>
323
324<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700325 <code class="details" id="list">list(parent, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700326 <pre>Lists all the reservations for the project in the specified location.
327
328Args:
329 parent: string, The parent resource name containing project and location, e.g.:
330 &quot;projects/myproject/locations/us-central1&quot; (required)
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700331 pageSize: integer, The maximum number of items to return.
Bu Sun Kim65020912020-05-20 12:08:20 -0700332 filter: string, Can be used to filter out reservations based on names, capacity, etc, e.g.:
333filter=&quot;reservation.slot_capacity &gt; 200&quot;
334filter=&quot;reservation.name = \&quot;*dev/*\&quot;&quot;
335Advanced filtering syntax can be
336[here](https://cloud.google.com/logging/docs/view/advanced-filters).
337 pageToken: string, The next_page_token value returned from a previous List request, if any.
Bu Sun Kim65020912020-05-20 12:08:20 -0700338 x__xgafv: string, V1 error format.
339 Allowed values
340 1 - v1 error format
341 2 - v2 error format
342
343Returns:
344 An object of the form:
345
346 { # The response for ReservationService.ListReservations.
Bu Sun Kim65020912020-05-20 12:08:20 -0700347 &quot;reservations&quot;: [ # List of reservations visible to the user.
348 { # A reservation is a mechanism used to guarantee slots to users.
349 &quot;slotCapacity&quot;: &quot;A String&quot;, # Maximum slots available to this reservation and its children. A slot is a
350 # unit of computational power in BigQuery, and serves as the unit of
351 # parallelism. In a scan of a multi-partitioned table, a single slot operates
352 # on a single partition of the table.
353 #
354 # If the new reservation&#x27;s slot capacity exceed the parent&#x27;s slot capacity or
355 # if total slot capacity of the new reservation and its siblings exceeds the
356 # parent&#x27;s slot capacity, the request will fail with
357 # `google.rpc.Code.RESOURCE_EXHAUSTED`.
358 &quot;name&quot;: &quot;A String&quot;, # The resource name of the reservation, e.g.,
359 # &quot;projects/*/locations/*/reservations/dev/team/product&quot;. Reservation names
360 # (e.g., &quot;dev/team/product&quot;) exceeding a depth of six will fail with
361 # `google.rpc.Code.INVALID_ARGUMENT`.
362 &quot;useParentReservation&quot;: True or False, # If true, any query using this reservation will also be submitted to the
363 # parent reservation. This allows the query to share the additional slot
364 # capacity of the parent with other queries in the parent reservation. If the
365 # parent also has this field set to true, then this process will continue
366 # until it encounters a reservation for which this is false.
367 # If false, a query using this reservation will
368 # execute with the maximum slot capacity as specified above.
369 # If not specified, default value is true.
370 # Ignored for top-level reservation.
371 },
372 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700373 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no
374 # more results in the list.
Bu Sun Kim65020912020-05-20 12:08:20 -0700375 }</pre>
376</div>
377
378<div class="method">
379 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
380 <pre>Retrieves the next page of results.
381
382Args:
383 previous_request: The request for the previous page. (required)
384 previous_response: The response from the request for the previous page. (required)
385
386Returns:
387 A request object that you can call &#x27;execute()&#x27; on to request the next
388 page. Returns None if there are no more items in the collection.
389 </pre>
390</div>
391
392<div class="method">
393 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
394 <pre>Updates an existing reservation resource. Applicable only for child
395reservations.
396
397Args:
398 name: string, The resource name of the reservation, e.g.,
399&quot;projects/*/locations/*/reservations/dev/team/product&quot;. Reservation names
400(e.g., &quot;dev/team/product&quot;) exceeding a depth of six will fail with
401`google.rpc.Code.INVALID_ARGUMENT`. (required)
402 body: object, The request body.
403 The object takes the form of:
404
405{ # A reservation is a mechanism used to guarantee slots to users.
406 &quot;slotCapacity&quot;: &quot;A String&quot;, # Maximum slots available to this reservation and its children. A slot is a
407 # unit of computational power in BigQuery, and serves as the unit of
408 # parallelism. In a scan of a multi-partitioned table, a single slot operates
409 # on a single partition of the table.
410 #
411 # If the new reservation&#x27;s slot capacity exceed the parent&#x27;s slot capacity or
412 # if total slot capacity of the new reservation and its siblings exceeds the
413 # parent&#x27;s slot capacity, the request will fail with
414 # `google.rpc.Code.RESOURCE_EXHAUSTED`.
415 &quot;name&quot;: &quot;A String&quot;, # The resource name of the reservation, e.g.,
416 # &quot;projects/*/locations/*/reservations/dev/team/product&quot;. Reservation names
417 # (e.g., &quot;dev/team/product&quot;) exceeding a depth of six will fail with
418 # `google.rpc.Code.INVALID_ARGUMENT`.
419 &quot;useParentReservation&quot;: True or False, # If true, any query using this reservation will also be submitted to the
420 # parent reservation. This allows the query to share the additional slot
421 # capacity of the parent with other queries in the parent reservation. If the
422 # parent also has this field set to true, then this process will continue
423 # until it encounters a reservation for which this is false.
424 # If false, a query using this reservation will
425 # execute with the maximum slot capacity as specified above.
426 # If not specified, default value is true.
427 # Ignored for top-level reservation.
428}
429
430 updateMask: string, Standard field mask for the set of fields to be updated.
431 x__xgafv: string, V1 error format.
432 Allowed values
433 1 - v1 error format
434 2 - v2 error format
435
436Returns:
437 An object of the form:
438
439 { # A reservation is a mechanism used to guarantee slots to users.
440 &quot;slotCapacity&quot;: &quot;A String&quot;, # Maximum slots available to this reservation and its children. A slot is a
441 # unit of computational power in BigQuery, and serves as the unit of
442 # parallelism. In a scan of a multi-partitioned table, a single slot operates
443 # on a single partition of the table.
444 #
445 # If the new reservation&#x27;s slot capacity exceed the parent&#x27;s slot capacity or
446 # if total slot capacity of the new reservation and its siblings exceeds the
447 # parent&#x27;s slot capacity, the request will fail with
448 # `google.rpc.Code.RESOURCE_EXHAUSTED`.
449 &quot;name&quot;: &quot;A String&quot;, # The resource name of the reservation, e.g.,
450 # &quot;projects/*/locations/*/reservations/dev/team/product&quot;. Reservation names
451 # (e.g., &quot;dev/team/product&quot;) exceeding a depth of six will fail with
452 # `google.rpc.Code.INVALID_ARGUMENT`.
453 &quot;useParentReservation&quot;: True or False, # If true, any query using this reservation will also be submitted to the
454 # parent reservation. This allows the query to share the additional slot
455 # capacity of the parent with other queries in the parent reservation. If the
456 # parent also has this field set to true, then this process will continue
457 # until it encounters a reservation for which this is false.
458 # If false, a query using this reservation will
459 # execute with the maximum slot capacity as specified above.
460 # If not specified, default value is true.
461 # Ignored for top-level reservation.
462 }</pre>
463</div>
464
465</body></html>