blob: c4837759d70595da0fcd7409012c3a8310a41f6c [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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070083 <code><a href="#close">close()</a></code></p>
84<p class="firstline">Close httplib2 connections.</p>
85<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -070086 <code><a href="#create">create(parent, body=None, reservationId=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070087<p class="firstline">Creates a new reservation resource. Multiple reservations are created if the ancestor reservations do not exist.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -070088<p class="toc_element">
89 <code><a href="#createReservation">createReservation(parent, body=None, reservationId=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070090<p class="firstline">Creates a new reservation resource. Multiple reservations are created if the ancestor reservations do not exist.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -070091<p class="toc_element">
92 <code><a href="#delete">delete(name, force=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070093<p class="firstline">Deletes a reservation. Returns `google.rpc.Code.FAILED_PRECONDITION` in the following cases: 1. When reservation has child reservations. This check can be bypassed by setting DeleteReservationRequest.force flag to true. 2. When top-level reservation with slot pools is being deleted.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -070094<p class="toc_element">
95 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
96<p class="firstline">Returns information about the reservation.</p>
97<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070098 <code><a href="#list">list(parent, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</a></code></p>
Bu Sun Kim65020912020-05-20 12:08:20 -070099<p class="firstline">Lists all the reservations for the project in the specified location.</p>
100<p class="toc_element">
101 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
102<p class="firstline">Retrieves the next page of results.</p>
103<p class="toc_element">
104 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700105<p class="firstline">Updates an existing reservation resource. Applicable only for child reservations.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700106<h3>Method Details</h3>
107<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700108 <code class="details" id="close">close()</code>
109 <pre>Close httplib2 connections.</pre>
110</div>
111
112<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700113 <code class="details" id="create">create(parent, body=None, reservationId=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700114 <pre>Creates a new reservation resource. Multiple reservations are created if the ancestor reservations do not exist.
Bu Sun Kim65020912020-05-20 12:08:20 -0700115
116Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700117 parent: string, Project, location, and (optionally) reservation name. E.g., projects/myproject/locations/us-central1/reservations/parent (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700118 body: object, The request body.
119 The object takes the form of:
120
121{ # A reservation is a mechanism used to guarantee slots to users.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700122 &quot;useParentReservation&quot;: True or False, # If true, any query using this reservation will also be submitted to the parent reservation. This allows the query to share the additional slot capacity of the parent with other queries in the parent reservation. If the parent also has this field set to true, then this process will continue until it encounters a reservation for which this is false. If false, a query using this reservation will execute with the maximum slot capacity as specified above. If not specified, default value is true. Ignored for top-level reservation.
123 &quot;slotCapacity&quot;: &quot;A String&quot;, # Maximum slots available to this reservation and its children. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. In a scan of a multi-partitioned table, a single slot operates on a single partition of the table. If the new reservation&#x27;s slot capacity exceed the parent&#x27;s slot capacity or if total slot capacity of the new reservation and its siblings exceeds the parent&#x27;s slot capacity, the request will fail with `google.rpc.Code.RESOURCE_EXHAUSTED`.
124 &quot;name&quot;: &quot;A String&quot;, # The resource name of the reservation, e.g., &quot;projects/*/locations/*/reservations/dev/team/product&quot;. Reservation names (e.g., &quot;dev/team/product&quot;) exceeding a depth of six will fail with `google.rpc.Code.INVALID_ARGUMENT`.
125}
Bu Sun Kim65020912020-05-20 12:08:20 -0700126
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700127 reservationId: string, The reservation ID relative to the parent, e.g., &quot;dev&quot;. This field must only contain alphanumeric characters.
Bu Sun Kim65020912020-05-20 12:08:20 -0700128 x__xgafv: string, V1 error format.
129 Allowed values
130 1 - v1 error format
131 2 - v2 error format
132
133Returns:
134 An object of the form:
135
136 { # A reservation is a mechanism used to guarantee slots to users.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700137 &quot;useParentReservation&quot;: True or False, # If true, any query using this reservation will also be submitted to the parent reservation. This allows the query to share the additional slot capacity of the parent with other queries in the parent reservation. If the parent also has this field set to true, then this process will continue until it encounters a reservation for which this is false. If false, a query using this reservation will execute with the maximum slot capacity as specified above. If not specified, default value is true. Ignored for top-level reservation.
138 &quot;slotCapacity&quot;: &quot;A String&quot;, # Maximum slots available to this reservation and its children. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. In a scan of a multi-partitioned table, a single slot operates on a single partition of the table. If the new reservation&#x27;s slot capacity exceed the parent&#x27;s slot capacity or if total slot capacity of the new reservation and its siblings exceeds the parent&#x27;s slot capacity, the request will fail with `google.rpc.Code.RESOURCE_EXHAUSTED`.
139 &quot;name&quot;: &quot;A String&quot;, # The resource name of the reservation, e.g., &quot;projects/*/locations/*/reservations/dev/team/product&quot;. Reservation names (e.g., &quot;dev/team/product&quot;) exceeding a depth of six will fail with `google.rpc.Code.INVALID_ARGUMENT`.
140 }</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700141</div>
142
143<div class="method">
144 <code class="details" id="createReservation">createReservation(parent, body=None, reservationId=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700145 <pre>Creates a new reservation resource. Multiple reservations are created if the ancestor reservations do not exist.
Bu Sun Kim65020912020-05-20 12:08:20 -0700146
147Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700148 parent: string, Project, location, and (optionally) reservation name. E.g., projects/myproject/locations/us-central1/reservations/parent (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700149 body: object, The request body.
150 The object takes the form of:
151
152{ # A reservation is a mechanism used to guarantee slots to users.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700153 &quot;useParentReservation&quot;: True or False, # If true, any query using this reservation will also be submitted to the parent reservation. This allows the query to share the additional slot capacity of the parent with other queries in the parent reservation. If the parent also has this field set to true, then this process will continue until it encounters a reservation for which this is false. If false, a query using this reservation will execute with the maximum slot capacity as specified above. If not specified, default value is true. Ignored for top-level reservation.
154 &quot;slotCapacity&quot;: &quot;A String&quot;, # Maximum slots available to this reservation and its children. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. In a scan of a multi-partitioned table, a single slot operates on a single partition of the table. If the new reservation&#x27;s slot capacity exceed the parent&#x27;s slot capacity or if total slot capacity of the new reservation and its siblings exceeds the parent&#x27;s slot capacity, the request will fail with `google.rpc.Code.RESOURCE_EXHAUSTED`.
155 &quot;name&quot;: &quot;A String&quot;, # The resource name of the reservation, e.g., &quot;projects/*/locations/*/reservations/dev/team/product&quot;. Reservation names (e.g., &quot;dev/team/product&quot;) exceeding a depth of six will fail with `google.rpc.Code.INVALID_ARGUMENT`.
156}
Bu Sun Kim65020912020-05-20 12:08:20 -0700157
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700158 reservationId: string, The reservation ID relative to the parent, e.g., &quot;dev&quot;. This field must only contain alphanumeric characters.
Bu Sun Kim65020912020-05-20 12:08:20 -0700159 x__xgafv: string, V1 error format.
160 Allowed values
161 1 - v1 error format
162 2 - v2 error format
163
164Returns:
165 An object of the form:
166
167 { # A reservation is a mechanism used to guarantee slots to users.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700168 &quot;useParentReservation&quot;: True or False, # If true, any query using this reservation will also be submitted to the parent reservation. This allows the query to share the additional slot capacity of the parent with other queries in the parent reservation. If the parent also has this field set to true, then this process will continue until it encounters a reservation for which this is false. If false, a query using this reservation will execute with the maximum slot capacity as specified above. If not specified, default value is true. Ignored for top-level reservation.
169 &quot;slotCapacity&quot;: &quot;A String&quot;, # Maximum slots available to this reservation and its children. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. In a scan of a multi-partitioned table, a single slot operates on a single partition of the table. If the new reservation&#x27;s slot capacity exceed the parent&#x27;s slot capacity or if total slot capacity of the new reservation and its siblings exceeds the parent&#x27;s slot capacity, the request will fail with `google.rpc.Code.RESOURCE_EXHAUSTED`.
170 &quot;name&quot;: &quot;A String&quot;, # The resource name of the reservation, e.g., &quot;projects/*/locations/*/reservations/dev/team/product&quot;. Reservation names (e.g., &quot;dev/team/product&quot;) exceeding a depth of six will fail with `google.rpc.Code.INVALID_ARGUMENT`.
171 }</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700172</div>
173
174<div class="method">
175 <code class="details" id="delete">delete(name, force=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700176 <pre>Deletes a reservation. Returns `google.rpc.Code.FAILED_PRECONDITION` in the following cases: 1. When reservation has child reservations. This check can be bypassed by setting DeleteReservationRequest.force flag to true. 2. When top-level reservation with slot pools is being deleted.
Bu Sun Kim65020912020-05-20 12:08:20 -0700177
178Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700179 name: string, Resource name of the reservation to retrieve. E.g., projects/myproject/locations/us-central1/reservations/my_reservation (required)
180 force: boolean, If true, deletes all the child reservations of the given reservation. Otherwise, attempting to delete a reservation that has child reservations will fail with error code `google.rpc.Code.FAILED_PRECONDITION`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700181 x__xgafv: string, V1 error format.
182 Allowed values
183 1 - v1 error format
184 2 - v2 error format
185
186Returns:
187 An object of the form:
188
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700189 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700190 }</pre>
191</div>
192
193<div class="method">
194 <code class="details" id="get">get(name, x__xgafv=None)</code>
195 <pre>Returns information about the reservation.
196
197Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700198 name: string, Resource name of the reservation to retrieve. E.g., projects/myproject/locations/us-central1/reservations/path/to/reserv (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700199 x__xgafv: string, V1 error format.
200 Allowed values
201 1 - v1 error format
202 2 - v2 error format
203
204Returns:
205 An object of the form:
206
207 { # A reservation is a mechanism used to guarantee slots to users.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700208 &quot;useParentReservation&quot;: True or False, # If true, any query using this reservation will also be submitted to the parent reservation. This allows the query to share the additional slot capacity of the parent with other queries in the parent reservation. If the parent also has this field set to true, then this process will continue until it encounters a reservation for which this is false. If false, a query using this reservation will execute with the maximum slot capacity as specified above. If not specified, default value is true. Ignored for top-level reservation.
209 &quot;slotCapacity&quot;: &quot;A String&quot;, # Maximum slots available to this reservation and its children. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. In a scan of a multi-partitioned table, a single slot operates on a single partition of the table. If the new reservation&#x27;s slot capacity exceed the parent&#x27;s slot capacity or if total slot capacity of the new reservation and its siblings exceeds the parent&#x27;s slot capacity, the request will fail with `google.rpc.Code.RESOURCE_EXHAUSTED`.
210 &quot;name&quot;: &quot;A String&quot;, # The resource name of the reservation, e.g., &quot;projects/*/locations/*/reservations/dev/team/product&quot;. Reservation names (e.g., &quot;dev/team/product&quot;) exceeding a depth of six will fail with `google.rpc.Code.INVALID_ARGUMENT`.
211 }</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700212</div>
213
214<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700215 <code class="details" id="list">list(parent, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700216 <pre>Lists all the reservations for the project in the specified location.
217
218Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700219 parent: string, The parent resource name containing project and location, e.g.: &quot;projects/myproject/locations/us-central1&quot; (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700220 pageToken: string, The next_page_token value returned from a previous List request, if any.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700221 pageSize: integer, The maximum number of items to return.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700222 filter: string, Can be used to filter out reservations based on names, capacity, etc, e.g.: filter=&quot;reservation.slot_capacity &gt; 200&quot; filter=&quot;reservation.name = \&quot;*dev/*\&quot;&quot; Advanced filtering syntax can be [here](https://cloud.google.com/logging/docs/view/advanced-filters).
Bu Sun Kim65020912020-05-20 12:08:20 -0700223 x__xgafv: string, V1 error format.
224 Allowed values
225 1 - v1 error format
226 2 - v2 error format
227
228Returns:
229 An object of the form:
230
231 { # The response for ReservationService.ListReservations.
Bu Sun Kim65020912020-05-20 12:08:20 -0700232 &quot;reservations&quot;: [ # List of reservations visible to the user.
233 { # A reservation is a mechanism used to guarantee slots to users.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700234 &quot;useParentReservation&quot;: True or False, # If true, any query using this reservation will also be submitted to the parent reservation. This allows the query to share the additional slot capacity of the parent with other queries in the parent reservation. If the parent also has this field set to true, then this process will continue until it encounters a reservation for which this is false. If false, a query using this reservation will execute with the maximum slot capacity as specified above. If not specified, default value is true. Ignored for top-level reservation.
235 &quot;slotCapacity&quot;: &quot;A String&quot;, # Maximum slots available to this reservation and its children. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. In a scan of a multi-partitioned table, a single slot operates on a single partition of the table. If the new reservation&#x27;s slot capacity exceed the parent&#x27;s slot capacity or if total slot capacity of the new reservation and its siblings exceeds the parent&#x27;s slot capacity, the request will fail with `google.rpc.Code.RESOURCE_EXHAUSTED`.
236 &quot;name&quot;: &quot;A String&quot;, # The resource name of the reservation, e.g., &quot;projects/*/locations/*/reservations/dev/team/product&quot;. Reservation names (e.g., &quot;dev/team/product&quot;) exceeding a depth of six will fail with `google.rpc.Code.INVALID_ARGUMENT`.
237 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700238 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700239 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no more results in the list.
Bu Sun Kim65020912020-05-20 12:08:20 -0700240 }</pre>
241</div>
242
243<div class="method">
244 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
245 <pre>Retrieves the next page of results.
246
247Args:
248 previous_request: The request for the previous page. (required)
249 previous_response: The response from the request for the previous page. (required)
250
251Returns:
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<div class="method">
258 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700259 <pre>Updates an existing reservation resource. Applicable only for child reservations.
Bu Sun Kim65020912020-05-20 12:08:20 -0700260
261Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700262 name: string, The resource name of the reservation, e.g., &quot;projects/*/locations/*/reservations/dev/team/product&quot;. Reservation names (e.g., &quot;dev/team/product&quot;) exceeding a depth of six will fail with `google.rpc.Code.INVALID_ARGUMENT`. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700263 body: object, The request body.
264 The object takes the form of:
265
266{ # A reservation is a mechanism used to guarantee slots to users.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700267 &quot;useParentReservation&quot;: True or False, # If true, any query using this reservation will also be submitted to the parent reservation. This allows the query to share the additional slot capacity of the parent with other queries in the parent reservation. If the parent also has this field set to true, then this process will continue until it encounters a reservation for which this is false. If false, a query using this reservation will execute with the maximum slot capacity as specified above. If not specified, default value is true. Ignored for top-level reservation.
268 &quot;slotCapacity&quot;: &quot;A String&quot;, # Maximum slots available to this reservation and its children. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. In a scan of a multi-partitioned table, a single slot operates on a single partition of the table. If the new reservation&#x27;s slot capacity exceed the parent&#x27;s slot capacity or if total slot capacity of the new reservation and its siblings exceeds the parent&#x27;s slot capacity, the request will fail with `google.rpc.Code.RESOURCE_EXHAUSTED`.
269 &quot;name&quot;: &quot;A String&quot;, # The resource name of the reservation, e.g., &quot;projects/*/locations/*/reservations/dev/team/product&quot;. Reservation names (e.g., &quot;dev/team/product&quot;) exceeding a depth of six will fail with `google.rpc.Code.INVALID_ARGUMENT`.
270}
Bu Sun Kim65020912020-05-20 12:08:20 -0700271
272 updateMask: string, Standard field mask for the set of fields to be updated.
273 x__xgafv: string, V1 error format.
274 Allowed values
275 1 - v1 error format
276 2 - v2 error format
277
278Returns:
279 An object of the form:
280
281 { # A reservation is a mechanism used to guarantee slots to users.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700282 &quot;useParentReservation&quot;: True or False, # If true, any query using this reservation will also be submitted to the parent reservation. This allows the query to share the additional slot capacity of the parent with other queries in the parent reservation. If the parent also has this field set to true, then this process will continue until it encounters a reservation for which this is false. If false, a query using this reservation will execute with the maximum slot capacity as specified above. If not specified, default value is true. Ignored for top-level reservation.
283 &quot;slotCapacity&quot;: &quot;A String&quot;, # Maximum slots available to this reservation and its children. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. In a scan of a multi-partitioned table, a single slot operates on a single partition of the table. If the new reservation&#x27;s slot capacity exceed the parent&#x27;s slot capacity or if total slot capacity of the new reservation and its siblings exceeds the parent&#x27;s slot capacity, the request will fail with `google.rpc.Code.RESOURCE_EXHAUSTED`.
284 &quot;name&quot;: &quot;A String&quot;, # The resource name of the reservation, e.g., &quot;projects/*/locations/*/reservations/dev/team/product&quot;. Reservation names (e.g., &quot;dev/team/product&quot;) exceeding a depth of six will fail with `google.rpc.Code.INVALID_ARGUMENT`.
285 }</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700286</div>
287
288</body></html>